Package Exports
- reactstrap
- reactstrap/lib
- reactstrap/lib/utils
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (reactstrap) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
reactstrap
Easy to use React Bootstrap 4 components compatible with React 0.14.x and 15.x.
Installation
Add reactstrap
as a dependency via npm:
npm install reactstrap --save
Import the components you need, example:
import { Button, Popover, Tooltip } from 'reactstrap';
About the Project
This library contains React Bootstrap 4 components that favor composition and control. The library does not depend on jQuery or Bootstrap javascript. However, Tether is relied upon for advanced positioning of content like Tooltips, Popovers, and auto-flipping Dropdowns.
There are a few core concepts to understand in order to make the most out of this library.
Your content is expected to be composed via props.children rather than using named props to pass in Components.
// Content passed in via props const Example = (props) => { return ( <p>This is a tooltip <TooltipTrigger tooltip={TooltipContent}>example</TooltipTrigger>!</p> ); } // Content passed in as children (Preferred) const PreferredExample = (props) => { return ( <p> This is a <a href="#" id="TooltipExample">tooltip</a> example. <Tooltip target="TooltipExample"> <TooltipContent/> </Tooltip> </p> ); }
Attributes in this library are used to pass in state, conveniently apply modifier classes, enable advanced functionality (like tether), or automatically include non-content based elements.
Examples:
isOpen
- current state for items like dropdown, popover, tooltiptoggle
- callback for togglingisOpen
in the controlling componentcolor
- applies color classes, ex:<Button color="danger"/>
size
for controlling size classes. ex:<Button size="sm"/>
- boolean based props (attributes) when possible for alternative style classes or sr-only content
Documentation
This library contains the following components:
Development
Install dependencies:
npm install
Run examples at http://localhost:8080/ with webpack dev server:
npm start
Run tests & coverage report:
npm test
Watch tests:
npm run test-watch