@docflow/component-library
TypeScript icon, indicating that this package has built-in type declarations

9.3.0 • Public • Published

Docflow UI Component Library

npm Storybook

Develop

We use pnpm v8 to manage dependencies.

Start the Storybook for development:

pnpm i
pnpm dev

Publish

It's going to publish automatically when you merge something to main:

  • If the string "BREAKING CHANGE" is found anywhere in any of the commit messages or descriptions the major version will be incremented.
  • If a commit message begins with the string "feat" then the minor version will be increased. This works for most common commit metadata for feature additions: "feat: new API" and "feature: new API".
  • All other changes will increment the patch version.

If you don't want to trigger a release, put a [skip release] anywhere in your commit message (preferably, the second line).

Add new icons

  1. Go to Figma and select all 4 weight variants of the icon you want to export
  2. In the Export settings, specify the suffix of an underscore and the camel-cased filename of the icon you're exporting (e.g. the suffix should be _arrowRight for the icon called arrow.right)
  3. If you're exporting multiple icons, repeat steps 1 and 2 for each icon
  4. Place the exported files in the resources/icons folder
  5. Run node scripts/1-adaptIcons.mjs to rename the icons automatically
  6. Run node scripts/2-cleanIcons.mjs to clean up the icons and set internal colors correctly
  7. Commit!

Readme

Keywords

none

Package Sidebar

Install

npm i @docflow/component-library

Weekly Downloads

213

Version

9.3.0

License

none

Unpacked Size

3.67 MB

Total Files

775

Last publish

Collaborators

  • illright
  • melihkorkmaz_docflow
  • stomescu
  • oche