Skip to content

Commit

Permalink
Add Upgrade Process to README.
Browse files Browse the repository at this point in the history
  • Loading branch information
marvel-uiuc committed Aug 27, 2024
1 parent 4ee165a commit 3a8c196
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,17 @@ it will be styled to indicate that.
the same level is hard to scan, but navigation deeper than 3 levels is also hard to
use.

## Upgrade Process

When upgrading from the v2 toolkit component, the following changes are needed:

- Rename all `il-section-nav` to `ilw-section-nav`.
- Remove heading tags (`h2`, `h3`, etc.). The first link will be emphasized as the root of
the navigation.
- Remove the top-level `ul` or `ol` tag that's directly under `ilw-section-nav`.
- Replace all other `ul` or `ol` tags with `ilw-section-nav`.
- Remove all `li` tags.

## External References

- https://www.w3.org/WAI/tutorials/menus/structure/
Expand Down

0 comments on commit 3a8c196

Please sign in to comment.