Skip to content

Commit

Permalink
adding more description to CHANGELOG.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shivam-daksh committed Aug 21, 2024
1 parent 3adf095 commit 5eabf99
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,17 @@ Changelog is rather internal in nature. See release notes for the public overvie

## Upcoming version 5.x.x (`develop` branch)

- [#728]
- **Description:** Adds `$darken_` utility functions for darkening palette colors and ensures compatibility with Node.js v10 by pinning the `color` package version to `3.2.1`.
- **Products impact:** Kolibri Design System
- **Addresses:** https://github.com/learningequality/kolibri-design-system/issues/726
- **Components:** Styling utilities (`$darken1(hexColorValue)`,`$darken2(hexColorValue)` and `$darken3(hexColorValue)` functions)
- **Breaking:** no
- **Impacts a11y:** no
- **Guidance:** Ensure to install the exact `color` version specified in `package.json` to maintain compatibility with Node.js v10.

[#728]: https://github.com/learningequality/kolibri-design-system/pull/728

- [#687]
- **Description:** Adds logic that inserts ARIA live assertive and polite regions to an application's document body during KDS initialization and documents this on the new "Installation" page. Relatedly adds `useKLiveRegion` composable with public methods for updating the live regions with assertive and polite messages.
- **Products impact:** new API
Expand All @@ -14,6 +25,7 @@ Changelog is rather internal in nature. See release notes for the public overvie
- **Guidance:** Find all polite and live regions (or roles) in an application. Remove them and instead use `useKLiveRegion.sendPoliteMessage` and `useKLiveRegion.sendAssertiveMessage` to update the live regions that KDS inserted to document body during installation.

[#687]: https://github.com/learningequality/kolibri-design-system/pull/687

[#688]
- **Description:** Update`KCard` styling
- **Products impact:** Card updates
Expand All @@ -24,16 +36,6 @@ Changelog is rather internal in nature. See release notes for the public overvie
- **Guidance:**
[#688] https://github.com/learningequality/kolibri-design-system/pull/688

[#728]
- **Description:** [add the description of your PR here]
- **Products impact:** None
- **Addresses:** https://github.com/learningequality/kolibri-design-system/issues/726
- **Components:**
- **Breaking:** N0
- **Impacts a11y:** No
- **Guidance:**
[#728]https://github.com/learningequality/kolibri-design-system/pull/728

[#707]
- **Description:** Card Validations
- **Products impact:**
Expand Down

0 comments on commit 5eabf99

Please sign in to comment.