introduction.md 9.32 KB
Newer Older
1
---
Mark Otto's avatar
Mark Otto committed
2
layout: docs
3
title: Introduction
4
description: Get started with Bootstrap, the world's most popular framework for building responsive, mobile-first sites, with jsDelivr and a template starter page.
5
group: getting-started
XhmikosR's avatar
XhmikosR committed
6
aliases:
XhmikosR's avatar
XhmikosR committed
7
  - "/docs/4.6/getting-started/"
XhmikosR's avatar
XhmikosR committed
8
9
  - "/docs/getting-started/"
  - "/getting-started/"
10
toc: true
11
12
13
14
---

## Quick start

XhmikosR's avatar
XhmikosR committed
15
Looking to quickly add Bootstrap to your project? Use jsDelivr, a free open source CDN. Using a package manager or need to download the source files? [Head to the downloads page]({{< docsref "/getting-started/download" >}}).
16

17
18
### CSS

19
20
Copy-paste the stylesheet `<link>` into your `<head>` before all other stylesheets to load our CSS.

XhmikosR's avatar
XhmikosR committed
21
22
23
```html
<link rel="stylesheet" href="{{< param "cdn.css" >}}" integrity="{{< param "cdn.css_hash" >}}" crossorigin="anonymous">
```
24

25
26
### JS

