reactstrap
Stateless React Components for Bootstrap 4.
Getting Started
Follow the create-react-app instructions to get started and then follow the reactstrap version of adding bootstrap.
tl;dr
npx create-react-app my-app
cd my-app/
npm start
or, if npx (Node >= 6 and npm >= 5.2 ) not available
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.
Adding Bootstrap
Install reactstrap and Bootstrap from NPM. Reactstrap does not include Bootstrap CSS so this needs to be installed as well:
npm i bootstrap
npm i reactstrap react react-dom
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.
Dependencies
Required Peer Dependencies
These libraries are not bundled with Reactstrap and required at runtime:
Optional Dependencies
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).
CDN
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/[email protected]/dist/reactstrap.min.js"></script>
<!-- All optional dependencies version -->
<script src="https://unpkg.com/[email protected]/dist/reactstrap.full.min.js"></script>
Note: To load a specific version of Reactstrap replace
6.0.1with the version number.
Versions
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
Example
<!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>
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, 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
Documentation search is powered by Algolia's DocSearch.
CodeSandbox Examples
Here are some ready-to-go examples for CodeSandbox that you can experiment with.
https://github.com/reactstrap/code-sandbox-examples
Contributing
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
Releasing
Create Release Branch
Note: you must have the GITHUB_TOKEN environment variable set to a valid GitHub token with write access to your repo.
To create a release branch and changelog, run the following command, optionally with a semantic release type (major, minor, patch) (if not provided, it will default to semver (it's best to let it default)):
./scripts/release <release-type>
Verify changelog in branch. Create a PR if everything looks good. Merge when tests are green.
Tagging and Publishing
Note: you must have write permission to this repo do perform this action
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. Travis will detect the new tag and publish to npm.
OR
You can create a new tag via the GitHub user interface. If you do it this way, make sure to use the correct version as the tag name (eg. 6.2.0).
In the wild
Organizations and projects using reactstrap
- availity-reactstrap-validation
- airframe-react - demo - Airframe provides all the components a developer needs to build data-intensive web apps using React.
- 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. - DevExtreme React Chart - A chart built on top of
reactstrapthat visualizes data using a variety of series types, including bar, line, area, scatter, pie, and more. - reactstrap-scrollspy - demo
- formstrap - demo - Let your
reactstrapinput component integrate seamlessly usingFormik
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!
14.8k Jan 4, 2023
94 Nov 30, 2022
6 Jun 5, 2022
491 Dec 25, 2022
1.4k Jan 4, 2023
9 Jun 30, 2022
6 Aug 12, 2022
11 Dec 31, 2022
69 Dec 27, 2022
30.5k Jan 4, 2023
11.1k Dec 28, 2022
2 Jan 5, 2022
18.2k Jan 8, 2023
75.8k Jan 4, 2023
24.5k Jan 7, 2023
12.2k Jan 1, 2023
9.4k Dec 24, 2022
10.1k Jan 3, 2023