React Bootstrap 4 components
npm install reactstrap-v15
    
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:
`js`
import 'bootstrap/dist/css/bootstrap.css';
Import required reactstrap components within `src/App.js` file or your custom component files:
`js`
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.
##### 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).
* react-transition-group
* react-popper
If you prefer to include Reactstrap globally by marking reactstrap as external in your application, thereactstrap library provides various single-file distributions, which are hosted on the following CDNs:
* cdnjs
`html
`
* unpkg
`html
`
> Note: To load a specific version of Reactstrap replace 6.0.1 with the version number.
#### Versions
Reactstrap has two primary distribution versions:
1) reactstrap.min.js
This file excludes the optional dependencies – react-popper and react-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-popper or react-transition-group – Reactstrap and your application
will use the single global version included
2) reactstrap.full.min.js
This file includes the optional dependencies – react-popper and react-transition-group
Recommended use cases:
* Small applications
#### Example
`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.
1. Your content is expected to be composed via props.children rather than using named props to pass in Components.
` This is a tooltip js
// Content passed in via props
const Example = (props) => {
return (
);
}
// Content passed in as children (Preferred)
const PreferredExample = (props) => {
return (
This is a tooltip example.
2. 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, tooltip
- toggle - callback for toggling isOpen in the controlling component
- color - applies color classes, ex:
- size - for controlling size classes. ex:
- 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
Documentation
https://reactstrap.github.io
Documentation search is powered by Algolia's DocSearch.
Contributing
Development
Install dependencies:
`sh
npm install
`Run examples at http://localhost:8080/ with webpack dev server:
`sh
npm start
`Run tests & coverage report:
`sh
npm test
`Watch tests:
`sh
npm run test-watch
`Releasing
#### Create Release Branch
To create a release branch and changelog, run the following command with a semantic release type (major, minor, patch):
`
./scripts/release
`Verify changelog in branch. Create a PR if everything looks good. Merge when tests are green.
#### Tagging and Publishing
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
`In the wild
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
reactstrap with 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!