@eccenca/gui-elements

eccenca GUI elements

Collection of React elements based on Palantir BlueprintJS and IBM Carbon, used for eccenca Corporate Memory applications.

Usage

Installation

We provide a package via npmjs registry, install it by:

yarn add @eccenca/gui-elements

It could be also included as Git submodule to your projects and used via yarn link or yarn workspaces.

As long as IBM Carbon does not support TypeScript it is necessary to install @types/carbon-components-react as development dependency:

yarn add --dev @types/carbon-components-react

Inclusion

• To include SCSS styles for all basic components add @import "~@eccenca/gui-elements/index"; into your main SCSS file.
• To use extensions and special Corporate Memory components the include of @eccenca/gui-elements/extensions and @eccenca/gui-elements/cmem is necessary
• To include only the default configuration add @import "~@eccenca/gui-elements/src/configuration/variables; into your SCSS file.

Configuration

All configuration variables can be set before importing the full library or the default configuration but for the main changes you should need to change only a few parameters:

• Basic colors
  • $eccgui-color-primary: color for very important buttons and switches
  • $eccgui-color-primary-contrast: readable text color used on primary color areas
  • $eccgui-color-accent: color for most conformation buttons, links, etc
  • $eccgui-color-accent-contrast: readable text color used on accent color areas
  • $eccgui-color-applicationheader-text
  • $eccgui-color-applicationheader-background
  • $eccgui-color-workspace-text
  • $eccgui-color-workspace-background
• Basic sizes
  • $eccgui-size-typo-base: size including absolute unit, currently only px is supported
  • $eccgui-size-typo-base-lineheight: only ratio to font size, no unit!
  • $eccgui-size-type-levelratio: ratio without unit! used to calculate different text sizes based on $eccgui-size-typo-base
  • $eccgui-size-block-whitespace: white space between block level elements, currently only px is supported

Development

Branch management

We have 4 types of major branches representing the current state:

• main: contains the latest official release, only release/* branches will be merged into this branch
• develop: contains the latest state of development, feature/*, bugfix/* and next branches will be merged into develop
• next: development tree for an upcoming new major version, it will be merged into develop at some point, feature/*, bugfix/* and release/* branches will be merged into it
• legacy: development tree for the predecessor of the current major version, only bugfix/* and hotfix/* branches will be merged into it

We allow a few more prefixes for valid branchnames:

• feature/*: extend functionality, maintain dependencies
• fix/*, bugfix/*, hotfix/*: fix functionality
• release/*: branches to finalize releases, also used to publish release candidate packages
• change/*, temp/*

next and legacy only exist if necessary, otherwise we do not maintain those branches. Merges into main, develop, next and legacy are always managed by pull requests.

Running tests

Run the Jest tests with yarn test, for test coverage information run yarn test:coverage. You can check easily code for code errors by yarn compile (JS/Typescript) and yarn compile-scss (SASS).

If you run Jest tests in your app using our library you need to install @babel/plugin-transform-runtime as development dependeny and add it to your Babel plugins configuration.

Running Storybook

All story source files are kept in the respective components, extensions and cmem folders, using *.stories.tsx file name pattern. Run the storybook by

yarn install
yarn storybook

If you want to include Jest test results into the Storybook, run yarn test:generate-output before yarn storybook. If the stories and the tests share exactly the compononent name in the file names, e.g. Button.stories.tsx and Button., then tests are included automazically when the test output is available. In case the file names cannot match by pattern then test file names need to be configured in the stories:

Default.parameters = {
    jest: "MyTestFile.test.tsx",
};

Naming conventions

• Use a *Props suffix for component interfaces.
• Use a *Utils suffix for objects providing helper functions to compoents. Name should start with a lowercase letter.

Don't forget to export them. They need to be available via simple import from @eccenca/gui-elements.

Example: if you have your SimpleComponent then provide at least SimpleComponentProps, maybe simpleComponentUtils.

Use via yalc

If necessary you can use yalc to develop gui elements and your application side by side.

1. Install yalc globally via npm or yarn
2. Checkout @eccenca/gui-elements
3. Inside gui elements folder: yarn build:all && yalc publish --push
4. Inside your applications folder: yalc add @eccenca/gui-elements
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)

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.

Process for pull requests and publishing releases

1. feature/* and bugfix/* branches are merged into develop via pull request
2. release/*branch is created from develop via GitHub interface, there will be created a pull request automatically
   • publish release candidates from this release branch by manual usage of a GitHub workflow
3. PR from release branch into main need to be approved
   • this will lead to a published package of the release

License

Apache License, Version 2.0, January 2004

Changelog

[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!