@selectquotelabs/sqform

SQ Form Library aims to offer reusable form components to unify the UI for all SelectQuote applications.

Usage no npm install needed!

<script type="module">
  import selectquotelabsSqform from 'https://cdn.skypack.dev/@selectquotelabs/sqform';
</script>

README

SQ Form Library

SQ Form Library aims to offer reusable form components to unify the UI for all SelectQuote applications.


Documentation

Visit https://selectquotelabs.github.io/SQForm/docs/

Viewing the Storybook

The latest version of the SQForm Library Storybook can be viewed here.

Contributing

When you make changes to this repo, you must adhere to the Conventional Commit standard.

If you are unfamiliar with writing Conventional Commit style messages, you can use the commitizen to guide you through creating the commit message

git add .
npm run commit

The commit will be validated through a linter pre-commit hook and will reject any commit messages that do not properly adhere to the convention.

Conventional Commit formatted messages are required for proper versioning and automatic generation of release notes / CHANGELOG. Currently, only feat and fix will bump the version.

Your first commit should use the type relevant to what you're working on, e.g., feat or fix, then if you receive feedback in a PR requiring another commit, choose chore; this will prevent those extra commits cluttering the changelog.

For BREAKING CHANGES Type a brief description of the breaking change when asked if there is a breaking change. Otherwise, press the ENTER key to skip over the breaking change optional question.

  • A breaking change will cause a MAJOR SemVer bump. Ex: 3.0.5 -> 4.0.0

Consuming

  • > npm install @selectquotelabs/sqform

Migration from SC+ Shared Components Library

  • > npm install @selectquotelabs/sqform

  • Update all SQForm related imports from scplus-shared-components to @selectquotelabs/sqform

  • SQDialogForm was renamed to SQFormDialog (fix where imported)

  • SQDialogStepper was renamed to SQFormDialogStepper (fix where imported)

  • SQDialogStep was renamed to SQFormDialogStep (fix where imported)

Initial Setup

Coming Soon...

Development

To get started first install the projects dependencies

$ npm install

It's recommended to use the Node version specified in the .nvmrc file. If you have nvm installed execute the following terminal command:

$ nvm use

Note: If you run nvm use and don't have that version of Node installed, nvm will tell you how to install it

Running Storybook locally

$ npm run storybook

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.