@terminal-packages/ui
v2.2.12
Published
![Test Action Status](https://github.com/Terminal-Systems/fe-utils/workflows/Tests/badge.svg) ![Publish Action Status](https://github.com/Terminal-Systems/fe-utils/workflows/Publish/badge.svg?branch=master)
Downloads
60
Readme
FE-UI
UI Components based on M-UI
Installation
Install required dependencies:
npm install @fortawesome/fontawesome-svg-core@~1.2.0 @fortawesome/free-brands-svg-icons@~5.12.0 @fortawesome/free-solid-svg-icons@~5.12.0 @fortawesome/pro-light-svg-icons@~5.12.0 @fortawesome/pro-regular-svg-icons@~5.12.0 @fortawesome/pro-solid-svg-icons@~5.12.0 @fortawesome/react-fontawesome@~0.1.0 @material-ui/core@~4.8.0 @material-ui/icons@~4.5.0 @terminal-packages/fe-theme@~1.0.0 axios@~0.19.0 lodash@~4.17.0 moment@~2.24.0 moment-timezone@~0.5.0 prop-types@~15.7.0 react@~16.12.0 react-dom@~16.12.0
Then install @terminal-packages/ui
:
npm install @terminal-packages/ui
Usage
You can access the components like material-ui:
import { ComponentName } from '@terminal-packages/ui/core';
or
import ComponentName from '@terminal-packages/ui/core/ComponentName';
Available commands
build
: buildsrc
directorybuild:cjs
: buildsrc
directory usingcjs
modulesbuild:esm
: buildsrc
directory usingesm
modulesstorybook
: run storybook on port9001
clean
: deletecore
folderlint
: runeslint
onsrc
folderlint:fix
: run eslint in fixing mode onsrc
foldertest
: run tests
Note that our build
directory is called core
, that way you can publish the package and using it package-name/core/SomeComponent
like material-ui
peerDependencies
If you need to use a package that should be provided by your host app, please adding it as a peerDependencie
to avoid library duplications on node_modules
.
Important Note: peerDependencies
are not installed by npm install
or yarn install
. So in order to install peerDependencies
on dev environment you can add your required package as a peerDependencies
and devDependencies
. Otherwise, you can use a package like install-peers-cli