clearlineui
TypeScript icon, indicating that this package has built-in type declarations

0.10.0 • Public • Published

ClearlineUI

Clearline UI

Component library for Clearline HMO.


Setting Up

Clone the repo and install dependencies by running;

   yarn

After installation, serve storybook to view components and their documentation by running;

   yarn storybook

To test components, run;

   yarn test

Installing the latest version

To install this package in your React or NextJs project, run

   yarn add clearlineui

Contributing

New components are created at src/components/{component}/index.tsx and styles are created at src/components/{component}/{component}.css. Expose the new component and its type at src/components/index.ts as this will be the entry point for the package.

Expanding the ESLint configuration

If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:

  • Configure the top-level parserOptions property like this:
   parserOptions: {
    ecmaVersion: 'latest',
    sourceType: 'module',
    project: ['./tsconfig.json', './tsconfig.node.json'],
    tsconfigRootDir: __dirname,
   },
  • Replace plugin:@typescript-eslint/recommended to plugin:@typescript-eslint/recommended-type-checked or plugin:@typescript-eslint/strict-type-checked
  • Optionally add plugin:@typescript-eslint/stylistic-type-checked
  • Install eslint-plugin-react and add plugin:react/recommended & plugin:react/jsx-runtime to the extends list

Package Sidebar

Install

npm i clearlineui

Weekly Downloads

7

Version

0.10.0

License

none

Unpacked Size

3.44 MB

Total Files

52

Last publish

Collaborators

  • egdiala