@eccenca/gui-elements - npm Package Versions

[24.0.0] - 2024-12-17

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.

Migration from v23 to v24

• upgrade Typescript to v5
• upgrade Node to at least v18, see Changed section for more info about it
• 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
  • <GridColumn/>
    • 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
  • <Notification/>
    • fullWidth: was deprecated and now removed, use flexWidth as replacement
    • iconName: was deprecated and now removed, use icon property
  • <Table/>
    • size: use only "small", "medium" or "large" as value
  • <Tag/>
    • emphasized: was deprecated and now removed, use minimal=false plus emphasis="stronger" instead
  • IconSized type: use CarbonIconType
  • TimeUnits type: use ElapsedDateTimeDisplayUnits
  • MarkdownParserProps interface: use MarkdownProps
  • elapsedTimeSegmented function: use elapsedDateTimeDisplayUtils.elapsedTimeSegmented
  • simplifiedElapsedTime function: use elapsedDateTimeDisplayUtils.simplifiedElapsedTime

Added

• <StringPreviewContentBlobToggler />:
  • 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.
• <MultiSuggestField />
  • An optional custom search function property has been added, it defines how to filter elements.
  • Added a prop limitHeightOpened to limit the height of the dropdown by automatically calculating the available height in vh.
• <FlexibleLayoutContainer /> and <FlexibleLayoutItem />
  • helper components to create flex layouts for positioning sub elements
  • stop misusing Toolbar* components to do that (anti pattern)
• <PropertyValueList /> and <PropertyValuePair />
  • singleColumn property to display label and value below each other
• <Label />
  • emphasis property to control visual appearance of the label text
• basic Storybook example for <Application* /> components
• <CodeEditor />
  • setEditorView option for compatibility to Codemirror v6
  • supportCodeFolding optional property to fold code for the supported modes e.g: xml, json, etc.
  • shouldHighlightActiveLine optional property to highlight active line where the cursor is currently in.
  • shouldHaveMinimalSetup optional property that imports codemirror's base minimal configurations.
  • additionalExtensions optional property for additional extensions to customize the editor further.
• <Markdown />
  • htmlContentBlockProps can now be used to configure the wrapper around the Markdown content
• $eccgui-selector-text-spot-highlight SCSS config variable to specify selector that is used to create shortly highlighted spots
  • it is highlighted when the selector is also active local anchor target or if it has the .eccgui-typography--spothighlight class attached to it

Fixed

• toggling on/off the <HandleTools/> was corrected, they kept displayed after re-entering with the cursor
• <Pagination/>
  • change text overflow for selectors to clip because Firefox rendered ellipsis a bit too early
• <ApplicationContainer />:
  • useDropzoneMonitor helper hook process was improved so that less events are processed and the dropzone monitoring is more stable

Changed

• GUI elements library needs node 18 or an higher version because dependencies were upgraded
  • you may run into problems if you try it with Node v16 or v17, or Webpack v4, mainly because of a Node bugfix regarding the OpenSSL provider
  • if you cannot upgrade your dependencies then you could workaround that by patching the crypto package or using Node with --openssl-legacy-provider option
  • see https://github.com/webpack/webpack/issues/14532 and https://stackoverflow.com/questions/69692842/ for more info and possible solutions
• upgrade to @carbon/react package
  • almost all Carbon related packages were replaced by using only @carbon/react
  • some component interfaces partly lack documentation in our Storybook because their base interfaces from @carbon/react are currently not exported: AccordionItemProps, ApplicationHeaderProps, ApplicationToolbarProps, ApplicationToolbarActionProps, ApplicationToolbarPanelProps, CarbonIconType, TableCellProps, TableExpandRowProps, TableProps
• upgrade to Typescript v5
  • your package should be compatible to Typescript 5 patterns
• upgrade to Storybook v8
  • 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
• allow next and legacy as branch names
• <CodeEditor />
  • setInstance interface changed to setEditorView for semantic compatibility to Codemirror v6
• <BreadcrumbItem/>
  • link color and separation char were adjusted
• <Markdown/>
  • align blocks for language specific code to default code blocks
• switch icons for item-clone and item-copy to Carbon's <Replicate/> and <Copy/>
• Remove duplicated icon names artefact-customtask* and only keep artefact-task* names.
• <OverviewItemDepiction/>
  • improve examples in storybook
  • improve display for images that are to large for the available space (fully show them)
