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 30, 2024
1 parent 256fc8a commit d57affc
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,17 @@ text. There are a few attributes to control the component:
- **Centered text** can be harder to read, so avoid using longer text when
center aligning.
- Make sure links and buttons are descriptive, using `ilw-sr-only` if needed to add context.

## Upgrade Process

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

- Rename all `il-call-to-action` to `ilw-call-to-action`.
- Replace uses of the theme classes with an attribute:
- `class="il-theme-gray"` -> `theme="gray"`
- `class="il-theme-blue"` -> `theme="blue"`
- `class="il-theme-white"` -> `theme="white"`
- `class="il-theme-blue-gradient"` -> `theme="blue-gradient"`
- Replace uses of the alignment classes with an attribute:
- `class="il-align-left"` -> `align="left"`
- `class="il-align-center"` -> `align="center"`

0 comments on commit d57affc

Please sign in to comment.