You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+84-5Lines changed: 84 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,10 +6,35 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
6
6
7
7
## [Unreleased]
8
8
9
+
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.
10
+
11
+
### Migration from v23 to v24
12
+
13
+
- upgrade Typescript to v5
14
+
- upgrade Node to at least v18, see **Changed** section for more info about it
15
+
- 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
16
+
-`<GridColumn/>`
17
+
-`full`: was deprecated and now removed because it always uses full width if it is the only column and does not have any othe size config
18
+
-`<Notification/>`
19
+
-`fullWidth`: was deprecated and now removed, use `flexWidth` as replacement
20
+
-`iconName`: was deprecated and now removed, use `icon` property
21
+
-`<Table/>`
22
+
-`size`: use only "small", "medium" or "large" as value
23
+
-`<Tag/>`
24
+
-`emphasized`: was deprecated and now removed, use `minimal=false` plus `emphasis="stronger"` instead
25
+
-`IconSized` type: use `CarbonIconType`
26
+
-`TimeUnits` type: use `ElapsedDateTimeDisplayUnits`
27
+
-`MarkdownParserProps` interface: use `MarkdownProps`
28
+
-`elapsedTimeSegmented` function: use `elapsedDateTimeDisplayUtils.elapsedTimeSegmented`
29
+
-`simplifiedElapsedTime` function: use `elapsedDateTimeDisplayUtils.simplifiedElapsedTime`
30
+
9
31
### Added
10
32
33
+
-`<StringPreviewContentBlobToggler />`:
34
+
-`noTogglerContentSuffix`: Allows to add non-string elements at the end of the content if the full description is shown, i.e. no toggler is necessary. This allows to add non-string elements to both the full-view content and the pure string content.
11
35
-`<MultiSuggestField />`
12
36
- An optional custom search function property has been added, it defines how to filter elements.
37
+
- Added a prop `limitHeightOpened` to limit the height of the dropdown by automatically calculating the available height in vh.
13
38
-`<FlexibleLayoutContainer />` and `<FlexibleLayoutItem />`
14
39
- helper components to create flex layouts for positioning sub elements
15
40
- stop misusing `Toolbar*` components to do that (anti pattern)
@@ -18,6 +43,22 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
18
43
-`<Label />`
19
44
-`emphasis` property to control visual appearance of the label text
20
45
- basic Storybook example for `<Application* />` components
46
+
-`<CodeEditor />`
47
+
-`setEditorView` option for compatibility to Codemirror v6
48
+
-`supportCodeFolding` optional property to fold code for the supported modes e.g: `xml`, `json`, etc.
49
+
-`shouldHighlightActiveLine` optional property to highlight active line where the cursor is currently in.
50
+
-`shouldHaveMinimalSetup` optional property that imports codemirror's base minimal configurations.
51
+
-`additionalExtensions` optional property for additional extensions to customize the editor further.
52
+
-`<Markdown />`
53
+
-`htmlContentBlockProps` can now be used to configure the wrapper around the Markdown content
54
+
-`$eccgui-selector-text-spot-highlight` config variable to specify selector that is used to create shortly highlighted spots
55
+
- it is highlighted when the selector is also active local anchor target or if it has the `.eccgui-typography--spothighlight` class attached to it
56
+
57
+
### Fixed
58
+
59
+
- toggling on/off the `<HandleTools/>` was corrected, they kept displayed after re-entering with the cursor
60
+
-`<Pagination/>`
61
+
- change text overflow for selectors to `clip` because Firefox rendered `ellipsis` a bit too early
21
62
22
63
### Changed
23
64
@@ -33,9 +74,47 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
33
74
- upgrade to Storybook v8
34
75
- include a few patches for actions, see https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#implicit-actions-can-not-be-used-during-rendering-for-example-in-the-play-function
35
76
- allow `next` and `legacy` as branch names
77
+
-`<CodeEditor />`
78
+
-`setInstance` interface changed to `setEditorView` for semantic compatibility to Codemirror v6
79
+
-`<BreadcrumbItem/>`
80
+
- link color and separation char were adjusted
81
+
-`<Markdown/>`
82
+
- align blocks for language specific code to default code blocks
36
83
-`<ReactFlow />`
37
84
- property color for `graph` configuration was adjusted
38
85
- switch icons for `item-clone` and `item-copy` to Carbon's `<Replicate/>` and `<Copy/>`
86
+
- Remove duplicated icon names `artefact-customtask*` and only keep `artefact-task*` names.
87
+
-`<OverviewItemDepiction/>`
88
+
- improve examples in storybook
89
+
- improve display for images that are to large for the available space (fully show them)
90
+
91
+
### Deprecated
92
+
93
+
-`<Icon/>` and `<TestIcon/>`
94
+
-`description` and `iconTitle`: use `title` as replacement.
95
+
-`TableRowHeightSize` type: use `TableProps["size"]` directly
96
+
-`IRenderModifiers` interface: use `SuggestFieldItemRendererModifierProps`
97
+
-`IElementWidth` type: use `SuggestFieldItemRendererModifierProps["styleWidth"]`
98
+
-`MultiSelectSelectionProps` interface: use `MultiSuggestFieldSelectionProps`
99
+
-`MultiSelectProps` interface: use `MultiSuggestFieldProps`
100
+
-`nodeTypes` and `edgeTypes`
101
+
- will be removed without replacement, define it yourself or use `<ReactFlow/` with `configuration` option
102
+
-`AutoCompleteFieldProps` and `IAutoCompleteFieldProps` interfaces: use `SuggestFieldProps`
103
+
-`<CodeAutocompleteField/>`
104
+
-`AutoSuggestionProps`: use `CodeAutocompleteFieldProps` instead
105
+
- we renamed `ISuggestionBase`, `ISuggestionWithReplacementInfo`, `IReplacementResult`, `IPartialAutoCompleteResult`, `IValidationResult` to `CodeAutocompleteFieldSuggestionBase`, `CodeAutocompleteFieldSuggestionWithReplacementInfo`, `CodeAutocompleteFieldReplacementResult`, `CodeAutocompleteFieldPartialAutoCompleteResult`, `CodeAutocompleteFieldValidationResult`
106
+
- all legacy support components are going to be removed, you need to replace them by activily maintained components
107
+
-`<ButtonReplacement/>`: switch to `<Button />`
108
+
-`<AffirmativeButtonReplacement/>`: switch to `<Button affirmative />`
109
+
-`<DismissiveButtonReplacement/>`: switch to `<Button dismissive />`
110
+
-`<DisruptiveButtonReplacement/>`: switch to `<Button disruptive />`
111
+
-`<CheckboxReplacement/>`: switch to `<Checkbox />`
112
+
-`<RadioButtonReplacement/>`: switch to `<RadioButton />`
113
+
-`<TabsReplacement/>`: switch to `<Tabs />`
114
+
-`<TextFieldReplacement/>`: switch to `<TextField />`, `<TextArea />`, `<FieldItem />`
115
+
-`MultiSuggestField.ofType` method:
116
+
- instead of `MyMultiSuggest = MultiSuggestField.ofType<MyType>()` use directly `<MultiSuggestField<MyType> {...props} />`
117
+
-`MultiSuggestField.ofType` also returns the original BlueprintJS `MultiSelect` element, not our version!
39
118
40
119
## [23.8.0] - 2024-08-19
41
120
@@ -84,7 +163,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
84
163
- Element wraps the content that need to be displayed sticky.
85
164
-`utils`
86
165
-`getScrollParent`: method to find the scroll parent of an element
87
-
-`<AutoCompleteField />`
166
+
-`<SuggestField />`
88
167
- Support loading more results when scrolling to the end of the result list.
89
168
-`<TextArea />`
90
169
-`intent` property to set the state, formerly used `hasStatePrimary`, `hasStateSuccess`, `hasStateWarning` and `hasStateDanger` properties are now deprecated
@@ -219,7 +298,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
219
298
- `<ActivityControlWidget />`
220
299
- added extra line to show timer for execution period
221
300
- `<ExtendedCodeEditor />`
222
-
- replaces `<SingleLineCodeEditor />` to get used for the `<AutoSuggestion />` component
301
+
- replaces `<SingleLineCodeEditor />` to get used for the `<CodeAutocompleteField />` component
@@ -267,7 +346,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
267
346
- `loose`: can be set to `true` to prevent the box with border on the label component
268
347
- `<TableExpandHeader />`
269
348
- `toggleIcon`: optional icon that should be displayed instead of the default ones.
270
-
- `Utilities`
349
+
- `utils`
271
350
- `getGlobalVar` and `setGlobalVar`: can be used to manage global variables indepentently from component states. They are stored to the `window` object under a `eccgui` "namespace". Can be used for example to manage globally increased counters. Do not use them if you need to store user session properties or confidential data!
272
351
- canonical icons for `artefact-chatlog`, `entity-human`, `entity-robot` and `operation-magic`
273
352
@@ -397,7 +476,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
397
476
- `<WorkspaceHeader />`
398
477
- `IWorkspaceHeaderProps` interface is now deprecated, use `WorkspaceHeaderProps` instead
399
478
- `<NumericInput />`
400
-
- It will be remove because beside the special arrow buttons it does not add any special. Could be done also with `<TextField />` combined with correct `type`.
479
+
- It will be removed because beside the special arrow buttons it does not add any special. Could be done also with `<TextField />` combined with correct `type`.
401
480
- `<Highlighter />`
402
481
- `HighlighterFunctions` renamed to `highlighterUtils`
403
482
- `extractSearchWords` moved to `highlighterUtils.extractSearchWords`
@@ -412,7 +491,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
412
491
- `ReactFlow` extensions
413
492
- `NodeProps`: renamed to `NodeDefaultProps`
414
493
- `minimapNodeClassName`: moved to `miniMapUtils.nodeClassName`
415
-
- `minimapNodeColor`: moved to `miniMapUtils.nodeClassName`
494
+
- `minimapNodeColor`: moved to `miniMapUtils.nodeColor`
416
495
- `nodeUtils`: renamed to `nodeDefaultUtils`
417
496
- `IHandleProps`: renamed to `NodeContentHandleProps`
418
497
- `NodeDimensions`: use `NodeContentProps<any>['nodeDimensions']`
4. Inside your applications folder: `yalc add @eccenca/gui-elements`
114
+
5. After updates to the gui elements rebuild and update the applications yalc folder: `yarn build:all && yalc publish --push` (you usually are not required to fire another `yalc add` in your applications folder)
115
+
116
+
After you tested the GUI elements package locally you can Clean up your applications folder by `yalc remove --all && git checkout -- pakage.json yarn.lock`.
115
117
116
118
### Process for pull requests and publishing releases
0 commit comments