com.github.fluorumlabs.disconnect.vaadin.elements.CookieConsentElement Maven / Gradle / Ivy
Show all versions of disconnect-vaadin Show documentation
package com.github.fluorumlabs.disconnect.vaadin.elements;
import com.github.fluorumlabs.disconnect.core.annotations.Import;
import com.github.fluorumlabs.disconnect.core.annotations.NpmPackage;
import com.github.fluorumlabs.disconnect.vaadin.Vaadin;
import com.github.fluorumlabs.disconnect.vaadin.constants.CookieConsentPosition;
import com.github.fluorumlabs.disconnect.vaadin.elements.mixins.ElementMixin;
import com.github.fluorumlabs.disconnect.vaadin.elements.mixins.ThemableMixin;
import js.web.dom.HTMLElement;
import org.teavm.jso.JSProperty;
import javax.annotation.Nullable;
/**
* <vaadin-cookie-consent> is used to show a cookie consent banner the first
* time a user visits the application.
*
* By default, the banner is shown attached to the top of the screen and with a
* predefined text, a link to https://cookiesandyou.com/
* describing cookies and a consent button.
*
* The texts, link and position can be configured using attributes/properties, e.g.
*
*
<vaadin-cookie-consent learn-more-link="https://mysite.com/cookies.html"><
* /vaadin-cookie-consent>
*
* Styling
* To change the look of the cookie consent banner, a style node should be attached
* to the document's head with the following style names overridden:
*
*
*
* Style name Description cc-windowBanner container cc-messageMessage container cc-complianceDismiss cookie button container cc-dismissDismiss cookie button cc-btnDismiss cookie button cc-linkLearn more link element
*/
@NpmPackage(
name = "@vaadin/vaadin",
version = Vaadin.VERSION
)
@Import(
module = "@vaadin/vaadin-cookie-consent/theme/lumo/vaadin-cookie-consent.js"
)
public interface CookieConsentElement extends HTMLElement, ElementMixin, ThemableMixin {
static String TAGNAME() {
return "vaadin-cookie-consent";
}
/**
* The message to show in the popup.
*/
@Nullable
@JSProperty
String getMessage();
/**
* The message to show in the popup.
*/
@JSProperty
void setMessage(String message);
/**
* The text to show on the dismiss/consent button.
*/
@Nullable
@JSProperty
String getDismiss();
/**
* The text to show on the dismiss/consent button.
*/
@JSProperty
void setDismiss(String dismiss);
/**
* The text to show on the 'learn more' link.
*/
@Nullable
@JSProperty
String getLearnMore();
/**
* The text to show on the 'learn more' link.
*/
@JSProperty
void setLearnMore(String learnMore);
/**
* The URL the 'learn more' link should open.
*/
@Nullable
@JSProperty
String getLearnMoreLink();
/**
* The URL the 'learn more' link should open.
*/
@JSProperty
void setLearnMoreLink(String learnMoreLink);
/**
* Determines the position of the banner.
*
* Possible values are: top, bottom, top-left, top-right,
* bottom-left, bottom-right
* For top and bottom, the banner is shown with full width. For the corner positions,
* it is shown as a smaller popup.
*/
@Nullable
@JSProperty
CookieConsentPosition getPosition();
/**
* Determines the position of the banner.
*
* Possible values are: top, bottom, top-left, top-right,
* bottom-left, bottom-right
* For top and bottom, the banner is shown with full width. For the corner positions,
* it is shown as a smaller popup.
*/
@JSProperty
void setPosition(CookieConsentPosition position);
/**
* The name of the cookie to set to remember that the user has consented.
*
* This rarely needs to be changed.
*/
@Nullable
@JSProperty
String getCookieName();
/**
* The name of the cookie to set to remember that the user has consented.
*
* This rarely needs to be changed.
*/
@JSProperty
void setCookieName(String cookieName);
}