# @hatchly/nuxt-snippets-module

> Official nuxt integration for the Hatchly/Snippets module

Latest version **4.1.1** (published 2021-07-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install @hatchly/nuxt-snippets-module
pnpm add @hatchly/nuxt-snippets-module
yarn add @hatchly/nuxt-snippets-module
bun add @hatchly/nuxt-snippets-module
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.1.1 |
| Published | 2021-07-23 |
| First published | 2020-02-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 10.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Sam Turrell |
| Maintainers | samturrell, rebeccaanderton |

## Links

- npm: https://www.npmjs.com/package/@hatchly/nuxt-snippets-module
- Repository: https://github.com/netsells/nuxt-hatchly-snippets
- Issues: https://github.com/netsells/nuxt-hatchly-snippets/issues
- npm.io page: https://npm.io/package/@hatchly/nuxt-snippets-module

## Recent versions

- 4.1.1 (latest) — 2021-07-23
- 4.1.0 — 2021-04-12
- 4.0.0 — 2021-01-05
- 3.6.1 — 2021-01-04
- 3.6.0 — 2021-01-04
- 3.5.1 — 2020-12-20
- 3.5.0 — 2020-12-20
- 3.4.0 — 2020-10-25
- 3.3.0 — 2020-10-08
- 3.2.0 — 2020-10-02
- 3.1.0 — 2020-09-22
- 3.0.1 — 2020-09-22
- 3.0.0 — 2020-09-22
- 2.0.0 — 2020-08-26
- 1.2.0 — 2020-02-29
- … 2 more at https://npm.io/package/@hatchly/nuxt-snippets-module/versions

## README

# Nuxt Hatchly Snippets Module

> Module to easily fetch and access snippets from the `hatchly/snippets` api

## Installation

```bash
yarn add @hatchly/nuxt-snippets-module
```

Register the module in your nuxt applications config file:

```js
module.exports = {
    // Nuxt config
    modules: {
        // Other Modules
        ['@hatchly/nuxt-snippets-module', {
            // Options
        }],
    },

    hatchly: {
        snippets: {
            // Options can also be defined here
        },
    },
};
```

Add the API url to your .env:

```
API_URL=http://my-application.localhost
```

## Options

The options object can contain the following values: 

```js
{
    cacheTimeout: '',
},
```

Each option is described below.

### `cacheTimeout`

> The duration, in seconds, until the cached date is refreshed. The cache can be disabled completely by passing a falsey value.

- Default: `86400` (24 hours)
- Type: `number|boolean`

### Runtime config

By default, this package will utilise `API_URL` and `API_URL_BROWSER` variables as defined in your env. These are injected as runtime variables for you.

You can supply your endpoint manually to the module via the `publicRuntimeConfig` and `privateRuntimeConfig` objects, e.g.:

```js
module.exports = {
    publicRuntimeConfig: {
        hatchly: {
            snippets: {
                // Overwrite options for the snippets module
                endpoint: process.env.SNIPPETS_API_URL,
            },
        },    
    },
};
```

## Usage

All snippets are downloaded server side on page load.

To access a snippet you can use the global `$snippet()` method:

```vue
{{ $snippet('snippet_key') }}
```

## Storybook

This module exposes a storybook integration to add the `$snippet` global and the store module. Simply pull the following module into your project and register your snippets, in the `preview.js` file for example:

```js
import hatchlySnippets from '@hatchly/nuxt-snippets-module/storybook';
import { snippets } from './fixtures/snippets';
import store from './store';

hatchlySnippets({
    store,
    snippets,
});
```

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