Skip to content
Getting StartedQuick start

Quick start for Vue

Markdown
Loading…

A working cookie consent banner in about a minute: one CLI command detects your framework and writes the setup for you.

One command in your existing project. The CLI detects your framework, asks a few questions and writes the setup for you, including the stylesheet import that is easy to forget. It runs locally and collects no data.

Prefer to write the files yourself? Installation is the same result in three steps.

1. Run the CLI

npx @cookieyes/cli init

2. Answer the questions

  1. Framework: detected for you, just confirm.
  2. Backend mode: choose Cookie-only. The choice is stored in the visitor's browser and no server is needed. Pick Self-hosted only if you must keep a record on your own server; it then asks for the URL.
  3. Privacy regulation: GDPR for most sites, CCPA for California-style opt-out.
  4. Colour scheme: light, dark, or follow the system.
  5. Extra languages: English is always included.
  6. Confirm, and it installs the package.

To skip the questions, in a script, in CI or from an AI coding tool, pass the answers as flags. --yes takes the default for any question left:

npx @cookieyes/cli init --yes --regulation GDPR --no-install

npx @cookieyes/cli --help lists every flag.

3. Start your app

The banner appears at the bottom of the page. Click Accept All and reload: it stays away, and a small round button in the corner reopens the preferences dialog.

What it wrote

  • src/consent-manager.ts (.js in a JavaScript project): the configuration, the stylesheet import and setupConsent(app), which installs the plugin.
  • src/components/CookieYesRoot.vue: the banner, the preferences dialog and the recall button.
  • src/main.ts: setupConsent(app) called after createApp and before mount.
  • src/App.vue: <CookieYesRoot /> added before your page content.

Files that already exist are left alone. If the CLI cannot find where to add setupConsent(app) or <CookieYesRoot />, it prints the lines to paste under "Manual step needed".

To change anything later, edit src/consent-manager.ts: every option is on Configuration.

In a Nuxt project, choose Nuxt instead: the CLI then sets up @cookieyes/nuxt. See the Nuxt quick start.

Common mistakes

The banner does not appear. You already chose in this browser. Delete the cookieyes-consent cookie and reload.

The banner is unstyled text. The stylesheet import was removed from src/consent-manager.ts. Put it back.

"Manual step needed" was printed. Paste the printed lines into your layout or entry file. Nothing else is missing.

Next steps

  • Configuration: every option the plugin takes
  • Integrations: load Google Analytics, Meta Pixel and other tags only after consent
  • Styling: match the banner to your brand

On this page