@system76/forms
System76 Vue components for forms
This repository contains all the System76 form Vue components including buttons, inputs, and labels. It also holds client side validation logic.
Using
npm install --save-dev @system76/forms
Tips
- You will need to include the stylesheets for this package, as well as for
@system76/design
. If you are using nuxt, simply add this to the configuration file:
{
css: [
'@system76/design/dist/index.common.css',
'@system76/forms/dist/index.common.css'
]
}
- You will need to ensure that babel
sourceType
is set tounambiguous
. In nuxt, this means adding the following to your configuration:
build: {
babel: {
sourceType: 'unambiguous'
}
}
Development
-
Download the repository
-
Run
npm ci
-
Run
npm run build
-
Run
npm start
-
Start hacking
Documenting
We use styleguide to document our components. Please write your own stories
and documentation in markdown format like the other .mdx
files. Along with
storybook, we also use styleguidist for documentation in the component file.
This gets outputted in the form of nice prop tables in storybook. Here are some
resources on how to get started:
Deployment
To trigger a release,
push a commit to the master
branch in the
Angular Commit Message Conventions
format.