Skip to content
On this page

KButton

Commonly used button.

Install

bash
pnpm add @ikun-ui/button
pnpm add @ikun-ui/button
bash
yarn add @ikun-ui/button
yarn add @ikun-ui/button
bash
npm install @ikun-ui/button
npm install @ikun-ui/button

Basic usage

Use type, round and circle to define Button's style.

Disabled Button

Use disabled attribute to determine whether a button is disabled.
It accepts a Boolean value.

Icon Button

Use the icon attribute to add icon.

Button Props

NameTypeDefaultDescription
iconstring-The class name of the icon, following the unocss standard
circlebooleanfalseDetermine whether it's a circle button
roundstring-Button's border radius
disabledbooleanfalseDisable the button
typeenum'success' / 'error' / 'warning' / 'info'/ 'primary'Button type
clsstring-Additional class for
attrsany{}Additional attributes

Button Events

NameDescriptionType
clickEvent fired when the button is clicked(e: Event)=> void

Button Slots

NameDescription
defaultCustomize default content

MIT Licensed