Skip to content

Commit 47bd0ee

Browse files
authored
Update migration guide (#699)
* Update migration guide * Update layout migration instructions
1 parent eb5592a commit 47bd0ee

File tree

1 file changed

+48
-12
lines changed

1 file changed

+48
-12
lines changed

docs/content/migration-guide.md

Lines changed: 48 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,46 @@ title: Migration guide
77
_dash-bootstrap-components_ v1 contains loads of new features, but also some breaking changes. This is for two reasons:
88

99
- First, now that the library has matured, we have taken the opportunity to clean up the API and make things more consistent across components.
10-
- Second we have updated all components to support Bootstrap 5 (previously we supported Bootstrap 4). Since Bootstrap 5 also contains a number of breaking changes, we have inherited those in _dash-bootstrap-components_. For more information about the changes in Bootstrap 5, see the upstream [Bootstrap migration guide.](https://v5.getbootstrap.com/docs/5.0/migration) and the [Bootstrap 5 Documentation](https://getbootstrap.com/docs/5.0/layout/grid/).
10+
- Second we have updated all components to support Bootstrap 5 (previously we supported Bootstrap 4). Since Bootstrap 5 also contains a number of breaking changes, we have inherited those in _dash-bootstrap-components_. For more information about the changes in Bootstrap 5, see the upstream [Bootstrap migration guide](https://v5.getbootstrap.com/docs/5.0/migration) and the [Bootstrap 5 Documentation](https://getbootstrap.com/docs/5.0/layout/grid/).
1111

1212
This guide introduces the new features, and also covers the changes you must make to run your apps with _dash-bootstrap-components_ 1.0.0 rather than 0.13.x (the final v0 releases). If you find any issues not covered here, or bugs in v1 please [raise an issue](https://github.com/facultyai/dash-bootstrap-components/issues/new/choose) on our GitHub repository.
1313

14+
If you're not ready to upgrade yet, you can continue to use earlier versions of dash-bootstrap-components, just be sure to pin the version numbers.
15+
16+
~~~bootstrap-tabs
17+
Python
18+
### PyPI
19+
20+
To install the last v0 release of _dash-bootstrap-components_ from PyPI use
21+
22+
```sh
23+
pip install "dash-bootstrap-components<1"
24+
```
25+
26+
### Anaconda
27+
28+
If you installed _dash-bootstrap-components_ with `conda` you can use
29+
30+
```sh
31+
conda install -c conda-forge "dash-bootstrap-components<1"
32+
```
33+
-----
34+
R
35+
You can install earlier versions of _dash-bootstrap-components_ from our GitHub repository by specifying the relevant tag
36+
37+
```r
38+
library(devtools)
39+
install_github('facultyai/[email protected]')
40+
```
41+
-----
42+
Julia
43+
You can install earlier versions of `DashBootstrapComponents` by adding the version number to the install command.
44+
45+
```julia-repl
46+
47+
```
48+
~~~
49+
1450
## Dependencies
1551

1652
<span class="badge bg-danger">Breaking</span> _dash-bootstrap-components_ v1 requires Dash 2.0.0 or greater. The primary implication of this is that we have dropped support for Python 2.7 and 3.5. All apps using _dash-bootstrap-components_ v1 should be run with Python 3.6+.
@@ -42,9 +78,7 @@ Notably previously there was a mix of `size` and `bs_size` props for controlling
4278

4379
### Buttons
4480
- <span class="badge bg-danger">Breaking</span> The default color for the buttons is now `primary` rather than `secondary`. This change was made to match the Bootstrap convention.
45-
4681
- <span class="badge bg-danger">Breaking</span> The `block` property has been dropped. Instead, wrap the buttons in a `html.Div` and use the Bootstrap utilities classes such as `"d-grid"` and a `"gap-*"` in the `className` to space the buttons as needed. See [the docs](/docs/components/button) for examples.
47-
4882
- Disabled buttons now have `pointer-events: none` as a default.
4983

5084
### ButtonGroup
@@ -53,13 +87,16 @@ Notably previously there was a mix of `size` and `bs_size` props for controlling
5387
### Card
5488
- <span class="badge bg-danger">Breaking</span> Dropped `CardDeck` component. Use the Bootstrap grid classes to arrange the cards like a card deck. See
5589
the [Bootstrap grid docs](https://getbootstrap.com/docs/5.0/layout/grid/#row-columns) for more information.
56-
5790
- <span class="badge bg-danger">Breaking</span> Dropped `CardColumns` component. `CardColumns` had many [issues in Bootstrap 4](https://github.com/twbs/bootstrap/pull/28922) and was dropped in Bootstrap 5.
5891

5992
### Carousel
6093
- Added `dark` property for dark text, controls, and indicators. This is great for lighter backgrounds.
6194
- Replaced chevron icons for carousel controls with new SVGs from Bootstrap Icons.
6295

96+
### Col
97+
- <span class="badge bg-danger">Breaking</span> When specifying the `order` of the columns, it accepts the integers 1, ..., 5, only rather than integers 1, ..., 12.
98+
- Added `xxl` prop corresponding to the new `xxl` breakpoint in Bootstrap 5. Allows you to control the layout on extra large screens.
99+
63100
### Collapse
64101
- <span class="badge bg-danger">Breaking</span> Dropped the `tag` property.
65102
- Removed the Accordion example since we now have a new Accordion component.
@@ -90,10 +127,6 @@ the [Bootstrap grid docs](https://getbootstrap.com/docs/5.0/layout/grid/#row-col
90127
### Jumbotron
91128
- <span class="badge bg-danger">Breaking</span> Dropped the Jumbotron component. The [docs have an example](/docs/components/jumbotron/) of how to replicate it with Bootstrap utilities.
92129

93-
### Layout
94-
- <span class="badge bg-danger">Breaking</span> Dropped `no_gutters` prop. Use gutter modifier classes instead. See the [docs](/docs/components/layout/) for examples.
95-
- <span class="badge bg-danger">Breaking</span> When specifying the `order` of the columns, it accepts the integers 1, ..., 5, only rather than integers 1, ..., 12.
96-
97130
### ListGroup
98131
- <span class="badge bg-danger">Breaking</span> Dropped the `ListGroupHeading` and `ListGroupItemText` components. Both are unnecessary since you can pass any Dash components to the children of `ListGroupItem`. See the [docs](/docs/components/list_group/) for updated examples.
99132

@@ -121,18 +154,21 @@ the [Bootstrap grid docs](https://getbootstrap.com/docs/5.0/layout/grid/#row-col
121154
- Added a `label` property that should be used instead of `children` to render text on the progress bar.
122155
- Added a `hide_label` property to hide the label.
123156

157+
### Row
158+
- <span class="badge bg-danger">Breaking</span> Dropped `no_gutters` prop. Use gutter modifier classes instead. See the [docs](/docs/components/layout/) for examples.
159+
124160
### Select
125161
- <span class="badge bg-danger">Breaking</span> Dropped `bs_size` property. Use `size` instead.
126162

127163
### Switch <span class="badge bg-success">New</span>
128-
- New `Switch` component. See the documentation [here](/docs/components/input)
164+
- New `Switch` component. See the documentation [here](/docs/components/input)
129165

130166
### Table
131-
- <span class="badge bg-danger">Breaking</span> Dropped `tag` property.
132-
- Added `color` property.
167+
- <span class="badge bg-danger">Breaking</span> Dropped `tag` property.
168+
- Added `color` property.
133169

134170
### Tabs
135-
- <span class="badge bg-danger">Breaking</span> Dropped `card` property. It's no longer necessary to set `card=True` to put tabs in a `Card`.
171+
- <span class="badge bg-danger">Breaking</span> Dropped `card` property. It's no longer necessary to set `card=True` to put tabs in a `Card`.
136172

137173
### TextArea
138174
- <span class="badge bg-danger">Breaking</span> Dropped `bs_size` property. Use `size` instead.

0 commit comments

Comments
 (0)