• <CodeAutocompleteField />:
  • Add parameter reInitOnInitialValueChange, to allow the field to re-initialize if the initial value changes.

Deprecated

• <Icon/> and <TestIcon/>
  • description and iconTitle: use title as replacement.
• TableRowHeightSize type: use TableProps["size"] directly
• IRenderModifiers interface: use SuggestFieldItemRendererModifierProps
• IElementWidth type: use SuggestFieldItemRendererModifierProps["styleWidth"]
• MultiSelectSelectionProps interface: use MultiSuggestFieldSelectionProps
• MultiSelectProps interface: use MultiSuggestFieldProps
• nodeTypes and edgeTypes
  • will be removed without replacement, define it yourself or use <ReactFlow/ with configuration option
• AutoCompleteFieldProps and IAutoCompleteFieldProps interfaces: use SuggestFieldProps
• <CodeAutocompleteField/>
  • AutoSuggestionProps: use CodeAutocompleteFieldProps instead
  • we renamed ISuggestionBase, ISuggestionWithReplacementInfo, IReplacementResult, IPartialAutoCompleteResult, IValidationResult to CodeAutocompleteFieldSuggestionBase, CodeAutocompleteFieldSuggestionWithReplacementInfo, CodeAutocompleteFieldReplacementResult, CodeAutocompleteFieldPartialAutoCompleteResult, CodeAutocompleteFieldValidationResult
• all legacy support components are going to be removed, you need to replace them by activily maintained components
  • <ButtonReplacement/>: switch to <Button />
  • <AffirmativeButtonReplacement/>: switch to <Button affirmative />
  • <DismissiveButtonReplacement/>: switch to <Button dismissive />
  • <DisruptiveButtonReplacement/>: switch to <Button disruptive />
  • <CheckboxReplacement/>: switch to <Checkbox />
  • <RadioButtonReplacement/>: switch to <RadioButton />
  • <TabsReplacement/>: switch to <Tabs />
  • <TextFieldReplacement/>: switch to <TextField />, <TextArea />, <FieldItem />
• MultiSuggestField.ofType method:
  • instead of MyMultiSuggest = MultiSuggestField.ofType<MyType>() use directly <MultiSuggestField<MyType> {...props} />
  • MultiSuggestField.ofType also returns the original BlueprintJS MultiSelect element, not our version!

[23.5.0] - 2024-02-15

Added

• <CodeEditor />
  • visualize the usage of tabulator chars by background color and arrow symbol
  • new tabIntentSize, tabIntentStyle, tabForceSpaceForModes properties to give better control over tabulator usage

Fixed

• <Depiction />
  • images representing SVG without width property on their root element are displayed with a minimal forced dimension to prevent that they are hidden in some browsers

[23.4.1] - 2024-02-08

Fixed

• icons
  • use older version of icon library to prevent typescript issues after changes in recent versions

[23.4.0] - 2024-02-07

Added

• <PropertyValuePair />, <PropertyName />, <PropertyValue />
  • nowrap: force display on one line without breaks
• <Skeleton />
  • provides a loading state display of its children elements
• <TableCell />
  • alignHorizontal: allow to center cell contents
• <ActivityControlWidget />
  • added extra line to show timer for execution period
• <ExtendedCodeEditor />
  • replaces <SingleLineCodeEditor /> to get used for the <CodeAutocompleteField /> component
• new icons
  • data-string, data-url, data-date, data-time, data-datetime, data-number

Fixed

• <Pagination />
  • adjust color of arrow in disabled navigation button

[23.3.1] - 2023-11-15

Fixed

• <ContextOverlay />
  • remove always white space at start of portalClassName to prevent runtime error in BlueprintJS

[23.3.0] - 2023-11-09

Added

• <PropertyName />
  • labelProps: configure the automatically injected Label element when PropertyName is only a string
• <TextField />
  • escapeToBlur: if set to true the input field blurs/de-focuces when the Escape key is pressed.
• <CodeEditor />
  • support for additional modes: jinja2, yaml and json
  • add read-only mode
  • height: set a fixed height of the editor
  • wrapLines: control auto-wrapping long lines (the default for wrap long lines is set to false now)
• <Modal />
  • modalFocusable: when true the outer div element of the modal can be focused by clicking on it. This is needed e.g. when key (down, up) events should trigger on the modal in order to bubble up to its parent elements.
  • forceTopPosition: when true then the z-index of the modal's portal element is recalculated, so that the modal is always displayed on top of all other visible elements. Use with care, see documentation.
