@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

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",
};

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: yalc publish --push
4. Inside your applications folder: yalc link @eccenca/gui-elements
5. After updates to the gui elements: yarn build:all && yalc push

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

[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