1/11/25, 11:23 PM Introduction | React Bootstrap

React Bootstrap

Getting started Introduction

Introduction
Learn how to include React Bootstrap in your project.

Build your website for just

$3.88/mth. More value and
performance with Namecheap.

ADS VIA CARBON

Installation
The best way to consume React-Bootstrap is via the npm package which
you can install with npm (or yarn if you prefer).

If you plan on customizing the Bootstrap Sass files, or don't want to use
a CDN for the stylesheet, it may be helpful to install vanilla Bootstrap as
well.

npm install react-bootstrap bootstrap

Importing Components
You should import individual components like: react-bootstrap/Button
rather than the entire library. Doing so pulls in only the specific
components that you use, which can significantly reduce the amount of
code you end up sending to the client.

import Button from 'react-bootstrap/Button';

// or less ideally
import { Button } from 'react-bootstrap';

Browser globals
https://react-bootstrap.netlify.app/docs/getting-started/introduction 1/6
1/11/25, 11:23 PM Introduction | React Bootstrap

We provide react-bootstrap.js and react-bootstrap.min.js bundles

with all components exported on the window.ReactBootstrap object.
These bundles are available on jsDelivr, as well as in the npm package.

<script
src="https://cdn.jsdelivr.net/npm/react/umd/react.production.min.
crossorigin></script>

<script
src="https://cdn.jsdelivr.net/npm/react-dom/umd/react-
dom.production.min.js"
crossorigin></script>

<script
src="https://cdn.jsdelivr.net/npm/react-bootstrap@next/dist/rea
bootstrap.min.js"
crossorigin></script>

<script>var Alert = ReactBootstrap.Alert;</script>

Examples
React-Bootstrap has started a repo with a few basic CodeSandbox
examples. Click here to check them out.

Stylesheets
Because React-Bootstrap doesn't depend on a very precise version of
Bootstrap, we don't ship with any included CSS. However, some
stylesheet is required to use these components.

CSS

{
/* The following line can be included in your src/index.js
or App.js file */
}
import 'bootstrap/dist/css/bootstrap.min.css';

How and which Bootstrap styles you include is up to you, but the
simplest way is to include the latest styles from the CDN. A little more

https://react-bootstrap.netlify.app/docs/getting-started/introduction 2/6
1/11/25, 11:23 PM Introduction | React Bootstrap

information about the benefits of using a CDN can be found here.

<link
rel="stylesheet"

href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/boots
integrity="sha384-
QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH"
crossorigin="anonymous"
/>

Sass
In case you are using Sass the simplest way is to include the Bootstrap’s
source Sass files in your main Sass file and then require it on your
src/index.js or App.js file. This applies to a typical create-react-app
application in other use cases you might have to setup the bundler of
your choice to compile Sass/SCSS stylesheets to CSS.

/* The following line can be included in a src/App.scss */

@import '~bootstrap/scss/bootstrap';

/* The following line can be included in your src/index.js or

App.js file */
import './App.scss';

Customize Bootstrap
If you wish to customize the Bootstrap theme or any Bootstrap variables
you can create a custom Sass file:

/* The following block can be included in a custom.scss */

/* make the customizations */

$theme-colors: (
'info': tomato,
'danger': teal
);

/* import bootstrap to set changes */

@import '~bootstrap/scss/bootstrap';

https://react-bootstrap.netlify.app/docs/getting-started/introduction 3/6
1/11/25, 11:23 PM Introduction | React Bootstrap

... And import it on the main Sass file.

/* The following line can be included in a src/App.scss */

@import 'custom';

Advanced usage
See the Bootstrap docs for more advanced use cases and details about
customizing stylesheets.

as Prop API
With certain React-Bootstrap components, you may want to modify the
component or HTML tag that is rendered.

If you want to keep all the styling of a particular React-Bootstrap

component but switch the component that is finally rendered (whether
it's a different React-Bootstrap component, a different custom
component, or a different HTML tag) you can use the as prop to do so.

The example below passes an anchor to the as prop in a Button

component. This ultimately causes a a tag to be rendered but with the
same styles as a Button component.

RESULT

Button as link Button as link

LIVE EDITOR

<Stack direction="horizontal" gap={2}>

<Button as="a" variant="primary">
Button as link
</Button>
<Button as="a" variant="success">
Button as link
</Button>
</Stack>;

Below is an illustration of passing a React Bootstrap component. It

contains a Badge component and a Button component that have been
https://react-bootstrap.netlify.app/docs/getting-started/introduction 4/6
1/11/25, 11:23 PM Introduction | React Bootstrap

supplied to the as prop. This finally results in the rendering of a Button

component with the same styles as a Badge component.

RESULT

Example heading New

LIVE EDITOR

import Badge from 'react-bootstrap/Badge';

import Button from 'react-bootstrap/Button';

function Example() {
return (
<div>
<h1>
Example heading
<Badge bg="secondary" as={Button}>
New
</Badge>
</h1>
</div>
);
}

export default Example;

Themes
React-Bootstrap is compatible with existing Bootstrap themes. Just
follow the installation instructions for your theme of choice.

Watch out!
Because React-Bootstrap completely reimplements Bootstrap's
JavaScript, it's not automatically compatible with themes that
extend the default JavaScript behaviors.

Create React App

https://react-bootstrap.netlify.app/docs/getting-started/introduction 5/6
1/11/25, 11:23 PM Introduction | React Bootstrap

If you would like to add a custom theme on your app using Create
React App, they have additional documentation for Create React
App and Bootstrap here

Browser support
We aim to support all browsers supported by both React and Bootstrap.

https://react-bootstrap.netlify.app/docs/getting-started/introduction 6/6