Skip to content

Development

Guidelines for working on Parametrig Kit

Set Up
#

Clone repository, install dependencies, and run docs site.

gh repo clone parametrig/kit
yarn
yarn dev

Adding Components
#

Scaffold a new component:

yarn gen:component

Export from src/index.ts to make available:

export { ComponentName } from './components'

Adding Icons
#

Add a .svg file to icons and run:

yarn gen:icons

All files in the icons directory are automatically converted to React components and exported for use. Generated icons should follow a 24x24 bounding box.

Publishing New Versions
#

Create a new release on GitHub with a tag that follows semantic versioning. Publishing a release triggers a workflow for building, testing, and pushing to npm.

Contributions
#

This repository is maintained by Parametrig. Treat changes to foundations and canonical components as design-system changes: update docs, tests, and component examples together.

Edit on GitHub