diff --git a/packages/web/MIGRATION-v1.md b/packages/web/MIGRATION-v1.md new file mode 100644 index 0000000000..0869ada3d0 --- /dev/null +++ b/packages/web/MIGRATION-v1.md @@ -0,0 +1,250 @@ +# Migration Guide + +Introducing version 1 of the spirit-web package + +> Please follow these steps to safely upgrade your Design System to Spirit Design System v1 components. + +## Remove modal body padding feature class [#DS-863](https://jira.lmc.cz/browse/DS-863) ([6d5a1d1](https://github.com/lmc-eu/spirit-design-system/commit/6d5a1d1)) + +Remove feature class `.spirit-v1-modal-body-padding`, if used. +No other actions are required. + +## Add `spirit` infix to data attr names for components and JS plugins [#DS-585](https://jira.lmc.cz/browse/DS-585) ([790ffb4](https://github.com/lmc-eu/spirit-design-system/commit/790ffb4)) + +Add `spirit` to all data-api attributes of affected components. + +- `data-toggle="collapse"` → `data-spirit-toggle="collapse"` + +List of affected components: + +- Accordion +- Collapse +- Dropdown +- FileUploader +- Header +- Modal +- ScrollView +- Tabs +- TextArea +- TextField +- Tooltip + +List of affected JS plugins: + +- Collapse +- Dropdown +- FileUploader +- Header +- Modal +- Offcanvas +- Tabs +- Tooltip + +To make everything work, you have to make these changes: + +### Accordion + +- `
` → `
` +- `