We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.component.cookieconsent.
Class CookieConsent
- java.lang.Object
-
- com.vaadin.flow.component.Component
-
- com.vaadin.flow.component.cookieconsent.CookieConsent
-
All Implemented Interfaces:
AttachNotifier,DetachNotifier,HasElement,HasStyle,Serializable@Tag("vaadin-cookie-consent") @NpmPackage(value="@vaadin/polymer-legacy-adapter",version="23.1.15") @NpmPackage(value="@vaadin/cookie-consent",version="23.1.15") @NpmPackage(value="@vaadin/vaadin-cookie-consent",version="23.1.15") @JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/cookie-consent/src/vaadin-cookie-consent.js") @JsModule("./cookieConsentConnector.js") public class CookieConsent extends Component implements HasStyleCookie Consent is a component for showing a cookie consent banner the first time a user visits the application, until the banner is dismissed.
By default, the banner is shown at the top of the screen with a predefined text, a link to cookiesandyou.com which explains what cookies are, and a consent button.
Cookie Consent is fully customizable. You can customize the message, the "Learn More" link, the "Dismiss" button, as well as the component?s position.
Author:
Vaadin Ltd
See Also:
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classCookieConsent.PositionPosition of the banner.
-
Constructor Summary
Constructors Constructor Description CookieConsent()Creates a banner with default values.
CookieConsent(String message, String dismissLabel, String learnMoreLabel, String learnMoreLink, CookieConsent.Position position)Creates a banner with the specified data
-
Method Summary
All Methods Modifier and Type Method Description StylegetStyle()Gets the style instance for managing inline styles for the element of this component.
protected voidonAttach(AttachEvent attachEvent)Called when the component is attached to a UI.
voidsetCookieName(String cookieName)Sets the name of the cookie to remember that the user has consented.
voidsetDismissLabel(String dismissLabel)Sets the dismiss/consent button's text
voidsetLearnMoreLabel(String learnMoreLabel)Sets the label of the 'learn more' link
voidsetLearnMoreLink(String learnMoreLink)Sets the URL of the 'learn more' link
voidsetMessage(String message)Sets the consent message to show in the banner.
voidsetPosition(CookieConsent.Position position)Sets the position of the banner on the page.
-
Methods inherited from class com.vaadin.flow.component.Component
addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, onEnabledStateChanged, scrollIntoView, set, setElement, setId, setVisible
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListener
-
Methods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListener
-
Methods inherited from interface com.vaadin.flow.component.HasElement
getElement
-
Methods inherited from interface com.vaadin.flow.component.HasStyle
addClassName, addClassNames, getClassName, getClassNames, hasClassName, removeClassName, removeClassNames, setClassName, setClassName
-
-
-
-
Constructor Detail
-
CookieConsent
public CookieConsent()Creates a banner with default values.
-
CookieConsent
public CookieConsent(String message, String dismissLabel, String learnMoreLabel, String learnMoreLink, CookieConsent.Position position)Creates a banner with the specified data
Parameters:
message- The message to show in the banner.dismissLabel- The text to show on the dismiss/consent button.learnMoreLabel- The text to show on the 'learn more' link.learnMoreLink- The URL the 'learn more' link should open.position- Determines the position of the banner.
-
-
Method Detail
-
setMessage
public void setMessage(String message)Sets the consent message to show in the banner.
Parameters:
message- The message to show in the banner.
-
setDismissLabel
public void setDismissLabel(String dismissLabel)Sets the dismiss/consent button's text
Parameters:
dismissLabel- The text of the button.
-
setLearnMoreLabel
public void setLearnMoreLabel(String learnMoreLabel)Sets the label of the 'learn more' link
Parameters:
learnMoreLabel- The text to show on the 'learn more' link.
-
setLearnMoreLink
public void setLearnMoreLink(String learnMoreLink)Sets the URL of the 'learn more' link
Parameters:
learnMoreLink- The URL the 'learn more' link should open.
-
setPosition
public void setPosition(CookieConsent.Position position)Sets the position of the banner on the page.
Parameters:
position- Determines the position of the banner.Throws:
NullPointerException- if position is null.
-
setCookieName
public void setCookieName(String cookieName)Sets the name of the cookie to remember that the user has consented. This rarely needs to be changed.
Parameters:
cookieName- The name of the cookie.
-
getStyle
public Style getStyle()Description copied from interface:
HasStyleGets the style instance for managing inline styles for the element of this component.
Specified by:
getStylein interfaceHasStyleReturns:
the style object for the element, not
nullThrows:
UnsupportedOperationException- CookieConsent does not support adding styles
-
onAttach
protected void onAttach(AttachEvent attachEvent)Description copied from class:
ComponentCalled when the component is attached to a UI.
The default implementation does nothing.
This method is invoked before the
AttachEventis fired for the component.
-
-