@brighthr/component-button
TypeScript icon, indicating that this package has built-in type declarations

3.0.1 • Public • Published

Button

To install, type the following into the command line at the root of your project:

npm i @brighthr/component-button

To implement the Button component into your project you’ll need to add the import:

import Button from '@brighthr/component-button';

After adding import into your project you can use it simply like:

<Button />

Props

Name Type Default Description
color 'primary' 'accent' 'error' 'white' 'accent' Sets the color of the button.
fullWidth boolean false Sets the button width to 100%.
iconName string Sets the icon to display, uses calendar-dates if left empty.
iconPosition 'left' 'right' Sets the position of the icon, if left empty the icon will not show.
isLoading boolean false If true, the loading spinner will show.
outlineButton boolean false If true, the button will have a white background.
size 'xs' 'sm' 'base' 'lg' 'xl' 'base' Sets the size of the button.
text string Sets the button text.
textButton boolean false If true, gives the button a text appearance.

Readme

Keywords

none

Package Sidebar

Install

npm i @brighthr/component-button

Weekly Downloads

2,441

Version

3.0.1

License

MIT

Unpacked Size

29.2 kB

Total Files

8

Last publish

Collaborators

  • bright.hr