-
Notifications
You must be signed in to change notification settings - Fork 224
Component Status
Viljami Salminen edited this page Mar 4, 2018
·
17 revisions
Components in the system are labelled with status labels that reflect their state of completion. This is achieved using status
option:
<script>
/**
* My Heading component
*/
export default {
name: "Heading",
status: "prototype",
release: "1.0.0"
}
</script>
For a concrete example, see ExampleComponent.vue. You can see all available statuses listed below:
Label | Color | Description |
---|---|---|
deprecated | Red | Component is deprecated |
prototype | Blue | Prototype, do not implement! |
under-review | Yellow | Component is currently being reviewed |
ready | Green | Ready to be used. |
For an example of how this looks like in the living system documentation, see Vue Design System Example Docs
- 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.