@thegrocery/toolkit v2.9.1

Description

This is a toolkit repository for thegrocery organisation

CI/CD

We use act in order to test our workflows. Download the necessary binary, install it and run the below commands:

# If you want the agent to run on a different image
act -P ubuntu-22.04=ghcr.io/catthehacker/ubuntu:act-22.04 [push|pull_request]

# If you want to load secrets
act --secret-file=.secrets

# If you want to customize the github event [push|pull_request]
act -e=./event.json [push|pull_request]

# If you need to run a single job
act -j [jobName] [push|pull_request]

Storybook

• Interface Inventory - Brad Frost
• The Component Cut-Up Workshop - Nathan Curtis
• Storybook Design System
• Storybook 7 Docs

What I have learned?

• There are currently two ways to disable a control:
  • Use {[fieldname]: {table: {disable: true}}}
  • Use {parameters: {controls: {exclude: ['fieldName']}}}
  • If you want to disable controls globally, then you can achieve that using {parameters: {controls: {disable: true}}}
• If you want to document a component, use a JSDoc comment before the declaration of the meta object
• If you want to document a component property, pass the description property in the argTypes. e.g {argTypes: {[fieldName]: {description: 'something'}}}
• If you want to document a story, add a JSDoc comment before the story declaration
• If you want to configure storybook so it generates documentation for all components, then you need to update the main.ts file as below: {docs: {autodocs: true}}