@l3-lib/ui-core v0.0.59

L3 Design System

l3vels.xyz React components library - Storybook

Installation

Install the component library

$ npm install @l3-lib/ui-core

Usage

You can import from the main bundle:

import { Button } from "@l3-lib/ui-core";

or you might want to import directly the component from the dist folder

import Button from "@l3-lib/ui-core/dist/Button";

You also need to import Main CSS file to your project

import "@l3-lib/ui-core/dist/main.css"

Peer dependecies

We are relaient on React and React DOM, we are using them as externals and we don't package them to the package so you must have them in your project

Storybook

We are using storybook in order to develop the components independently from any consumer. run this to build & run the storybook locally:

npm run storybook

the storybook will be served on http://localhost:6006

Developing locally with your consumer application

When developing locally we are using a npm functionality called npm link, this allows us to work locally on our package and use it in a different project without publishing. This functionality basically overrides the npm mapping between package name to its repo, and points it to where the package is located locally.

Troubleshooting local development

• If you are using NVM, make sure both packages are using the same version.
• Because we are using react hooks and having react as a peerDependency - if you want to develop locally and encounter issues with "invalid hook call" See this github thread. The quick fix is in your webpack config file alias react to resolve the node_modules path

Go to the project's directory and run:

nvm use
npm unlink
npm link
npm start

Contributing

We welcome every contributor, please read the contribution guidelines before submitting a PR

Themes

We support theming from the library to the component level using css variables - for more info on theming please read the theme guidelines file

Release

Perform the following steps to release a new version:

• Bump the version in package.json
• Merge into origin/master
• Release the new version in the @l3-lib/ui-core