-
Notifications
You must be signed in to change notification settings - Fork 220
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Release 1.0.0 * Update changelog * remove references to Bootstrap 4 * rerun CI
- Loading branch information
Showing
13 changed files
with
41 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
__version__ = "1.0.0-dev" | ||
__version__ = "1.0.0" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -30,7 +30,7 @@ conda install -c conda-forge dash-bootstrap-components | |
``` | ||
----- | ||
R | ||
To get started make sure you have [installed Dash for R](https://dashr.plotly.com/installation). If you didn't already install it in order to install Dash for R, we also need to make sure that the _devtools_ library is installed. | ||
To get started make sure you have [installed Dash for R](https://dash.plotly.com/r/installation). If you didn't already install it in order to install Dash for R, we also need to make sure that the _devtools_ library is installed. | ||
```r | ||
install.packages("devtools") | ||
|
@@ -51,7 +51,7 @@ install_github('facultyai/[email protected]') | |
``` | ||
----- | ||
Julia | ||
To get started make sure you have [installed Dash.jl](https://dash-julia.plotly.com/installation). You can then install `DashBootstrapComponents` as follows | ||
To get started make sure you have [installed Dash.jl](https://dash.plotly.com/julia/installation). You can then install `DashBootstrapComponents` as follows | ||
```julia-repl | ||
pkg> add DashBootstrapComponents | ||
|
@@ -79,12 +79,13 @@ To use _dash-bootstrap-components_ you must do two things: | |
|
||
### Linking a stylesheet | ||
|
||
_dash-bootstrap-components_ doesn't come with CSS included. This is to give you the freedom to use any Bootstrap v4 stylesheet of your choice. This means however that in order for the components to be styled properly, you must link to a stylesheet yourself. | ||
_dash-bootstrap-components_ doesn't come with CSS included. This is to give you the freedom to use any Bootstrap v5 stylesheet of your choice. This means however that in order for the components to be styled properly, you must link to a stylesheet yourself. | ||
|
||
For convenience, links to [BootstrapCDN][bootstrapcdn] for standard Bootstrap and each Bootswatch theme are available as part of _dash-bootstrap-components_ and can be used as follows | ||
For convenience, CDN links to [JSDelivr][jsdelivr] for standard Bootstrap and each Bootswatch theme are available as part of _dash-bootstrap-components_ and can be used as follows | ||
|
||
~~~bootstrap-tabs | ||
Python | ||
In Python, each CDN link is available within the `dbc.themes` submodule and can | ||
be used when instantiating the `app` object. | ||
|
@@ -96,6 +97,7 @@ app = dash.Dash(external_stylesheets=[dbc.themes.BOOTSTRAP]) | |
``` | ||
----- | ||
R | ||
Once you have imported _dash-bootstrap-components_ with | ||
`library(dashBootstrapComponents)`, the `dbcThemes` list will be loaded into | ||
your global namespace and can be used when instantiating the `app` object. | ||
|
@@ -110,6 +112,8 @@ app <- Dash$new(external_stylesheets = dbcThemes$BOOTSTRAP) | |
----- | ||
Julia | ||
Once you have imported _dash-bootstrap-components_ with `using DashBootstrapComponents`, you can access CDN links through the `dbc_themes` named tuple. | ||
```julia | ||
using Dash, DashBootstrapComponents | ||
|
@@ -183,5 +187,5 @@ Check out these [example apps][examples] made with _dash-bootstrap-components_. | |
[docs-themes]: /docs/themes | ||
[docs-icons]: /docs/icons | ||
[docs-components]: /docs/components | ||
[bootstrapcdn]: https://www.bootstrapcdn.com/ | ||
[jsdelivr]: https://www.jsdelivr.com/ | ||
[examples]: /examples |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,13 +6,13 @@ title: Themes | |
|
||
<p class="lead">Customise your app by choosing from different Bootstrap and Bootswatch themes.</p> | ||
|
||
_dash-bootstrap-components_ doesn't come with CSS included. This is to give you the freedom to use any Bootstrap v4 stylesheet of your choice, so you can achieve the look you want in your app. | ||
_dash-bootstrap-components_ doesn't come with CSS included. This is to give you the freedom to use any Bootstrap v5 stylesheet of your choice, so you can achieve the look you want in your app. | ||
|
||
You can link to a stylesheet served over a CDN, or serve CSS locally depending on your needs. | ||
|
||
## Packaged CDN links | ||
|
||
_dash-bootstrap-components_ contains links to Bootstrap and Bootswatch stylesheets hosted on [BootstrapCDN][bootstrapcdn] so you can conveniently link to one of them in your app. The easiest way to do so is to use the `external_stylesheets` argument when instantiating your app. | ||
_dash-bootstrap-components_ contains links to Bootstrap and Bootswatch stylesheets hosted on [JSDelivr][jsdelivr] so you can conveniently link to one of them in your app. The easiest way to do so is to use the `external_stylesheets` argument when instantiating your app. | ||
|
||
~~~bootstrap-tabs | ||
Python | ||
|
@@ -84,21 +84,21 @@ Each theme such as is simply a BootstrapCDN URL stored as a string, so using the | |
Python | ||
```python | ||
BS = "https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css" | ||
BS = "https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" | ||
app = dash.Dash(external_stylesheets=[BS]) | ||
``` | ||
----- | ||
R | ||
```r | ||
BS <- "https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css" | ||
BS <- "https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" | ||
app <- Dash$new(external_stylesheets = BS) | ||
``` | ||
----- | ||
Julia | ||
```julia | ||
BS = "https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css" | ||
BS = "https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" | ||
app = dash(external_stylesheets=[BS]) | ||
``` | ||
~~~ | ||
|
@@ -113,17 +113,16 @@ The easiest way to link a local stylesheet is to place it in a folder named `ass | |
|
||
<h2 id="available-themes">Available themes</h2> | ||
|
||
There are numerous free to use Bootstrap stylesheets available on the web. The `dash_bootstrap_components.themes` module contains CDN links for Bootstrap and all of the [Bootswatch themes][bootswatch-themes]. Bootstrap also maintains its own [themes website][bootstrap-themes] which lists a number of free and premium themes that you could incorporate into your apps. | ||
There are numerous free to use Bootstrap stylesheets available on the web. The `dash_bootstrap_components.themes` module contains CDN links for Bootstrap and all of the [Bootswatch themes][bootswatch]. Bootstrap also maintains its own [themes website][bootstrap-themes] which lists a number of free and premium themes that you could incorporate into your apps. | ||
|
||
To start with, we recommend experimenting with some of the Bootswatch themes available in the `dash_bootstrap_components.themes` module. The full list of available themes is [`CERULEAN`](https://bootswatch.com/cerulean/), [`COSMO`](https://bootswatch.com/cosmo/), [`CYBORG`](https://bootswatch.com/cyborg/), [`DARKLY`](https://bootswatch.com/darkly/), [`FLATLY`](https://bootswatch.com/flatly/), [`JOURNAL`](https://bootswatch.com/journal/), [`LITERA`](https://bootswatch.com/litera/), [`LUMEN`](https://bootswatch.com/lumen/), [`LUX`](https://bootswatch.com/lux/), [`MATERIA`](https://bootswatch.com/materia/), [`MINTY`](https://bootswatch.com/minty/), [`MORPH`](https://bootswatch.com/morph/), [`PULSE`](https://bootswatch.com/pulse/), [`QUARTZ`](https://bootswatch.com/quartz/), [`SANDSTONE`](https://bootswatch.com/sandstone/), [`SIMPLEX`](https://bootswatch.com/simplex/), [`SKETCHY`](https://bootswatch.com/sketchy/), [`SLATE`](https://bootswatch.com/slate/), [`SOLAR`](https://bootswatch.com/solar/), [`SPACELAB`](https://bootswatch.com/spacelab/), [`SUPERHERO`](https://bootswatch.com/superhero/), [`UNITED`](https://bootswatch.com/united/), [`VAPOR`](https://bootswatch.com/vapor/), [`YETI`](https://bootswatch.com/yeti/), [`ZEPHYR`](https://bootswatch.com/zephyr/). | ||
|
||
Check out the [theme explorer](/docs/themes/explorer/) for a live demo of dash-bootstrap-components using all of the different available themes. You may also like to check out the [dash-bootstrap-css](https://github.com/tcbegley/dash-bootstrap-css) project which contains Bootstrap stylesheets that apply consistent styling to various components from dash-core-components. | ||
|
||
[dash-docs-external]: https://dash.plotly.com/external-resources/ | ||
[bootstrapcdn]: https://www.bootstrapcdn.com/ | ||
[bootstrap]:https://getbootstrap.com/ | ||
[bootstrap-download]: https://getbootstrap.com/docs/4.6/getting-started/download/ | ||
[bootstrap-compile]: https://getbootstrap.com/docs/4.6/getting-started/theming/ | ||
[bootstrap-themes]: https://themes.getbootstrap.com/ | ||
[bootstrap-download]: https://getbootstrap.com/docs/5.0/getting-started/download/ | ||
[bootstrap-compile]: https://getbootstrap.com/docs/5.0/customize/overview/ | ||
[bootswatch]: https://bootswatch.com/ | ||
[bootswatch-themes]: https://www.bootstrapcdn.com/bootswatch/ | ||
[jsdelivr]: https://www.jsdelivr.com/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,4 +2,4 @@ | |
|
||
|
||
def test_version(): | ||
assert __version__ == "1.0.0-dev" | ||
assert __version__ == "1.0.0" |