XhmikosR's avatar
XhmikosR committed
27
Many of our components require the use of JavaScript to function. Specifically, they require [jQuery](https://jquery.com/), [Popper](https://popper.js.org/), and our own JavaScript plugins. We use [jQuery's slim build](https://blog.jquery.com/2016/06/09/jquery-3-0-final-released/), but the full version is also supported.
28

XhmikosR's avatar
XhmikosR committed
29
Place **one of the following `<script>`s** near the end of your pages, right before the closing `</body>` tag, to enable them. jQuery must come first, then Popper, and then our JavaScript plugins.
Mark Otto's avatar
Mark Otto committed
30
31
32

#### Bundle

XhmikosR's avatar
XhmikosR committed
33
Include every Bootstrap JavaScript plugin with one of our two bundles. Both `bootstrap.bundle.js` and `bootstrap.bundle.min.js` include [Popper](https://popper.js.org/) for our tooltips and popovers, but not [jQuery](https://jquery.com/). Include jQuery first, then a Bootstrap JavaScript bundle. For more information about what's included in Bootstrap, please see our [contents]({{< docsref "/getting-started/contents#precompiled-bootstrap" >}}) section.
Mark Otto's avatar
Mark Otto committed
34

XhmikosR's avatar
XhmikosR committed
35
36
37
38
```html
<script src="{{< param "cdn.jquery" >}}" integrity="{{< param "cdn.jquery_hash" >}}" crossorigin="anonymous"></script>
<script src="{{< param "cdn.js_bundle" >}}" integrity="{{< param "cdn.js_bundle_hash" >}}" crossorigin="anonymous"></script>
```
Mark Otto's avatar
Mark Otto committed
39
40
41

#### Separate

XhmikosR's avatar
XhmikosR committed
42
If you decide to go with the separate scripts solution, Popper must come first (if you're using tooltips or popovers), and then our JavaScript plugins.
43

XhmikosR's avatar
XhmikosR committed
44
45
46
47
48
```html
<script src="{{< param "cdn.jquery" >}}" integrity="{{< param "cdn.jquery_hash" >}}" crossorigin="anonymous"></script>
<script src="{{< param "cdn.popper" >}}" integrity="{{< param "cdn.popper_hash" >}}" crossorigin="anonymous"></script>
<script src="{{< param "cdn.js" >}}" integrity="{{< param "cdn.js_hash" >}}" crossorigin="anonymous"></script>
```
49

Mark Otto's avatar
Mark Otto committed
50
#### Components
51

XhmikosR's avatar
XhmikosR committed
52
Curious which components explicitly require jQuery, our JavaScript, and Popper? Click the show components link below. If you're unsure about the page structure, keep reading for an example page template.
53

54
55
<details>
<summary class="text-primary mb-3">Show components requiring JavaScript</summary>
XhmikosR's avatar
XhmikosR committed
56
{{< markdown >}}
57
58
59
60
- Alerts for dismissing
- Buttons for toggling states and checkbox/radio functionality
- Carousel for all slide behaviors, controls, and indicators
- Collapse for toggling visibility of content
XhmikosR's avatar
XhmikosR committed
61
- Dropdowns for displaying and positioning (also requires [Popper](https://popper.js.org/))
62
63
- Modals for displaying, positioning, and scroll behavior
- Navbar for extending our Collapse plugin to implement responsive behavior
XhmikosR's avatar
XhmikosR committed
64
- Tooltips and popovers for displaying and positioning (also requires [Popper](https://popper.js.org/))
65
- Scrollspy for scroll behavior and navigation updates
XhmikosR's avatar
XhmikosR committed
66
{{< /markdown >}}
67
</details>
68
69
70

## Starter template

71
Be sure to have your pages set up with the latest design and development standards. That means using an HTML5 doctype and including a viewport meta tag for proper responsive behaviors. Put it all together and your pages should look like this:
72

XhmikosR's avatar
XhmikosR committed
73
```html
74
<!doctype html>
75
76
<html lang="en">
  <head>
77
    <!-- Required meta tags -->
78
    <meta charset="utf-8">
79
    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
80
81

    <!-- Bootstrap CSS -->
XhmikosR's avatar
XhmikosR committed
82
    <link rel="stylesheet" href="{{< param "cdn.css" >}}" integrity="{{< param "cdn.css_hash" >}}" crossorigin="anonymous">
83
84

    <title>Hello, world!</title>
85
86
87
88
  </head>
  <body>
    <h1>Hello, world!</h1>

Mark Otto's avatar
Mark Otto committed
89
90
91
    <!-- Optional JavaScript; choose one of the two! -->

    <!-- Option 1: jQuery and Bootstrap Bundle (includes Popper) -->
XhmikosR's avatar
XhmikosR committed
92
93
    <script src="{{< param "cdn.jquery" >}}" integrity="{{< param "cdn.jquery_hash" >}}" crossorigin="anonymous"></script>
    <script src="{{< param "cdn.js_bundle" >}}" integrity="{{< param "cdn.js_bundle_hash" >}}" crossorigin="anonymous"></script>
Mark Otto's avatar
Mark Otto committed
94

95
96
    <!-- Option 2: Separate Popper and Bootstrap JS -->
    <!--
XhmikosR's avatar
XhmikosR committed
97
98
99
    <script src="{{< param "cdn.jquery" >}}" integrity="{{< param "cdn.jquery_hash" >}}" crossorigin="anonymous"></script>
    <script src="{{< param "cdn.popper" >}}" integrity="{{< param "cdn.popper_hash" >}}" crossorigin="anonymous"></script>
    <script src="{{< param "cdn.js" >}}" integrity="{{< param "cdn.js_hash" >}}" crossorigin="anonymous"></script>
Mark Otto's avatar
Mark Otto committed
100
    -->
101
102
  </body>
</html>
XhmikosR's avatar
XhmikosR committed
103
```
104

XhmikosR's avatar
XhmikosR committed
105
That's all you need for overall page requirements. Visit the [Layout docs]({{< docsref "/layout/overview" >}}) or [our official examples]({{< docsref "/examples" >}}) to start laying out your site's content and components.
Mark Otto's avatar
Mark Otto committed
106
107
108
109
110
111
112
113
114

## Important globals

Bootstrap employs a handful of important global styles and settings that you'll need to be aware of when using it, all of which are almost exclusively geared towards the *normalization* of cross browser styles. Let's dive in.

### HTML5 doctype

Bootstrap requires the use of the HTML5 doctype. Without it, you'll see some funky incomplete styling, but including it shouldn't cause any considerable hiccups.

XhmikosR's avatar
XhmikosR committed
115
```html
116
<!doctype html>
Mark Otto's avatar
Mark Otto committed
117
118
119
<html lang="en">
  ...
</html>
XhmikosR's avatar
XhmikosR committed
120
```
Mark Otto's avatar
Mark Otto committed
121
122
123
124
125

### Responsive meta tag

Bootstrap is developed *mobile first*, a strategy in which we optimize code for mobile devices first and then scale up components as necessary using CSS media queries. To ensure proper rendering and touch zooming for all devices, **add the responsive viewport meta tag** to your `<head>`.

XhmikosR's avatar
XhmikosR committed
126
```html
127
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
XhmikosR's avatar
XhmikosR committed
128
```
Mark Otto's avatar
Mark Otto committed
129

130
You can see an example of this in action in the [starter template](#starter-template).
Mark Otto's avatar
Mark Otto committed
131
132
133

### Box-sizing

134
For more straightforward sizing in CSS, we switch the global `box-sizing` value from `content-box` to `border-box`. This ensures `padding` does not affect the final computed width of an element, but it can cause problems with some third party software like Google Maps and Google Custom Search Engine.
Mark Otto's avatar
Mark Otto committed
135
136
137

On the rare occasion you need to override it, use something like the following:

XhmikosR's avatar
XhmikosR committed
138
```css
Mark Otto's avatar
Mark Otto committed
139
.selector-for-some-widget {
140
  box-sizing: content-box;
Mark Otto's avatar
Mark Otto committed
141
}
XhmikosR's avatar
XhmikosR committed
142
```
Mark Otto's avatar
Mark Otto committed
143

144
With the above snippet, nested elements—including generated content via `::before` and `::after`—will all inherit the specified `box-sizing` for that `.selector-for-some-widget`.
Mark Otto's avatar
Mark Otto committed
145
146
147

Learn more about [box model and sizing at CSS Tricks](https://css-tricks.com/box-sizing/).

148
### Reboot
Mark Otto's avatar
Mark Otto committed
149

XhmikosR's avatar
XhmikosR committed
150
For improved cross-browser rendering, we use [Reboot]({{< docsref "/content/reboot" >}}) to correct inconsistencies across browsers and devices while providing slightly more opinionated resets to common HTML elements.
151
152
153
154
155

## Community

Stay up to date on the development of Bootstrap and reach out to the community with these helpful resources.

XhmikosR's avatar
XhmikosR committed
156
157
- Read and subscribe to [The Official Bootstrap Blog]({{< param blog >}}).
- Join [the official Slack room]({{< param slack >}}).
158
- Chat with fellow Bootstrappers in IRC. On the `irc.libera.chat` server, in the `#bootstrap` channel.
159
- Implementation help may be found at Stack Overflow (tagged [`bootstrap-4`](https://stackoverflow.com/questions/tagged/bootstrap-4)).
XhmikosR's avatar
XhmikosR committed
160
- Developers should use the keyword `bootstrap` on packages which modify or add to the functionality of Bootstrap when distributing through [npm](https://www.npmjs.com/search?q=keywords:bootstrap) or similar delivery mechanisms for maximum discoverability.
161

XhmikosR's avatar
XhmikosR committed
162
You can also follow [@getbootstrap on Twitter](https://twitter.com/{{< param twitter >}}) for the latest gossip and awesome music videos.
Mark Otto's avatar
Mark Otto committed
163
164
165
166
167
168
169
170
171
172
173
174
175
176

## CSPs and embedded SVGs

Several Bootstrap components include embedded SVGs in our CSS to style components consistently and easily across browsers and devices. **For organizations with more strict <abbr title="Content Security Policy">CSP</abbr> configurations**, we've documented all instances of our embedded SVGs (all of which are applied via `background-image`) so you can more thoroughly review your options.

- [Close button]({{< docsref "/utilities/close-icon" >}}) (used in alerts and modals)
- [Custom checkboxes and radio buttons]({{< docsref "/components/forms#custom-forms" >}})
- [Form switches]({{< docsref "/components/forms#switches" >}})
- [Form validation icons]({{< docsref "/components/forms#validation" >}})
- [Custom select menus]({{< docsref "/components/forms#select-menu" >}})
- [Carousel controls]({{< docsref "/components/carousel#with-controls" >}})
- [Navbar toggle buttons]({{< docsref "/components/navbar#responsive-behaviors" >}})

Based on [community conversation](https://github.com/twbs/bootstrap/issues/25394), some options for addressing this in your own codebase include replacing the URLs with locally hosted assets, removing the images and using inline images (not possible in all components), and modifying your CSP. Our recommendation is to carefully review your own security policies and decide on a best path forward, if necessary.