• <ContextOverlay />
  • preventTopPosition: when true then the z-index is decreased to the value for modals. Use it when you need to display modal dialogs out of the context overlay. Type of counter property to Modal.forceTopPosition.
• <ReactFlow />
  • support disabling the react-flow hot keys via a React context, e.g. Delete etc.
• <HandleDefault />
  • new category options that lead to different handle layouts: dependency, fixed, flexible and unknown
  • intent option with defined colors for: primary, accent, info, success, warning, danger
• <HandleTools />
  • can be used as single handle content to add an context menu to handles
• <NodeContent />
  • introductionTime: can be used to visualize the node was added or updated
• <EdgeLabel />
  • loose: can be set to true to prevent the box with border on the label component
• <TableExpandHeader />
  • toggleIcon: optional icon that should be displayed instead of the default ones.
• utils
  • 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!
• canonical icons for artefact-chatlog, entity-human, entity-robot and operation-magic

Changed

• <SimpleDialog />
  • by default, prevent certain (React) events from bubbling up through the dialog (backdrop is not affected):
    • event handler: onContextMenu, onDrag, onDragStart, onDragEnd, onMouseDown, onMouseUp, onClick
    • handlers can be overwritten via wrapperDivProps
• <ApplicationHeader />
  • it is now possible to overwrite the background color by setting --eccgui-appheader-color-background in its style attribute
• <Modal />
  • new xlarge size option
  • re-configure appearance of the sizes, small is displayed a bit smaller, large a bit larger than before

Fixed

• <Modal />
  • Escape key to close does not work anymore after clicking on the backdrop for canOutsideClickClose=false and canEscapeKeyClose=true.
• <Spacing />
  • allow other div attributes, e.g. style
• tooltips of Carbon based elements are displayed correctly in position and layout
• <PropertyValuePair />
  • force maximum width for situation when the block could be wider, e.g. inside a flex layout, otherwise name and value could be wrongly aligned in a list with other property value pairs

[23.2.0] - 2023-07-14

Added

• linting the code automatically via git hook on commit action
• <SuggestField />
  • will replace <AutoCompleteField />
  • match dropdown to element width when fill=true
  • display dropdown toggler when onlyDropdownWithQuery=false
• <MultiSuggestField />: will replace <MultiSelect />
  • clearQueryOnSelection option to set an empty query after selections
  • match dropdown to element width when fullWidth=true
• <CodeAutocompleteField />: will replace <AutoSuggestion />
• <Select />:
  • has now a default target when it is not controlled directly by its children
  • onClearanceHandler and onClearanceText as options to include automatically a dedicated clearance button to the element
• <PropertyName />
  • size option to increase/decrease width consumed by its display
• <EdgeLabel />: use title property on its text sub element
• <Application* /> elements now have defined and exposed interfaces
• <FieldSet /> element now have a defined and exposed interface
• <PropertyValue* /> elements now have defined and exposed interfaces
• <GridColumn />
  • carbonSizeConfig property to overwrite automatically set column sizes by using the original size config from the Carbon component
• <TitleSubsection /> element now have a defined and exposed interface
• all inferfaces of the main elements in src/components are now exposed via @eccenca/gui-elements
• all inferfaces of the main elements in src/extensions are now exposed via @eccenca/gui-elements
• all inferfaces of the main elements in src/cmem are now exposed via @eccenca/gui-elements
• <ApplicationToolbarPanel />
  • event handler onLeave and onOutsideClick, could be used to close the menu panel automatically

Changed

• <Select />:
  • match dropdown to element width when fill=true
  • use rounded input for query input to align it with <SearchField />
• Upgraded dependencies
  • BlueprintJS was upgraded to the recent version (and a few method calls fixed after)
  • Carbon was upgraded to the recent version
  • almost all other dependencies were upgraded to their recent minor and major versions
• Removed dependencies
  • package-json-validator (not maintained anymore and disfunctional) - so currently there is not automatic check and validation of the package.json file
  • eslint, eslint-config-react-app, @typescript-eslint/eslint-plugin, @typescript-eslint/parser - not directly necessary, they may be still installed by other sub packages
• Changed version resolutions
  • set postcss to at recent version to fix a moderate security vulnerability
  • remove resolutions for node-gyp, glob-parent, trim, trim-newlines, minimist - packages are not use, or resolution is not necessary anymore
