Skip to content

Commit

Permalink
fixing CHANGELOG.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shivam-daksh committed Aug 20, 2024
1 parent 00fcee6 commit 92401f1
Showing 1 changed file with 90 additions and 8 deletions.
98 changes: 90 additions & 8 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,50 @@ Changelog is rather internal in nature. See release notes for the public overvie

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

- [#738]
- **Description:** Bump KDS version to 5.0.0-rc2.
- **Products impact:** -.
- **Addresses:** -.
- **Components:** -.
- **Breaking:** -.
- **Impacts a11y:** -.
- **Guidance:** -.

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

- [705]
- **Description:** Update`KCard` updates: Adds 'preserveAboveTitle`, `preserveBelowTitle`, `preserveFooter` prop for flexible slot management.
- **Products impact:** Card updates
- **Addresses:** https://github.com/learningequality/kolibri-design-system/issues/702
- **Components:** `KCard`
- **Breaking:** N0
- **Impacts a11y:** No
- **Guidance:**

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

- [719]
- **Description:** Removes KResponsiveWindowMixin.
- **Products impact:** removed API.
- **Addresses:** https://github.com/learningequality/kolibri-design-system/issues/679.
- **Components:** KResponsiveWindowMixin.
- **Breaking:** yes.
- **Impacts a11y:** no.
- **Guidance:** Replace any use of KResponsiveWindowMixin with the new composable useKResponsiveWindow.

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

- [#718]
- **Description:** This pull request resolves failing `KDateCalendar` component tests that occurred on the last day of the month in open pull requests by setting dates manually in the tests. Additionally, the `KDateCalendar` is updated to show the month of the `lastAllowedDate` property.
- **Products impact:** none
- **Addresses:** https://github.com/learningequality/kolibri-design-system/issues/713
- **Components:** -
- **Breaking:** no
- **Impacts a11y:** -
- **Guidance:** -

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

- [#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,45 +58,61 @@ 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]

- [#688]
- **Description:** Update`KCard` styling
- **Products impact:** Card updates
- **Addresses:**
- **Components:** `KCard`
- **Breaking:** N0
- **Impacts a11y:** No
- **Guidance:**
[#688] https://github.com/learningequality/kolibri-design-system/pull/688

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

[#707]
- [#707]
- **Description:** Card Validations
- **Products impact:**
- **Addresses:** [#695](https://github.com/learningequality/kolibri-design-system/issues/695)
- **Components:** `KCard`
- **Breaking:** No
- **Impacts a11y:** No
- **Guidance:**
[#707] https://github.com/learningequality/kolibri-design-system/pull/707

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

- [#706]
- **Description:** Add new alignment options to `KCard`
- **Products impact:** new alignment
- **Addresses:** [#701](https://github.com/learningequality/kolibri-design-system/issues/701)
- **Components:** `KCard`
- **Breaking:** N0
- **Impacts a11y:** No
- **Guidance:**

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


- [#709]
- **Description:** Update spaces to the latest design`KCard`
- **Products impact:** Card updates
- **Addresses:** [#704](https://github.com/learningequality/kolibri-design-system/issues/704)
- **Components:** `KCard`
- **Breaking:** N0
- **Impacts a11y:** No
- **Guidance:**
[#709] https://github.com/learningequality/kolibri-design-system/pull/709

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

- [#625]
- **Description:** Initial implementation of `KCard` component
- **Products impact:** New Component
- **Addresses:** [#530](https://github.com/learningequality/kolibri-design-system/issues/530)
- **Components:** KCard
- **Breaking:** No
- **Impacts a11y:** Yes
- **Guidance:**

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

- [#678]
Expand Down Expand Up @@ -135,6 +195,28 @@ Changelog is rather internal in nature. See release notes for the public overvie
## Version 4.x.x (`release-v4` branch)


- [#737]
- **Description:** Bump KDS version to 4.4.1.
- **Products impact:** -.
- **Addresses:** -.
- **Components:** -.
- **Breaking:** -.
- **Impacts a11y:** -.
- **Guidance:** -.

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

- [#717]
- **Description:** Fix ResizeOserver errors when KListWithOverflow resize very quickly.
- **Products impact:** bugfix.
- **Addresses:** Sentry error.
- **Components:** KListWithOverflow.
- **Breaking:** no.
- **Impacts a11y:** no.
- **Guidance:** -.

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

- [#680]
- **Description:** Adds boolean `appendToRoot` prop to teleport the modal to the body element if true.
- **Products impact:** new API.
Expand Down Expand Up @@ -1782,4 +1864,4 @@ This was the first release of the Design System, with documentation written in a

## Version 0.1.0

The design system was originally based on a set of internal Kolibri components and their use as documented in the Kolibri Style Guide, which was first introduced into the Kolibri code base [in version 0.6](https://github.com/learningequality/kolibri/tree/release-v0.6.x/kolibri/plugins/style_guide). This remained until [version 0.13](https://github.com/learningequality/kolibri/tree/release-v0.13.x/kolibri/plugins/style_guide) after which the content was migrated to the [current site](https://design-system.learningequality.org/ 'Kolibri Design System Documentation').
The design system was originally based on a set of internal Kolibri components and their use as documented in the Kolibri Style Guide, which was first introduced into the Kolibri code base [in version 0.6](https://github.com/learningequality/kolibri/tree/release-v0.6.x/kolibri/plugins/style_guide). This remained until [version 0.13](https://github.com/learningequality/kolibri/tree/release-v0.13.x/kolibri/plugins/style_guide) after which the content was migrated to the [current site](https://design-system.learningequality.org/ 'Kolibri Design System Documentation').

0 comments on commit 92401f1

Please sign in to comment.