Repository files navigation

• yarn v3.8.2. Followinstallation guide

First, install the dependencies:

yarn install

Storybook is used for development, run it using command:

yarn storybook

or

yarn dev

For more details checkCONTRIBUTING.md guide.

Make sure to exportcomponents andsubcomponents so they are displayed in theDocs tab.

exportdefault{title:'List & tables/Assets table',component:AssetsTable,subcomponents:{    TokenProfile,    TokenAmount,    MarketPrice,}}asMeta;

Adding a new or updating existing icons require:

1. Add svg icon tosrc/icons/raw directory.
2. Runbuild:icons command (It will generate tsx components insrc/icons directory and updatesrc/icons/index.ts)

yarn build:icons

3. Commit all added and modified files.

To use icon in this project import it using lookup location@icons/

import AdaComponent from '@icons/AdaComponents';

To use icon in dependent project import it like this

import { AdaComponent } from '@input-output-hk/lace-ui-toolkit';

We recommend usingyalc for linking a package from your local development environment to another project. This is particularly helpful when developing multiple packages that depend on each other and you want to test changes in real time without needing to publish the package to a registry.

If you work with projects using different package managers like npm, yarn, or pnpm the recommended approach is to use yalc, as it work across different package managers. You can easily link yarn based repository likeLace UI Toolkit to npm, yarn, or pnpm repositories in the same time.

1. Install dependencies:yarn install
2. Build projectLace UI Toolkit:yarn build
3. Publish to yalc:yalc publish
4. LinkLace UI Toolkit to dependent project:yalc link @input-output-hk/lace-ui-toolkit
5. Update package in dependant project after each published build:yalc update @input-output-hk/lace-ui-toolkit
6. Once development done unlinkLace UI Toolkit:yalc remove @input-output-hk/lace-ui-toolkit

1. Install dependencies:yarn install
2. Watch for changes and build, publish and push updates:yarn watch:pub
   • yarn watch:pub uses commandsyarn build --watch andyalc push.
   • yalc push is alias foryalc publish --push. Push will auto updateLace UI Toolkit in all linked projects.
3. Navigate to dependent project and linkLace UI Toolkit:yalc link @input-output-hk/lace-ui-toolkit
4. Once development done unlinkLace UI Toolkit:yalc remove @input-output-hk/lace-ui-toolkit

• yalc link @input-output-hk/lace-ui-toolkit: LinkLace UI Toolkit with other projects
• yalc remove @input-output-hk/lace-ui-toolkit: UnlinkLace UI Toolkit from other projects
• yalc installations show @input-output-hk/lace-ui-toolkit: List all projects linking toLace UI Toolkit
• yalc publish: Publish package to yalc's registry
• yalc update @input-output-hk/lace-ui-toolkit: UpdateLace UI Toolkit in dependent project
• yalc push oryalc publish --push: Publish package to yalc's registry and auto update dependant projects