Skip to content

Button

The Button component is a fundamental interactive component used to trigger actions. Onionl UI provides buttons in various sizes and types to meet different scenario needs.

Basic Usage

Button styles can be defined through the size and type properties.

Size

Buttons come in 7 preset sizes: xs, sm, md, lg, xl, 2xl, 3xl. The default size is md.

Type

There are three types of buttons: primary, secondary, and outline. The default type is primary.

Buttons can be used as links. Use the to property to specify the link address, or use the link property to style the button as a link.

Disabled State

Buttons can be set to a disabled state using the disabled property.

Icon Button

Buttons can contain only icons. Use the icon property to set an icon, supporting all Material Icons.

TIP

To use icons, you need to install the Mono Icons icon set first

Customization

Besides preset sizes, you can pass in numbers to customize button sizes. The default range is 1-20, which can be modified by setting the range field in the component preset.

JavaScript
    onionlUIPreset({ range: 25 }),

Properties

PropertyDescriptionTypeDefault
sizeButton size, can be sm, md, lg or a numberstring | numbermd
linkWhether to use link stylebooleanfalse
toRoute target, supports vue-router's to propertystring | RouteLocationRaw-
iconIcon name, supports Material Iconsstring-
disabledWhether the button is disabledbooleanfalse