@eccenca/gui-elements
Advanced tools
Changelog
[23.6.0] - 2024-04-17
<BreadcrumbList/>, <MultiSuggestField/>, <Notification/>, <Select/>, <Tabs/>
data-test-id (and data-testid as alias of it): can be defined to add test ids to the DOM elementswrapperProps: can be defined by using div attributes, and if given a div element with wrap the component. This wrapper is also used for test ids because the underlaying BlueprintJS components do not forward data attributes to the DOM.<Select/> or <MultiSuggestField/> then the toggle button, the dropdown and the search filter get automatically their own test id, suffixed by _togger, _drowpdown and _searchinput.<CodeMirror />:
<Modal/>, <SimpleDialog/>, <AlertDialog/>
data-test-id (and data-testid as alias of it): can be defined to add test ids to the DOM elements<MultiSuggestField />
selectedItems can be used to set default selected itemsuseApplicationHeaderOverModals: forces the application header to be displayed over modal backgroundsClassNames now forwards all BlueprintJS CSS class names
import { ClassNames } from "@eccenca/gui-elements";
export const bpButtonClass = ClassNames.Blueprint.BUTTON;
state-locked, state-unlocked, application-notification<Card />
selected=true, allow it without interactive functionality on card element<MultiSuggestField />
disabled property is set<TagList />
<ApplicationContainer />
<OverlaysProvider /> from BlueprintJS is now used<Tag />
<Button />
AnchorOrButtonProps is currently exported together with the component but it will be removed with the next major versionButtonProps should be enough<BreadcrumbList/>
htmlUlProps: this is going to be removed because the BlueprintJS Breadcrumbs component does not support native ul attributes. The element provides a new wrapperProps property.<MultiSuggestField />
data-test-id="clear-all-items" for the clearance button is deprecated, will be replaced by a test id later that is created from the given test id for the component plus a _clearance suffixReadme
Collection 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
@import "~@eccenca/gui-elements/index"; into your main SCSS file.@eccenca/gui-elements/extensions and @eccenca/gui-elements/cmem is necessary@import "~@eccenca/gui-elements/src/configuration/variables; into your SCSS file.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:
$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$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 supportedRun 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.
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",
};
*Props suffix for component interfaces.*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.
If necessary you can use yalc to develop gui elements and your application side by side.
yalc publish --pushyalc link @eccenca/gui-elementsyarn build:all && yalc pushfeature/* and bugfix/* branches are merged into develop via pull requestrelease/*branch is created from develop via GitHub interface, there will be created a pull request automatically
main need to be approved
Apache License, Version 2.0, January 2004
FAQs
GUI elements based on other libraries, usable in React application, written in Typescript.
The npm package @eccenca/gui-elements receives a total of 99 weekly downloads. As such, @eccenca/gui-elements popularity was classified as not popular.
We found that @eccenca/gui-elements demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.