# gritcode-components

> Web components built with Vuestrap.

Latest version **0.4.10** (published 2017-05-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install gritcode-components
pnpm add gritcode-components
yarn add gritcode-components
bun add gritcode-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.4.10 |
| Published | 2017-05-29 |
| First published | 2015-12-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 203 |
| Author | Kris Zima |
| Maintainers | kzima |
| Keywords | Bootstrap4, Web, Components, Polymer |

## Links

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

## Dependencies (1)

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

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 0.4.10 (latest) — 2017-05-29
- 0.4.7 — 2016-02-08
- 0.4.6 — 2016-02-08
- 0.4.5 — 2016-02-08
- 0.4.1 — 2016-02-08
- 0.4.0 — 2016-02-08
- 0.3.5 — 2016-02-07
- 0.3.3 — 2016-02-02
- 0.3.2 — 2016-02-02
- 0.3.1 — 2016-02-02
- 0.3.0 — 2016-02-02
- 0.2.2 — 2016-01-29
- 0.2.1 — 2016-01-29
- 0.2.0 — 2016-01-29
- 0.1.6 — 2016-01-11
- … 5 more at https://npm.io/package/gritcode-components/versions

## README

Gritcode Components
=========

Gritcode Components extend Bootstrap 4 with [vuestrap](https://github.com/kzima/vuestrap/#readme) web components built with Vue.js and Webpack.

DEMO
=========

[Documentation](http://gritcode.github.io/gritcode-components/#/toast)

QUICK USE
=========

For compiled components, use it within your Vue instance like this:

```js
new Vue({
	el: '#app',
	components: { 'toast': gritcode.toast }
})
```

-- OR --

If you chosen to work with source components, just import* desired component like so:

```js
import toast from 'gritcode-components/src/components/toast'
```

and then load it in your Vue instance:

```js
new Vue({
	el: '#app',
	components: { 'vs-toast': toast }
})
```

*Note: You will need <a href="https://github.com/babel/babel-loader">Babel Loader</a> in your Webpack config file to support ES6 syntax.

You can then use icon component in your html, like so:
```html
<vs-toast></vs-toast>
```

THEMING
=========
To be able to use your app theme with component's scss variables, you will need to use [vuestrap-theme-loader](https://github.com/kzima/vueastrap-theme-loader) in your webpack config file.

```js
npm install vuestrap-theme-loader --save-dev
```

See [vuestrap-starter](https://github.com/kzima/vuestrap-starter) for a webpack config example with theme loader.

TODO
=========
- document events
- testing

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