Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve dashboard title #228

Merged
merged 11 commits into from
Dec 19, 2023
Merged

Improve dashboard title #228

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
4def8ed
Improve dashboard title
antonymilne Dec 19, 2023
cfc3cf7
Lint and changelog
antonymilne Dec 19, 2023
e11f3b6
Update vizro-core/examples/default/app.py
antonymilne Dec 19, 2023
20dcd1a
Update example
antonymilne Dec 19, 2023
5cef34a
Revert example change
antonymilne Dec 19, 2023
c00fe4e
Update app title if dashboard.title set
antonymilne Dec 19, 2023
7f981fb
Update docs
antonymilne Dec 19, 2023
b5ea319
Update JSON schema comment
antonymilne Dec 19, 2023
708bb8e
Merge branch 'main' into feature/improve-dashboard-title
antonymilne Dec 19, 2023
638f0b0
Update vizro-core/examples/default/app.py
antonymilne Dec 19, 2023
403097a
Merge branch 'main' into feature/improve-dashboard-title
antonymilne Dec 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update docs
  • Loading branch information
@antonymilne
antonymilne committed Dec 19, 2023
commit 7f981fb1c327ef11f9dfd295a61950124f184750
7 changes: 5 additions & 2 deletions vizro-core/docs/pages/user_guides/dashboard.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
This guide shows you how to configure and call a [`Dashboard`][vizro.models.Dashboard] using either
pydantic models, python dictionaries, yaml or json.

To create a dashboard, do the following steps:
To create a dashboard:

1. Choose one of the possible configuration syntaxes
2. Create your `pages`, see our guide on [Pages](pages.md)
Expand Down Expand Up @@ -191,4 +191,7 @@ After running the dashboard, you can access the dashboard via `localhost:8050`.

## Adding a dashboard title

When providing a `title` to the [`Dashboard`][vizro.models.Dashboard], it will automatically be added as a header for each [`Page`][vizro.models.Page].
If supplied, the `title` of the [`Dashboard`][vizro.models.Dashboard] displays a heading at the top left of every page. It is also combined with the `title` specified in [`Page`][vizro.models.Page] to set:

- `<title>` HTML element that controls the text labeling a browser window;
- `<meta>` elements that control how a preview is generated when sharing a link to your dashboard (e.g. on social media).
Loading