Repository files navigation

Stateless React Components for Bootstrap 5.

If you're using Bootstrap 4, you'll need to useReactstrap v8

Follow thecreate-react-app instructions to get started and then follow the reactstrap version ofadding bootstrap.

npx create-react-app my-appcd my-app/npm start

or, if npx (Node >= 6 and npm >= 5.2 ) not available

npm install -g create-react-appcreate-react-app my-appcd my-app/npm start

Then openhttp://localhost:3000/ to see your app. The initial structure of your app is setup. Next, let'sadd reactstrap and bootstrap.

Install reactstrap and Bootstrap from NPM. Reactstrap does not include Bootstrap CSS so this needs to be installed as well:

npm i bootstrapnpm i reactstrap react react-dom

Import Bootstrap CSS in thesrc/index.js file:

import'bootstrap/dist/css/bootstrap.css';

Import required reactstrap components withinsrc/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 rendermethod. Here is an exampleApp.js redoneusing reactstrap.

These libraries are not bundled with Reactstrap and required at runtime:

• react
• react-dom

This library contains React Bootstrap components that favor composition and control. The library does not depend on jQuery or Bootstrap javascript. However,Poppers.js viareact-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.

   // Content passed in via propsconstExample=(props)=>{return(<p>This is a tooltip<TooltipTriggertooltip={TooltipContent}>example</TooltipTrigger>!</p>);}// Content passed in as children (Preferred)constPreferredExample=(props)=>{return(<p>      This is a<ahref="#"id="TooltipExample">tooltip</a> example.<Tooltiptarget="TooltipExample"><TooltipContent/></Tooltip></p>);}

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 togglingisOpen in the controlling component
   • color - 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 orvisually-hidden content

https://reactstrap.github.io

Documentation search is powered byAlgolia's DocSearch.

Here are some ready-to-go examples forCodeSandbox that you can experiment with.

https://github.com/reactstrap/code-sandbox-examples

Install dependencies:

yarn install

Run examples athttp://localhost:8080/ with webpack dev server:

yarn start

Run tests & coverage report:

yarn cover

Watch tests:

yarntest

Release branches/versioning/notes will be automatically created and maintained by therelease-please github action. When you're ready to publish the release, just merge the release branch. The release will be created, the new package will be published, and the updated docs will be deployed tohttps://reactstrap.github.io/.

Organizations and projects usingreactstrap

• 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 ofreactstrap with paging, sorting, filtering, grouping, selection, editing and virtual scrolling features.
• DevExtreme React Chart - A chart built on top ofreactstrap that visualizes data using a variety of series types, including bar, line, area, scatter, pie, and more.
• reactstrap-scrollspy -demo
• formstrap -demo - Let yourreactstrap input component integrate seamlessly usingFormik
• Jimu UI -demo - The UI library forArcGIS Experience Builder mapping platform.

Submit a PR to add to this list!

Looking to build, document and publish reusable components built on top ofreactstrap? Consider forkinghttps://github.com/reactstrap/component-template to kickstart your project!