Skip to content

Commit

Permalink
Add Toc component docs
Browse files Browse the repository at this point in the history
  • Loading branch information
malberts committed Jul 31, 2024
1 parent 1517f8a commit 97f5b56
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
21 changes: 20 additions & 1 deletion docs/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ The following components and modifications are available:
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->


- [`Structure`](#structure)
- [`Grid`](#grid)
- [`Row`](#row)
Expand Down Expand Up @@ -38,6 +37,7 @@ The following components and modifications are available:
- [Component `Silent`](#component-silent)
- [Component `SiteNotice`](#component-sitenotice)
- [Component `Toolbox`](#component-toolbox)
- [Component `Toc`](#component-toc)
- [Modification `HideFor`](#modification-hidefor)
- [Modification `ShowOnlyFor`](#modification-showonlyfor)
- [Modification `Sticky`](#modification-sticky)
Expand Down Expand Up @@ -1154,6 +1154,25 @@ and a link to a list of pages linking to the current page.
#### Allowed Child Elements:
* Any modification

-------------------------------------------------------------------------------
### Component `Toc`

The table of contents. This removes the table of contents from the main content and allows it to be placed elsewhere.
Subsections are collapsed, and it tracks the user's position on the page.

This component is experimental. Additional styling is required depending on where the component is placed.

Since Chameleon 4.4.0

#### Example usage

``` xml
<component type="Toc" />
```

#### Attributes:
None

-------------------------------------------------------------------------------
### Modification `HideFor`

Expand Down
1 change: 0 additions & 1 deletion docs/variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ Some examples are provided below:
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->


- [Grid breakpoints](#grid-breakpoints)
- [Link formats](#link-formats)

Expand Down

0 comments on commit 97f5b56

Please sign in to comment.