Skip to content

keen/widget-customization

Repository files navigation

Widget Customization

written in typescript styled with prettier tested with jest Commitizen friendly yarn

The Widget Settings is an open source point-and-click interface used to setup visualization settings. It's maintained by the team at Keen IO.

Install

npm install @keen.io/widget-customization --save

or

yarn add  @keen.io/widget-customization

Build

The @keen.io/widget-customization use two step build to address issues with CSS specificity.

Typescript

First stage is responsible for transpilation Typescript code to esnext and emiting type declarations.

Babel

Second stage is responsible for code transpilation based on supported browserlist defined in package.json file and increasing styled-components css specificity by using plugins from .babelrc file. Generator functions transformations are disabled so applications that use this package should take care of it on their own.

npm scripts

List of useful commands that could be used by developers. Execution in the command-line interface should be prefixed with yarn package manager.

Command Description
lint run linter against current application codebase.
test run unit tests.
build builds application distribution.
prettier run code formatter process against current codebase.

commit

This project uses Conventional Commits to enforce common commit standards.

Command Description
npx git-cz run commit command line interface.