@eccenca/gui-elements - npm Package Versions

[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

[23.0.0] - 2022-11-18

Added

• <CodeEditor /> element based on CodeMirror library, supporting Markdown, Python, Sparql, SQL, Turtle and XML syntax
• <HoverToggler /> element that allows to switch elements when hovered over.
• <InteractionGate /> element that can wrap content that need to be blocked from user interactions, it also has options to display a spinner as overlay
• <Tree /> component
• <TabPanel /> component that can be used if <Tabs /> is used in uncontrolled mode.
• <ReactFlowMarkers /> custom markers for ReactFlow edges, currently one new marker arrowClosed-inverse available
• <StickyNoteNode />, usable by stickynote type in react flow editors for workflows and linking rules
• CssCustomProperties and getColorConfiguration utilities can be used to exchange color configurations between SCSS and JS
• decideContrastColorValue method to get a second color related to the lightness of the testes input color
• <SimpleDialog />: properties showFullScreenToggler and startInFullScreenMode
• <EdgeDefault />: new properties for the edge data
  • markerStart allows to add a marker to the edge starting point
  • inversePath allows to inverse the edge direction
  • renderLabel function to render fully custom edge label including any ReactNode
• <NodeContent />: property footerContent to add footer content to a react flow node
• <AutoSuggestion>: properties autoCompletionRequestDelay and validationRequestDelay, to configure the delay when a request is sent after nothing is typed in anymore.
• <FieldItemRow: property justifyItemWidths to display all children using equal width inside the row
• <BreadcrumbList />: properties ignoreOverflow and latenOverflow, that can be used to implement a second overflow strategy beside BlueprintJS overflow list, for example in case the overflow list leads to re-rendering loops
• <Spinner />: showLocalBackdrop property to include backdrop behind spinner making the background less visible
• <ContextMenu />: disabled property that disables the button to open the menu.
• <Tooltip />: properties markdownEnabler and markdownProps to enable better formatted tooltips with options for line breaks, etc.
• <AutoCompleteField />: onlyDropdownWithQuery property to prevent dropdown as long as the input field is empty
• large addition to the Storybook, we almost doubled available components and stories

Fixed

• allow children of <Accordion /> item to get calculated based on their DOM sizes
• add borders to CodeMirror editor area and include display of focused state
• GUI elements library can be now used easier in applications because it does not force usage of SCSS modules via JS/Webpack4
• fixed ReactFlow stories re-rerender on configuration change
• fix used font family and layout of <AutoSuggestion /> element, and justify it with the other single line text inputs
• fix condition to include the class name of a <TagList /> and set maximum width for the items
• fixed <MultiSelect /> to correctly update created items that are selected while still maintaining a cache of all newly created items
• do not change cursor to pointer by default on tooltip targets

Changed

• move style imports of CodeMirror layout to extensions
• color configurations for react flow editor are not exported as modules anymore, they need to be fetched by getColorConfiguration method in JS directly
• BlueprintJS was upgraded to a recent v4
  • elements were also upgraded to usage of Popover2, Tooltip2, Select2, MultiSelect2 and Breadcrumbs2
  • this comes also with a necessary switch from node-sass to sass package, a javascript port from the original dart sass library, see migration notes to update your build process
• <TextField /> and <AutoCompleteField /> now include a title attribute on the natively used input element to show the value if it is disabled or readOnly
• flashing color regarding the intent state of a <TextField />
• <AutoCompleteField />: Add 'hasBackDrop' parameter to use a backdrop for its popover in order for outside clicks to always close the popover. Default: false

Migration notes

• old { colors } imports for cmem/react-flow/configurations/* do not keep working anymore, use getColorConfiguration method now
• <IconButton>: tooltipOpenDelay was removed, use tooltipProps.hoverOpenDelay directly
• <FieldItem>: labelAttributes was renamed to labelProps
• <MenuItem>: this element now extends directly the Blueprint element, so internalProps was removed, use properties directly on MenuItem
• <AutoCompleteField>: popoverProps was renamed to contextOverlayProps
• <Button>: tooltipProperties was renamed to tooltipProps
• <ContextMenu>: use contextOverlayProps to route properties to the overlay element
• <Icon>: tooltipProperties was renamed to tooltipProps, tooltipOpenDelay was removed, use tooltipProps.hoverOpenDelay directly
• <Label>: tooltipProperties was renamed to tooltipProps
• <MultiSelect>: popoverProps was renamed to contextOverlayProps
• <Select>: popoverProps was renamed to contextOverlayProps
• <Tooltip>: this element now extends directly the Blueprint element, so tolltipProps was removed, use properties directly on Tooltip
• <BreadcrumbItem>: IBreadcrumbItemProps interface was renamed to BreadcrumbItemProps
• BreadcrumbList: IBreadcrumbListProps interface was renamed to BreadcrumbListProps

Switch from node-sass to sass

1. Remove node-sass and add sass package via npm or yarn:

   $ yarn remove node-sass && yarn add --dev sass
   

2. Include sass and our configuration

   const sass = require('sass');
   const sassRenderSyncOptions = require("@eccenca/gui-elements/config/sassOptions");
   

3. Configure the webpack sass-loader, you can extend this by options regarding the provided loader interface

   {
       loader: "sass-loader",
       options: {
           implementation: sass,
           sassOptions: sassRenderSyncOptions,
       },
   }