1.13.3 โ€ข Published 4 years ago

vue-cookie-law v1.13.3

Weekly downloads
9,888
License
MIT
Repository
github
Last release
4 years ago

๐Ÿช ๐Ÿ‘ฎ Vue Cookie Law

Build Status npm vue2 license

ko-fi

EU Cookie Law Plugin for Vue.js

๐Ÿ“บ Demo

๐Ÿ”ง Install

yarn add vue-cookie-law

๐Ÿ‘ˆ Usage

<template>
  <footer>
    <cookie-law theme="dark-lime"></cookie-law>
  </footer>
</template>

<script>
  import CookieLaw from 'vue-cookie-law'
  export default {
    components: { CookieLaw }
  }
</script>

Slots

You can also pass in the message into a named slot. This way you can for example add <router-link> and other dynamic content.

<cookie-law>
  <div slot="message">
    Here is my message for more info <router-link to="legal-notes">Click here</router-link>
  </div>
</cookie-law>

Scoped Slot

For a more complex layout use the scoped slot

<cookie-law>
  <div slot-scope="props">
    <button class="skew" @click="props.accept"><span>I accept</span></button>
    <p>
      This site uses ๐Ÿช
    </p>
    <button class="skew" @click="props.close"><span>Ignore me</span></button>
  </div>

</cookie-law>
methodsdescription
acceptCloses the cookie disclaimer and saves to localStorage
closeOnly closes the cookie disclaimer. The disclaimer will reappear on the next page load.
openShow disclaimer if user ignored him
revokeRevoke previous user decision
isAcceptedTo check anytime if cookies has been accepted

Props

propdefaulttypedescription
buttonText'Got It!'String๐Ÿ”˜ Well, its the button text
buttonLinkString|ObjectLink to more infos. Simple href or a vue-router Location object
buttonLinkText'More info'StringLabel of link button
buttonLinkNewTabfalseBooleanIf true, it opens the link in a new tab/window (href)
buttonClass'Cookie__button'StringCustom class name for buttons
message'This website uses cookies to ensure you get the best experience on our website.'StringYour message in the content area
theme'base'StringSelected theme. You can also create a custom one
position'bottom'StringPossible positions are bottom or top
transitionName'slideFromBottom'StringEnter and leave transitions. Currently supported slideFromBottom, slideFromTop, fade
storageName'localStorage'StringName for the localStorage / cookie name. Defaults to cookie:accepted
storageType'localStorage'StringType 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 for details.
buttonDeclinefalseBooleanDisplay decline button
buttonDeclineText'Decline'String๐Ÿ”˜Decline button text
buttonDeclineClass'Cookie__button--decline'StringCustom class name for decline button

Events

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

<cookie-law v-on:accept="ThankYouMethod()"/>

๐Ÿ’… Themes

Cookie Law Themes

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.

.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.

:exclamation: Issues

Please make sure to read the Issue Reporting Checklist before opening an issue. Issues not conforming to the guidelines may be closed immediately.

:muscle: Contribution

Please make sure to read the Contributing Guide and Code of Conduct before making a pull request.

:copyright: License

MIT

1.13.3

4 years ago

1.13.2

4 years ago

1.13.1

4 years ago

1.13.0

4 years ago

1.12.0

4 years ago

1.11.0

5 years ago

1.10.0

5 years ago

1.9.0

5 years ago

1.8.0

6 years ago

1.7.0

6 years ago

1.6.0

6 years ago

1.5.0

6 years ago

1.4.1

6 years ago

1.5.0-rc.5

6 years ago

1.5.0-rc.4

6 years ago

1.5.0-rc.3

6 years ago

1.5.0-rc.2

6 years ago

1.5.0-rc.1

6 years ago

1.5.0-rc.0

6 years ago

1.4.0

6 years ago

1.3.0

7 years ago

1.2.0

7 years ago

1.1.0

7 years ago

1.0.2

7 years ago

1.0.1

7 years ago

1.0.0

7 years ago