Stateless React Components for Bootstrap 4.
Follow the create-react-app instructions up to the Adding Bootstrap
section and instead follow the reactstrap version of adding bootstrap.
npm install -g create-react-app
create-react-app my-app
cd my-app/
npm start
Then open http://localhost:3000/ to see your app. The initial structure of your app is setup. Next, let's add reactstrap and bootstrap.
Install reactstrap and Bootstrap from NPM. Reactstrap does not include Bootstrap CSS so this needs to be installed as well:
npm install --save [email protected]
npm install --save reactstrap react-transition-group@^1.1.2 react@^15.3.0 react-dom@^15.3.0
Import Bootstrap CSS in the src/index.js
file:
import 'bootstrap/dist/css/bootstrap.css';
Import required reactstrap components within src/App.js
file or your custom component files:
import { Button } from 'reactstrap';
Now you are ready to use the imported reactstrap components within your component hierarchy defined in the render method. Here is an example App.js
redone using reactstrap.
Reactstrap can be included directly in your application's bundle or excluded during compilation and linked directly to a CDN.
https://cdnjs.cloudflare.com/ajax/libs/reactstrap/4.8.0/reactstrap.min.js
Note: When using the external CDN library, be sure to include the required dependencies as necessary prior to the Reactstrap library:
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"/>
tag
- customize component output by passing in an element name or Component- boolean based props (attributes) when possible for alternative style classes or
sr-only
content
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
To create a release branch and changelog, run the following command with a semantic release type (major, minor, patch):
./scripts/release <release-type>
Verify changelog in branch. Create a PR if everything looks good. Merge when tests are green.
Once the release branch is merged, checkout master and run:
./scripts/publish
This will build the current state of master, tag it based on the release version and push the tag up to GitHub. If that all looks good, the final command to run is:
npm publish
Organizations and projects using reactstrap
- availity-reactstrap-validation
- component-template
- video-react
- CoreUI-Free-Bootstrap-Admin-Template - demo
Submit a PR to add to this list!
Looking to build, document and publish reusable components built on top of reactstrap
? Consider forking https://github.com/reactstrap/component-template to kickstart your project!