Skip to content

Commit 2db3b63

Browse files
committed
improve changelog, add section about migration to new major version
1 parent 1b14a61 commit 2db3b63

1 file changed

Lines changed: 21 additions & 17 deletions

File tree

CHANGELOG.md

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
88

99
This is a major release, and it might be not compatible with your current usage of our library. Please read about the necessary changes in the section about how to migrate.
1010

11+
### Migration from v24 to v25
12+
13+
- remove deprecated components, properties and imports from your project, if the info cannot be found here then it was already mentioned in **Deprecated** sections of the past changelogs
14+
- in case you set your own colors before importing GUI elements you need to update your configuration to the new color palette structure, see `README.md`
15+
- change `intent="primary"` to `intent="accent"` for `<Button />`, `<IconButton />` and `<Spinner />`, if supported it would be even better to use `affirmative={true}` or `elevated={true}` instead of `intent` in morst cases
16+
1117
### Added
1218

1319
- `<ChatContent />`
@@ -35,26 +41,28 @@ This is a major release, and it might be not compatible with your current usage
3541
- component for React Flow v12, displaying new connection lines
3642
- `<VisualTour />`
3743
- component to display a visual tour multi-step tour of the current view
38-
- new color palette that includes 4 sections with 20+ color tints in 5 weights each
39-
- indentity, semantic, layout, extra
40-
- managed via CSS custom properties
41-
- see `README.md` for inf about usage
4244
- `<Button />`
4345
- `accent` value for `intent` was added to align property with other components
4446
- `<Spinner />`
4547
- `accent` value for `intent` was added to align property with other components
4648
- `elevated` property can be used to highlight the spinner, currently the `intent="accent"` display is used
49+
- `<Modal />`:
50+
- Add `ModalContext` to track open/close state of all used application modals.
51+
- Add `modalId` property to give a modal a unique ID for tracking purposes.
52+
- `preventReactFlowEvents`: adds 'nopan', 'nowheel' and 'nodrag' classes to overlay classes in order to prevent react-flow to react to drag and pan actions in modals.
53+
- new `utils` methods
54+
- `colorCalculateDistance()`: calculates the difference between 2 colors using the simple CIE76 formula
55+
- `textToColorHash()`: calculates a color from a text string
56+
- `reduceToText`: shrinks HTML content and React elements to plain text, used for `<TextReducer />`
4757
- SCSS color functions
4858
- `eccgui-color-var`: returns a var of a custom property used for palette color
4959
- `eccgui-color-mix`: mix 2 colors in `srgb`, works with all types of color values and CSS custom properties
5060
- `eccgui-color-rgba`: like `rgba()` but it works also for CSS custom properties
51-
- `utils.colorCalculateDistance()`
52-
- function to calculate the difference between 2 colors using the simple CIE76 formula
53-
- `utils.textToColorHash()`
54-
- function to calculate a color from a text string
55-
- `utils.reduceToText`
56-
- shrinking HTML content and React elements to plain text, used for `<TextReducer />`
57-
- new icons
61+
- Color palette: includes 4 sections with 20+ color tints in 5 weights each
62+
- indentity, semantic, layout, extra
63+
- managed via CSS custom properties
64+
- see `README.md` for inf about usage
65+
- New icons
5866
- `artefact-task-sqlupdatequeryoperator`
5967
- `artefact-task-customsqlexecution`
6068
- `item-legend`
@@ -69,11 +77,7 @@ This is a major release, and it might be not compatible with your current usage
6977
- `state-progress`
7078
- `state-progress-error`
7179
- `state-progress-warning`
72-
- `<Modal />`:
73-
- Add `ModalContext` to track open/close state of all used application modals.
74-
- Add `modalId` property to give a modal a unique ID for tracking purposes.
75-
- `preventReactFlowEvents`: adds 'nopan', 'nowheel' and 'nodrag' classes to overlay classes in order to prevent react-flow to react to drag and pan actions in modals.
76-
- Added more icons for build tasks (CMEM-6898)
80+
- more icons for build tasks
7781

7882
### Removed
7983

@@ -98,7 +102,7 @@ This is a major release, and it might be not compatible with your current usage
98102
- use `<ReactFlow />` with `configuration`, or define it yourself
99103
- SCSS variables `$eccgui-color-application-text` and `$eccgui-color-application-background` were removed
100104
- use `$eccgui-color-workspace-text` and `$eccgui-color-workspace-background`
101-
- Removed `remarkTypograf` from markdown plugin tray to maintain display expectation
105+
- Removed `remark-typograf` plugin from `<Markdown />` rendering to maintain display expectation
102106

103107
### Fixed
104108

0 commit comments

Comments
 (0)