ConsentBanner

Import the banner into your root component

ConsentRoot already renders ConsentBanner. Import the banner yourself only when you compose the surfaces, for example to set its variant in the template or to render it without ConsentRoot. Import it from c15t/vue/vue-plugin:

<script setup lang="ts">
import {
	ConsentBanner,
	ConsentDialogTrigger,
	ConsentManager,
} from 'c15t/vue/vue-plugin';
</script>

<template>
	<!-- Render these in place of ConsentRoot, not next to it. -->
	<ConsentBanner variant="bar" position="bottom" />
	<ConsentManager />
	<ConsentDialogTrigger />
</template>

Render this component in your root component in place of ConsentRoot. Render ConsentManager with it, or Customize opens nothing. A statically imported ConsentManager is part of your main bundle, while ConsentRoot loads the dialog as a separate chunk. Unlike ConsentRoot, these components do not switch to the IAB surfaces under an IAB policy. The c15tVue plugin still adds the tokens option to the page.

What ConsentBanner renders

ConsentBanner renders the first-layer banner while activeUI is 'banner'. It renders nothing until the visitor's policy has resolved, when the policy asks for no prompt, and when a bannerModels or models option leaves out the policy's model.

The policy decides the buttons:

• A choice prompt shows Reject All, Accept All and Customize. Customize is the primary button by default, so Accept All and Reject All look the same.
• A notice prompt shows an OK button. When the policy grants an opt-out or preferences right, the banner adds a button styled as underlined text, labelled "Do not sell or share my data" or "Manage preferences", that opens preferences.
• A policy with prompt none shows no banner.

Each button runs one command. Accept All and Reject All record a choice for every category the policy covers, and the banner closes. Customize sets activeUI to 'manager', which opens ConsentManager if it is mounted. OK records that the visitor dismissed the notice. Dismissing grants nothing and leaves earlier refusals in place.

The text comes from the translations the backend resolved for the visitor: cookieBanner.title and cookieBanner.description for a choice, cookieBanner.noticeTitle and cookieBanner.noticeDescription for a notice, and common.acceptAll, common.rejectAll, common.customize and common.acknowledge for the buttons. bannerLegalLinks picks which of your legalLinks appear under the description. The banner has no slots and no text props.

ConsentBanner moves itself into document.body once it has mounted. During server rendering it renders in place, so the banner can be part of the server HTML.

Variants and positions

The policy decides which actions the banner offers. The variant decides the shape they take.

The policy has the last word. A choice wall always blocks. A notice never blocks, and a notice wall falls back to floating. A position the variant does not accept falls back to the variant's default. Each correction logs a [c15t] warning in the browser console.

A default corner mirrors left and right for right-to-left languages. A position you set is kept as written.

Props

A prop you set beats the matching presentation.prompt option. Leave a prop unset to follow your c15t options. PromptVariant and PromptPosition are exported as types from c15t.

To set the variant for every banner without importing the component, use presentation.prompt in the plugin options. See customize.

Accessibility and focus

• A non-blocking banner is a region labelled with the banner title. It does not trap focus or lock scrolling, so the page stays usable with a keyboard and a pointer.
• A blocking banner is a dialog with aria-modal="true". It shows a backdrop, locks page scrolling, moves focus to the banner card and keeps Tab inside the card.
• The banner has no close button, and Escape does not dismiss it. The visitor answers with one of its buttons.
• Every action is a native button. The banner sets dir from the resolved language.

Style the banner

Theme tokens change colors, type, radius, spacing and motion. The components.banner option adds attributes, such as class or style, to these parts: root, overlay, cardShell, card, header, title, footer, actions, actionGroup, rights and rightLink. components.description.banner and components.tag.banner reach the description and the branding tag. Component slots lists every part.

The root element carries attributes you can target from CSS:

bannerHideBranding, or hideBranding for every surface, hides the "Secured by" tag. disableAnimation turns off the enter and exit transitions.

Verify

Open the page in a private window under a policy that asks for a choice. The banner appears with Reject All and Accept All side by side. Tab through it and confirm every button is reachable. Click Customize and the preference dialog opens. Reject, reload, and confirm the banner stays closed. In the Elements panel, the root element carries the data-variant and data-position you set.

Next steps

• ConsentManager is the dialog Customize opens.
• Headless builds a banner from your own markup.
• Banner designs shows tested designs.