@getfly-ui/button
v0.0.11
Published
Button for getfly UI
Maintainers
Readme
Button component
How to use
import { Button } from '@getfly-ui/button';OR
import { Button } from 'getfly-ui';Props
Button.Primary
| Prop | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| disabled | boolean or undefined | | disable button |
| className | string or undefined | | @description Text label |
| onClick | MouseEventHandler<HTMLButtonElement> or ((event: MouseEvent<HTMLButtonElement, MouseEvent>) => void) or undefined | | @description Event onClick |
| useMergeClass | boolean or undefined | true | @description merge className |
| buttonType | enum | "primary" | |
| buttonPreset | enum | "large" | |
| text | string or undefined | | |
| textPreset | enum | | |
| textColorTheme | enum | | |
| textColor | string or undefined | | |
| iconLeft | enum | | |
| iconLeftColorTheme | enum | | |
| iconLeftColor | string or undefined | | |
| iconLeftSize | number or undefined | | |
| iconRight | enum | | |
| iconRightColorTheme | enum | | |
| iconRightColor | string or undefined | | |
| iconRightSize | number or undefined | | |
| buttonColorTheme | enum | | |
| buttonColor | string or undefined | | |
| buttonColorHover | string or undefined | | |
| buttonColorHoverTheme | enum | | |
| buttonColorActive | string or undefined | | |
| buttonColorActiveTheme | enum | | |
Button.Outline
| Prop | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| disabled | boolean or undefined | | disable button |
| className | string or undefined | | @description Text label |
| onClick | MouseEventHandler<HTMLButtonElement> or ((event: MouseEvent<HTMLButtonElement, MouseEvent>) => void) or undefined | | @description Event onClick |
| useMergeClass | boolean or undefined | true | @description merge className |
| buttonType | enum | "primary" | |
| buttonPreset | enum | "large" | |
| text | string or undefined | | |
| textPreset | enum | | |
| textColorTheme | enum | | |
| textColor | string or undefined | | |
| iconLeft | enum | | |
| iconLeftColorTheme | enum | | |
| iconLeftColor | string or undefined | | |
| iconLeftSize | number or undefined | | |
| iconRight | enum | | |
| iconRightColorTheme | enum | | |
| iconRightColor | string or undefined | | |
| iconRightSize | number or undefined | | |
| buttonColorTheme | enum | | |
| buttonColor | string or undefined | | |
| buttonColorHover | string or undefined | | |
| buttonColorHoverTheme | enum | | |
| buttonColorActive | string or undefined | | |
| buttonColorActiveTheme | enum | | |
| borderWidth | number or undefined | | |
| borderColorTheme | enum | | |
| borderColor | string or undefined | | |
| borderStyle | enum | | |
Button.Link
| Prop | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| disabled | boolean or undefined | | disable button |
| className | string or undefined | | @description Text label |
| useMergeClass | boolean or undefined | true | @description merge className |
| buttonType | enum | "primary" | |
| buttonPreset | enum | "large" | |
| text | string or undefined | | |
| textPreset | enum | | |
| textColorTheme | enum | | |
| textColor | string or undefined | | |
| iconLeft | enum | | |
| iconLeftColorTheme | enum | | |
| iconLeftColor | string or undefined | | |
| iconLeftSize | number or undefined | | |
| iconRight | enum | | |
| iconRightColorTheme | enum | | |
| iconRightColor | string or undefined | | |
| iconRightSize | number or undefined | | |
| buttonColorTheme | enum | | |
| buttonColor | string or undefined | | |
| buttonColorHover | string or undefined | | |
| buttonColorHoverTheme | enum | | |
| buttonColorActive | string or undefined | | |
| buttonColorActiveTheme | enum | | |
| onClick | ((event: MouseEvent<HTMLAnchorElement, MouseEvent>) => void) or undefined | | @description Event onClick |
| href | string or undefined | | |
Button.Icon
| Prop | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| disabled | boolean or undefined | | disable button |
| className | string or undefined | | @description Text label |
| onClick | MouseEventHandler<HTMLButtonElement> or ((event: MouseEvent<HTMLButtonElement, MouseEvent>) => void) or undefined | | @description Event onClick |
| useMergeClass | boolean or undefined | true | @description merge className |
| buttonType | enum | "primary" | |
| buttonPreset | enum | "large" | |
| icon | enum | | |
| iconSize | number or undefined | | |
| iconColorTheme | enum | | |
| iconColor | string or undefined | | |