• <ActivityControlWidget />
  • IActivityAction interface was renamed to ActivityControlWidgetAction
• <AutoSuggestion />
  • IProps interface was renamed to AutoSuggestionProps
• <AutoSuggestionList />
  • IDropdownProps interface was renamed to AutoSuggestionListProps
• <MultiSelect />
  • SelectedParamsType interface was renamed to MultiSelectSelectionProps
• <SingleLineCodeEditor />
  • IEditorProps interface was renamed to SingleLineCodeEditorProps
• <AlertDialog />
  • IAlertDialogProps interface was renamed to AlertDialogProps
• <WorkspaceHeader />
  • IWorkspaceHeaderProps interface was renamed to WorkspaceHeaderProps
• <NodeDefault />
  • NodeProps interface was renamed to NodeDefaultProps to justify naming convention
• <NodeContent />
  • IHandleProps interface was renamed to NodeContentHandleProps to justify naming convention
• Utilities obejct was renamed to utils and enhanced with new functions: getColorConfiguration, invisibleZeroWidthCharacters
• improve style imports, now it is a bit easier to inlcude all parts separately
• <IconButton />
  • prevent double tab index when it comes with an extra tooltip element attached to it
  • prevent tooltip tab selection when button is disabled or has set inactive tabindex itself
• <SimpleDialog />
  • enforceFocus: false is set by default, so that searchable selects keep focus on their search input field

Fixed

• use correct import for codemirror stylesheetss
• <BreadcrumbItem /> is not displayed clickable when it has no href or onClick property set

Deprecated

• Select.ofType method:
  • instead of MyTypeSelect = Select.ofType<MyType>() use directly <Select<MyType> {...props} />
• <AutoCompleteField />: use <SuggestField />
• <MultiSelect />
  • SelectedParamsType: renamed to MultiSelectSelectionProps
  • element will be re-implemented, use <MultiSuggestField /> instead
• Utilities object is now deprecated, use utils instead
• HelperClasses object is now deprecated, use ClassNames instead
• <ActivityControlWidget />
  • IActivityAction: renamed to ActivityControlWidgetAction
• <AutoCompleteField />
  • IRenderModifiers: import from src/components/AutocompleteField/interfaces
  • IElementWidth: import from src/components/AutocompleteField/interfaces
• <AutoSuggestion />
  • elemenat was renamed, use <CodeAutocompleteField /> instead
  • IProps interface is now deprecated, use CodeAutocompleteFieldProps instead
• <AutoSuggestionList />
  • IDropdownProps interface is now deprecated, use AutoSuggestionListProps instead
• <SingleLineCodeEditor />
  • IEditorProps interface is now deprecated, use SingleLineCodeEditorProps instead
• <AlertDialog />
  • IAlertDialogProps interface is now deprecated, use AlertDialogProps instead
• <WorkspaceHeader />
  • IWorkspaceHeaderProps interface is now deprecated, use WorkspaceHeaderProps instead
• <NumericInput />
  • 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.
• <Highlighter />
  • HighlighterFunctions renamed to highlighterUtils
  • extractSearchWords moved to highlighterUtils.extractSearchWords
  • matchesAllWords moved to highlighterUtils.matchesAllWords
  • createMultiWordRegex moved to highlighterUtils.createMultiWordRegex
• <Icon />
  • findExistingIconName: use iconUtils.findExistingIconName
• <Spinner />
  • SpinnerPosition: use SpinnerProps['position']
  • SpinnerSize: use SpinnerProps['size']
  • SpinnerStroke: use SpinnerProps['stroke']
• ReactFlow extensions
  • NodeProps: renamed to NodeDefaultProps
  • minimapNodeClassName: moved to miniMapUtils.nodeClassName
  • minimapNodeColor: moved to miniMapUtils.nodeColor
  • nodeUtils: renamed to nodeDefaultUtils
  • IHandleProps: renamed to NodeContentHandleProps
  • NodeDimensions: use NodeContentProps<any>['nodeDimensions']
  • HighlightingState: use NodeContentProps<any>['highlightedState'] (or import from src/extensions/react-flow/nodes/sharedTypes)
