# vue-design-system-components

> A collection of Vue components tailored towards building design systems

Latest version **0.2.2** (published 2019-10-24) · (MIT OR Apache-2.0) license · 0 weekly downloads

## Install

```sh
npm install vue-design-system-components
pnpm add vue-design-system-components
yarn add vue-design-system-components
bun add vue-design-system-components
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.2 |
| Published | 2019-10-24 |
| First published | 2018-11-07 |
| Weekly downloads | 0 |
| License | (MIT OR Apache-2.0) |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 708.4 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Chris Forrence |
| Maintainers | chrisforrence |

## Links

- npm: https://www.npmjs.com/package/vue-design-system-components
- Repository: https://github.com/chrisforrence/vue-design-system-components
- Homepage: https://github.com/chrisforrence/vue-design-system-components#readme
- Issues: https://github.com/chrisforrence/vue-design-system-components/issues
- npm.io page: https://npm.io/package/vue-design-system-components

## Dependencies (1)

- [vue](https://npm.io/package/vue.md) ^2.5.17

## Recent versions

- 0.2.2 (latest) — 2019-10-24
- 0.2.1 — 2018-11-07
- 0.2.0 — 2018-11-07

## README

# Vue Design System Components

This library is intended to assist developers with building bespoke design systems.

## Project setup

First, install the library or add it to your package.json file.

```
npm install --save vue-design-system-components
```

This library is built using [vue-cli][vue-cli-build]; you can bring the design system components into your project by requiring the UMD script:

```
let dsc = require('vue-design-system-components/dist/vue-design-system-components.umd.js');
const app = new Vue({
    el: '#app',
    components: dsc.default
});
```

## Components

This is a list of available components: more will be added over time!

### Title

```
<design-system-title>Well Howdy There!</design-system-title>
```

### Comment

```
<design-system-comment>This might be slightly important.</design-system-comment>
```

### Color Swatch

Use this component to tightly group together multiple colors

```
<design-system-color-swatch :colors="[{
        name: 'Gray',
        hex: '#112233',
        meta: {
            hex: '#112233',
            rgb: 'rgb(17, 34, 51)',
            scss: '$color_gray'
        }
    }, {
        name: 'Gray Light',
        hex: '#223344',
        meta: {
            hex: '#112233',
            rgb: 'rgb(34, 51, 68)',
            scss: '$color_gray_light'
        }
    }]"></design-system-color-swatch>
```

### Color Contrast

```
<design-system-color-contrast :colors="[{
    name: 'Color Name',
    hex: '#112233'
}, {
    name: 'Color Name',
    hex: '#FFEEDD'
}]" :summary="true" :table="true"></design-system-color-contrast>
```

## Development

Want to develop on these as well? Fantastic!

### Compiles and hot-reloads for development

```
npm run serve
```

### Compiles and minifies for production
```
npm run build
```

### Run your tests
```
npm run test
```

### Lints and fixes files
```
npm run lint
```

[vue-cli-build]: https://cli.vuejs.org/guide/build-targets.html#library

---
_Source: https://npm.io/package/vue-design-system-components · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._