-
Notifications
You must be signed in to change notification settings - Fork 224
Component Status
Viljami Salminen edited this page Nov 9, 2017
·
17 revisions
Components in the system are labelled with status labels reflecting their state of completion. This can be achieved by using JSDoc style comments inside the <code/>
block. Like this:
<script>
/**
* @version `prototype`
*/
export default {
name: 'Heading',
props: {
level: {
type: String,
default: 'h1'
}
}
}
</script>
You can see all available statuses listed below:
Label | Color | Description |
---|---|---|
Deprecated | Red | Component is deprecated |
Prototype | Red | Do not implement! |
WIP | Yellow | Work-in-progress… |
Ready | Green | Ready to be used. |
- Getting Started: How to install and run Vue Design System.
- Terminology: Introduction to the system concepts and its hierarchy.
- Naming of Things: Naming is hard, so it’s good to have clear guidelines.
- Directory Structure: What goes where and why.
-
Working with the System: Concrete examples on how to work with
Tokens
,Elements
,Patterns
andTemplates
. - Editing Living Documentation: How to customize the living system documentation.
- Spacing: A framework for creating a predictable and harmonious spacing.
- Component Status: Clear labels that reflect the state of completion.
- Component QA: How to review new components and keep the quality high.
- Contributing: A set of guidelines for contributing to the system.
- Code of Conduct: By participating you agree to abide by its terms.
- Frequently Asked Questions: How to use icons, how to use font-face, etc.
- Changelog: See releases pafge for the full changelog.