GUI elements based on other libraries, usable in React application, written in Typescript.
npm install @eccenca/gui-elementsCollection of React elements based on Palantir BlueprintJS and IBM Carbon, used for eccenca Corporate Memory applications.
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
- To include SCSS styles for all basic components add @import "~@eccenca/gui-elements/index"; into your main SCSS file.@eccenca/gui-elements/extensions
- To use extensions and special Corporate Memory components the include of and @eccenca/gui-elements/cmem is necessary@import "~@eccenca/gui-elements/src/configuration/variables;
- To include only the default configuration add into your SCSS file.
All configuration variables can be set before importing the full library or the default configuration but for the main properties you should need to change only a few parameters
#### Colors
Since v25 we use a color palette as basic foundation for color configurations. The palette is defined in 4 sections containing various color tints, each tint includes 5 different weights from 100 (light color) to 900 (dark color).
The default palette can be overwritten if it is defined before the configuration or full library is imported to your Sass styles. The palette need to be defined entirely, we currently don't support overwriting it partly.
`
$eccgui-color-palette-light: (
"identity": (
"brand": #fae1cc #f8cd99 #f6b966 #f4a533 #f29100,
"accent": #e5f4fb #aecfe3 #77abca #4186b2 #0a6199,
"text": #f8f8f8 #bcbcbc #818181 #434343 #090909,
"background": #fff #e8e8e8 #d6d6d6 #d4d4d4 #d3d3d3,
),
"semantic": (
"info": #e5f4fb #aecfe3 #77aaca #4086b2 #096199,
"success": #e8f5e9 #b2c6b4 #7c967e #466749 #103713,
"warning": #fff3e0 #fad2b3 #f5b287 #f0915a #eb702d,
"danger": #fff5f6 #edbfc0 #db8989 #c95253 #b71c1c,
),
"layout": (
"yellow": #fff6d5 #f1ecb5 #e3db79 #d4c93c #c1a500,
"purple": #f4ddf3 #c8a2d1 #9d6eb8 #71378f #480e75,
"magenta": #ffd8e8 #f5a6c3 #e276a4 #be4c80 #59122d,
"pink": #fde4f1 #e6b4ce #d08aae #bb5f8e #711c4d,
"violet": #f4e3f4 #d8b0d8 #b377b3 #904490 #570057,
"indigo": #efe4fb #b89ee0 #8f72c5 #6547aa #3b1e8f,
"cyan": #dff9fc #86d6e5 #5abfd4 #2da9c4 #0092b3,
"teal": #d4f2ec #a3ddd3 #6dc0b2 #479d8d #104c42,
"lime": #cde0d6 #bce3c2 #9dcd99 #7ba66c #87b347,
"amber": #ffe7b8 #ffe9c4 #f9cd8d #eeb757 #ef8f00,
"vermilion": #ffd8cc #e4c4ba #b27a6b #8c4b3a #651c09,
"grey": #f5f6f7 #b7b7b7 #808080 #484848 #1c2329,
),
"extra": (
"gold": #fff7d5 #ebd893 #dfc670 #d3b44e #c7a22b,
"silver": #f0f0f0 #dedede #ccc #bababa #a8a8a8,
"bronze": #fbe9db #f2d6bc #eac29d #e1af7e #d89b5f,
),
);
All palette colors will be transformed into CSS custom properties automatically and can be referenced by name scheme --eccgui-color-palette-{groupname}-{colortint}-{colorweight}, e.g. --eccgui-color-palette-identity-brand-100.
All other colors are based on the palette but it is still possible to set them before the default values are used by importing the configuration or the full library.
- $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
-
-
-
-
#### 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
- : white space between block level elements, currently only px is supported
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 branchdevelop
- : contains the latest state of development, feature/, bugfix/ and next branches will be merged into develop
- : 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 itlegacy
- : 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 functionalityfix/
- , bugfix/, hotfix/*: fix functionalityrelease/*
- : branches to finalize releases, also used to publish release candidate packageschange/
- , temp/, test/*: unspecific changes, maybe only created to test something that won't end necessarily in a PRmaintain/*
- : maintain dependencies, changes created in publishing process
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.
Run the Jest tests with yarn test, for test coverage information run yarn test:coverage.yarn compile
You can check easily code for code errors by (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.
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.Button.stories.tsx
If the stories and the tests share exactly the compononent name in the file names, e.g. 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:
`javascript`
Default.parameters = {
jest: "MyTestFile.test.tsx",
};
- Use a *Props suffix for component interfaces.*Utils
- Use a 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.
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:
5. After updates to the gui elements rebuild and update the applications yalc folder: (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.
1. feature/ and bugfix/ branches are merged into develop (or next and legacy) via pull requestrelease/*
- to test out specific features or bugfixes via npm packages, the can be pre-released by using the "Publish: feature/fix pre-release" action
2. branch is created from develop (or next and legacy) via "Create: release branch", there will be created a pull request automaticallymain
- publish release candidates from this release branch by triggering the "Publish: release candidate"
3. Pull request from release branch into need to be approvedmain
- then "Publish: final release " can be used on (or next and legacy`) to publish final release packages
- another PR is automatically created for changes done during publishing process
Apache License, Version 2.0, January 2004