Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/apertureless/vue-cookie-law

🍪 👮 Hackable EU Cookie Law Plugin for Vue.js
https://github.com/apertureless/vue-cookie-law

cookie cookie-law eu-cookie vue vuejs vuejs2

Last synced: 9 days ago
JSON representation

🍪 👮 Hackable EU Cookie Law Plugin for Vue.js

Host: GitHub
URL: https://github.com/apertureless/vue-cookie-law
Owner: apertureless
License: mit
Created: 2017-03-14T14:36:33.000Z (over 7 years ago)
Default Branch: develop
Last Pushed: 2021-02-26T10:57:03.000Z (over 3 years ago)
Last Synced: 2024-10-12T08:49:23.570Z (23 days ago)
Topics: cookie, cookie-law, eu-cookie, vue, vuejs, vuejs2
Language: JavaScript
Size: 576 KB
Stars: 378
Watchers: 8
Forks: 43
Open Issues: 13
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: code-of-conduct.md

Awesome Lists containing this project

README

        # 🍪 👮 Vue Cookie Law

[![Build Status](https://travis-ci.org/apertureless/vue-cookie-law.svg?branch=develop)](https://travis-ci.org/apertureless/vue-cookie-law)

[![npm](https://img.shields.io/npm/v/vue-cookie-law.svg)](https://www.npmjs.com/package/vue-cookie-law)

[![vue2](https://img.shields.io/badge/vue-2.x-brightgreen.svg)](https://vuejs.org/)

[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/apertureless/vue-cookie-law/blob/master/LICENSE)

[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/C0C1WP7C)

EU Cookie Law Plugin for Vue.js

📺 [Demo](https://apertureless.github.io/vue-cookie-law/)

## 🔧  Install

`yarn add vue-cookie-law`

## 👈 Usage

```javascript

  

    

  

  import CookieLaw from 'vue-cookie-law'

  export default {

    components: { CookieLaw }

  }

```

## Slots

You can also pass in the message into a named slot. This way you can for example add `` and other dynamic content.

```html

  


    Here is my message for more info Click here

  


```

## Scoped Slot

For a more complex layout use the **scoped slot**

```html

  


    I accept

    

      This site uses 🍪

    

    Ignore me

  


```

| methods | description |

|---|---|

| accept | Closes the cookie disclaimer and saves to localStorage |

| close | Only closes the cookie disclaimer. The disclaimer will reappear on the next page load. |

| open | Show disclaimer if user ignored him |

| revoke | Revoke previous user decision |

| isAccepted | To check anytime if cookies has been accepted |

## Props

| prop | default | type | description

|---|---|---|---|

| buttonText | 'Got It!' | String | 🔘 Well, its the button text

| buttonLink |  | String\|Object | Link to more infos. Simple href or a [vue-router](https://github.com/vuejs/vue-router) Location object

| buttonLinkText | 'More info' | String | Label of link button

| buttonLinkNewTab | false | Boolean | If true, it opens the link in a new tab/window (href)

| buttonClass | 'Cookie__button' | String | Custom class name for buttons

| message | 'This website uses cookies to ensure you get the best experience on our website.' | String | Your message in the content area

| theme | 'base' | String | Selected theme. You can also create a custom one

| position | 'bottom' | String | Possible positions are `bottom` or `top`

| transitionName | 'slideFromBottom' | String | Enter and leave transitions. Currently supported `slideFromBottom`, `slideFromTop`, `fade`

| storageName | 'cookie:accepted' | String | Name for the localStorage / cookie name. Defaults to `cookie:accepted`

| storageType | 'localStorage' | String | Type of storage, where to store 'cookies:accept': true. Can be `localStorage` (default) or `cookies`. If LocalStorage is unsupported, then used Cookies.

| cookieOptions | {} | Object | (Optional) The cookieOptions parameter is an object. And its property can be a valid cookie option, such as `path`, `domain`, `expires` / `max-age`, `samesite` or `secure`. See [tiny-cookie docs](https://github.com/Alex1990/tiny-cookie#setkey-value-options) for details.

| buttonDecline | false | Boolean | Display decline button

| buttonDeclineText | 'Decline' | String | 🔘Decline button text

| buttonDeclineClass | 'Cookie__button--decline' | String | Custom class name for decline button

## Events

The default button will emit an `accept` event you can listen on if the user clicks the button.

```html

```

## 💅 Themes

![Cookie Law Themes](static/cookie-law-themes.png)

### Custom Themes

You can easy create your own themes. The classes that need to be styled are:

- `.Cookie` for the container

- `.Cookie__content` for the content with message

- `.Cookie__button` for the button

If you create your own theme, postfix the class.

```css

.Cookie--mytheme {....}

.Cookie--mytheme .Cookie__button {....}

.Cookie--mytheme div.Cookie__button:hover {....}

```

And then pass your theme name to the component.

## :scroll: Changelog

Details changes for each release are documented in the [CHANGELOG.md](https://github.com/apertureless/vue-cookie-law/blob/develop/CHANGELOG.md).

## :exclamation: Issues

Please make sure to read the [Issue Reporting Checklist](https://github.com/apertureless/vue-cookie-law/blob/develop/CONTRIBUTING.md#issue-reporting-guidelines) before opening an issue. Issues not conforming to the guidelines may be closed immediately.

## :muscle: Contribution

Please make sure to read the [Contributing Guide](https://github.com/apertureless/vue-cookie-law/blob/develop/CONTRIBUTING.md) and [Code of Conduct](code-of-conduct.md) before making a pull request.

## :copyright: License

[MIT](http://opensource.org/licenses/MIT)