1.0.0 • Published 5 years ago

react-bootstrap-buttons v1.0.0

Weekly downloads
179
License
MIT
Repository
github
Last release
5 years ago

react-bootstrap-buttons build status Coverage Status

NPM

React Bootstrap buttons.

Demo: https://cheton.github.io/react-bootstrap-buttons

Installation

  1. Install react-bootstrap-buttons:

    npm install --save react-bootstrap-buttons
  2. Import react-bootstrap-buttons and its styles in your application as follows:

    import { Button, ButtonGroup, ButtonToolbar } from 'react-bootstrap-buttons';
    
    // Be sure to include styles at some point, probably during your bootstraping
    import 'react-bootstrap-buttons/dist/react-bootstrap-buttons.css';

Recommended Setup

Create a Buttons component inside your common components directory:

components/
  Buttons/
    index.js

components/Buttons/index.js

import 'react-bootstrap-buttons/dist/react-bootstrap-buttons.css';

export { Button, ButtonGroup, ButtonToolbar } from 'react-bootstrap-buttons';

Then, import Button component in your code:

import { Button } from 'app/components/Buttons';

Examples

Examples for each component can be seen in the documentation.

Here are some online demos of each component:

API

Properties

Button

NameTypeDefaultDescription
tagFunction or String'button'Pass in a component to override default button element.
typeOne of:'button''reset''submit''button'Specifies the type of button.
lgBooleanLarge button.
mdBooleanMedium button.
smBooleanSmall button.
xsBooleanExtra small button.
btnStyleOne of:'default''primary''secondary''danger''warning''info''success''light''dark''link''default'Component visual or contextual style variants.
outlineBooleanfalseSpecifies whether to remove background image and color on a button.
blockBooleanfalseSpecifies whether to span the full width of a parent.
activeBooleanfalseSpecifies whether to add active effect to a button.
hoverBooleanfalseSpecifies whether to add hover effect to a button.
focusBooleanflaseSpecifies whether to add focus effect to a button.
disabledBooleanflaseSpecifies whether a button should be disabled or not.

ButtonGroup

NameTypeDefaultDescription
lgBooleanLarge button group.
mdBooleanMedium button group.
smBooleanSmall button group.
xsBooleanExtra small button group.
btnStyleOne of:'default''primary''secondary''danger''warning''info''success''light''dark''link'Component visual or contextual style variants.
verticalBooleanfalseSpecifies whether a button group should be aligned vertically or not.

ButtonToolbar

NameTypeDefaultDescription

License

MIT