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 bootstrap@4.1.1
npm install --save reactstrap react@^16.3.2 react-dom@^16.3.2
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.
These libraries are not bundled with Reactstrap and required at runtime:
These libraries are not included in the main distribution file reactstrap.min.js and need to be manually
included when using components that require transitions or popover effects (e.g. Tooltip, Modal, etc).
If you prefer to include Reactstrap globally by marking reactstrap as external in your application, the
reactstrap library provides various single-file distributions, which are hosted on the following CDNs:
<!-- Main version -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/reactstrap/6.0.1/reactstrap.min.js"></script>
<!-- All optional dependencies version -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/reactstrap/6.0.1/reactstrap.full.min.js"></script><!-- Main version -->
<script src="https://unpkg.com/reactstrap@6.0.1/dist/reactstrap.min.js"></script>
<!-- All optional dependencies version -->
<script src="https://unpkg.com/reactstrap@6.0.1/dist/reactstrap.full.min.js"></script>Note: To load a specific version of Reactstrap replace
6.0.1with the version number.
Reactstrap has two primary distribution versions:
-
reactstrap.min.jsThis file excludes the optional dependencies –
react-popperandreact-transition-group. This is the recommended approach (similar approach in Bootstrap's JavaScript components) for including Reactstrap as it reduces the filesize and gives more flexibility in configuring needed dependencies.Recommended use cases:
- Small, medium, or large applications
- Applications that do not use any transitions or popper components
- Applications that directly use
react-popperorreact-transition-group– Reactstrap and your application will use the single global version included
-
reactstrap.full.min.jsThis file includes the optional dependencies –
react-popperandreact-transition-groupRecommended use cases:
- Small applications
<!doctype html>
<html lang="en">
<head>
<!-- Required dependencies -->
<script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/prop-types/15.6.1/prop-types.min.js"></script>
<script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/react/16.3.2/umd/react.production.min.js"></script>
<script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/react-dom/16.3.2/umd/react-dom.production.min.js"></script>
<!-- Optional dependencies -->
<script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/react-transition-group/2.2.1/react-transition-group.min.js"></script>
<script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.3/umd/popper.min.js"></script>
<script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/react-popper/0.10.4/umd/react-popper.min.js"></script>
<!-- Reactstrap -->
<script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/reactstrap/6.0.1/reactstrap.min.js"></script>
<!-- Lastly, include your app's bundle -->
<script type="text/javascript" src="/assets/bundle.js"></script>
</head>
<body>
<div id="my-app" />
</body>
</html>This library contains React Bootstrap 4 components that favor composition and control. The library does not depend on jQuery or Bootstrap javascript. However, Poppers.js via react-popper 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 togglingisOpenin 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-onlycontent
Documentation search is powered by Algolia's DocSearch.
Install dependencies:
npm installRun examples at http://localhost:8080/ with webpack dev server:
npm startRun tests & coverage report:
npm testWatch tests:
npm run test-watchTo 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
- Admin dashboard example app built with reactstrap - demo
- DevExtreme React Grid - It's a stateless data grid built on top of
reactstrapwith paging, sorting, filtering, grouping, selection, editing and virtual scrolling features.
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!