Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
antonymilne committed Nov 28, 2023
1 parent 4711fee commit 6efabd2
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 445 deletions.
Binary file modified vizro-core/docs/assets/user_guides/navigation/custom_icons.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions vizro-core/docs/pages/tutorials/explore_components.md
Original file line number Diff line number Diff line change
Expand Up @@ -710,8 +710,8 @@ and how to bring them together.
For future dashboard creations, you can explore more about the available dashboard `components` by going through the
[user guide](../user_guides/components.md). To gain more in-depth knowledge about the usage and configuration
details of `controls`, check out the user guides dedicated to [Filters](../user_guides/filters.md), [Parameters](../user_guides/parameters.md)
and [Selectors](../user_guides/selectors.md). This guide will provide you with valuable insights on utilizing and
customizing controls for interactive functionality in your dashboards.
and [Selectors](../user_guides/selectors.md). If you'd like to understand more about different ways to configure the navigation of your dashboard, head
to [Navigation](../user_guides/navigation.md).

Vizro doesn't end here, and we only covered the key features, but there is still much more to explore! You can learn:

Expand Down
7 changes: 7 additions & 0 deletions vizro-core/docs/pages/user_guides/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -400,6 +400,13 @@ and provide an attribute selector to select images with that matching URL hash.

### Creating navigation

!!! note

This section describes how to use the [`Card`][vizro.models.Card] component to create a navigation
card. To configure the navigation panel on the left hand side of the screen, refer to the
[guide on navigation](navigation.md).


A navigation card allows you to navigate to a different page via a click on the card area.
To create a navigation card, do the following:

Expand Down
8 changes: 4 additions & 4 deletions vizro-core/docs/pages/user_guides/navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ By default, if the `navigation` argument is not specified, Vizro creates a navig
title: My first page
- components:
- text: My text here
type: graph
type: card
title: My second page
- components:
- figure:
Expand Down Expand Up @@ -166,7 +166,7 @@ Another way to group together pages in the navigation is to use a [`NavBar`][viz
Group B:
- My third page
nav_selector:
type: nav_bawr
type: nav_bar
```
=== "Result"
[![NavBar]][NavBar]
Expand Down Expand Up @@ -211,7 +211,7 @@ The same configuration for [grouping pages](#grouping-your-pages) applies inside
# pages defined as in default example
navigation:
nav_selector:
type: nav_bawr
type: nav_bar
items:
- label: Section 1
pages:
Expand Down Expand Up @@ -256,7 +256,7 @@ You can alter the icons used by specifying the name of the icon in the [Google M
# pages defined as in default example
navigation:
nav_selector:
type: nav_bawr
type: nav_bar
items:
- label: Section 1
icon: bar_chart
Expand Down
Loading

0 comments on commit 6efabd2

Please sign in to comment.