• ActivityControl components:
  • IActivityControlLayoutProps: renamed to SilkActivityControlLayoutProps
  • IActivityExecutionReport: renamed to SilkActivityExecutionReportProps
  • ActivityControlTranslationKeys: renamed to SilkActivityControlTranslationKeys
  • ActivityAction: renamed to SilkActivityControlAction
  • IActivityControlProps: renamed to ActivityControlWidgetProps
  • IActivityStatus: renamed to SilkActivityStatusProps
  • ConcreteActivityStatus: renamed to SilkActivityStatusConcrete
• ContentBlobToggler components:
  • firstNonEmptyLine: moved to stringPreviewContentBlobTogglerUtils.firstNonEmptyLine
• Markdown components:
  • highlightSearchWordsPluginFactory moved to markdownUtils.highlightSearchWordsPluginFactory

[23.1.0] - 2023-04-20

Added

• <Badge /> element
  • add more context like icons, text or numbers to another element
  • <Button /> and <IconButton /> now have a badge property for simple attachment
• <ConfidenceValue/> element
  • combines a value and a bar
• <Depiction /> element
  • include different types of images controlling of resizing, ratio, shape
• <EdgeLabel /> (react flow) element
  • can be used for custom edge labels, provides support for depiction, text, actions and intent states
• <Table />, <TableExpandHeader />, <TableRow />, <TableExpandRow /> and <TableCell /> elements
  • Carbon based elements
  • other table elements are still used directly from the Carbon library
• <TestIcon />: test icons without the need to define them via a canonical name before.
• <Card /> property
  • whitespaceAmount: controls how much whitespace is displayed within the card subelements
• <CardContent /> (react flow) property
  • noFlexHeight: changes the behaviour how the component uses the remaining space inside the Card element
• <Divider /> properties
  • width: width of the horizontal rule
  • alignment: horizontal alignment of the horizontal rule
• <EdgeDefault /> (react flow) properties
  • strokeType: overwrites the default style how the edge stroke is displayed
  • intent: visual feedback about the current state of the edge
  • highlightColor: color(s) of used highlights to mark the edge
• <Markdown /> property
  • linkTargetName: browser target name to open links from the Markdown content
• <MultiSelect /> property
  • requestDelay: To delay requests on query changes and only fire the most recent request.
• <NodeContent /> (react flow) properties
  • leftElement: any element that should be displayed before the node label
  • labelSubline: displayed under the label in the header
  • fullWidth: stretches the node to the full available width, e.g. when used outside React Flow context
  • enlargeHeader: increase hight of header
  • border: property to overwrite default styles
  • intent: visual feedback about the current state of the node
  • highlightColor: color(s) of used highlights to mark the node, together with intent it replaces highlightedState
• <Pagination /> property
  • hideBorders: element is displayed without dividing borders
• <Tag /> property
  • add support for intent property
• <TextField /> and <TextArea /> property
  • invisibleCharacterWarning: callback to warn of invisible, hard to spot characters in the input text.
  • intent: state of the text field
• <ReactFlow /> property
  • scrollOnDrag: Support to scroll the pane when going beyond the pane borders on all drag and connection operations.
• <SilkActivityControl /> property
  • executePrioritized that is executed when the 'start prioritized' button is clicked while an activity is waiting for execution.
• <WhiteSpaceContainer /> property
  • linebreakForced: insert line breaks within an otherwise unbreakable string to prevent text from overflowing the container

Changed

• use option --outputCss for yarn compile-scss to get the transpiled CSS echoed out
• upgrade to Carbon icons v11
• switch from carbon-components to @carbon/styles
• <GridRow /> property dontWrapColumns=true only works for grids on medium sized and larger viewports
• <NodeContent /> animation is now displayed on the border, not by a pulsing shadow anymore
• <NodeDefault />, <NodeContent /> and <HandleDefault /> support now React Flow 9 and 10

Fixed

• <WorkspaceContent />: do not prevent wrapping the columns of the included grid
• <SingleLineCodeEditor />: Convert multi-line initial value to a single line value.
• <MenuItem />: do not display empty icon wrapper.
• <MultiSelect />: Requests e.g. on slow networks could get mixed up, resulting in not showing the most recent results.

Deprecated

• <Grid /> property fullWidth is now deprecated as grids are always used for the full viewport width
• <NodeContent /> property highlightedState is replaced by intent and highlightColor and should not be used anymore
• <CardHeader /> properties densityHigh and hasSpacing are now deprecated, use Card.whitespaceAmount now
• <TextField /> properties hasStatePrimary, hasStateSuccess, hasStateWarning and hasStateDanger are now deprecated, use intent now