# @garethfuller/glue

> Glue is a minimal Vue component library that uses Tailwindcss classes for customisation.

Latest version **1.2.5** (published 2020-07-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install @garethfuller/glue
pnpm add @garethfuller/glue
yarn add @garethfuller/glue
bun add @garethfuller/glue
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.5 |
| Published | 2020-07-05 |
| First published | 2020-05-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 0 |
| Unpacked size | 409.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | garethfuller |
| Keywords | vue, vuejs, tailwindcss, component library, ui library |

## Links

- npm: https://www.npmjs.com/package/@garethfuller/glue
- Repository: https://github.com/garethfuller/glue
- Homepage: https://github.com/garethfuller/glue#glue-for-vue
- Issues: https://github.com/garethfuller/glue/issues
- npm.io page: https://npm.io/package/@garethfuller/glue

## Alternatives

- [@sveltejs/kit](https://npm.io/package/@sveltejs/kit.md) — 2.2M weekly downloads
- [@atlaskit/theme](https://npm.io/package/@atlaskit/theme.md) — 402.0K weekly downloads
- [@tangle-network/brand](https://npm.io/package/@tangle-network/brand.md) — 10.0K weekly downloads
- [seneca](https://npm.io/package/seneca.md) — 7.4K weekly downloads
- [@bsb/base](https://npm.io/package/@bsb/base.md) — 7.2K weekly downloads

## Recent versions

- 1.2.5 (latest) — 2020-07-05
- 1.2.4 — 2020-07-05
- 1.2.3 — 2020-07-05
- 1.2.2 — 2020-07-04
- 1.2.1 — 2020-05-06
- 1.2.0 — 2020-05-06
- 1.1.0 — 2020-05-06
- 1.0.1 — 2020-05-05
- 1.0.0 — 2020-05-04

## README

# Glue for Vue
![npm (scoped)](https://img.shields.io/npm/v/@garethfuller/glue)

Glue Vue is a minimal [Vue](https://vuejs.org/) component library that uses [Tailwindcss](https://tailwindcss.com/) classes for customisation.

## Installation
Install the npm package:
```bash
npm install @garethfuller/glue
# or with yarn
yarn add @garethfuller/glue
```

Add it as a plugin in your Vue project, e.g. create a file like `glue.js` in your plugins folder and add the following to it's contents:
```javascript
// plugins/glue.js
import Vue from 'vue'
import Glue from '@garethfuller/glue'

Vue.use(Glue)
```

Import this plugin in your app's build step/file.

## Dependencies
### Required
[Tailwindcss](https://tailwindcss.com/) - Glue Vue expects that your project has Tailwind installed. The components then use the Tailwind classes provided by your Tailwind configuration.

For example, using the `g-btn` component:
```html
<g-btn color="red">Hello World</g-btn>
```
This will use your Tailwind colour class for `bg-red-500` as the background colour for the button, and variant classes for hover/active states.

### Optional
There are two optional dependencies, [Fontawesome](https://fontawesome.com/) and [highlight.js](https://highlightjs.org/), which are used in specific components.

The `g-icon` component takes a `name` prop and applies that as a class to an underlying `<i :class="'icon ${name}" />` element. The purpose is such that if you have Fontawesome installed in your app you can use the component like this:

```html
<g-icon name="fas fa-user-circle" />
```

Please see [GIcon.vue](/glue/components/g_icon/GIcon.vue) for more information.

The `g-code` component makes use of highlight.js (if installed in your app) to syntax highlight any code that is passed into the component. Please see [GCode.vue](/glue/components/g_code/GCode.vue) for more information.

## Components


## Development
```
yarn install
```

### Compiles and hot-reloads for development
```
yarn run dev
```

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

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