com.github.fluorumlabs.disconnect.vaadin.CookieConsent Maven / Gradle / Ivy
Show all versions of disconnect-vaadin Show documentation
package com.github.fluorumlabs.disconnect.vaadin;
import com.github.fluorumlabs.disconnect.core.annotations.WebComponent;
import com.github.fluorumlabs.disconnect.vaadin.constants.CookieConsentPosition;
import com.github.fluorumlabs.disconnect.vaadin.elements.CookieConsentElement;
import com.github.fluorumlabs.disconnect.vaadin.mixins.HasElementMixin;
import com.github.fluorumlabs.disconnect.zero.component.AbstractComponent;
import com.github.fluorumlabs.disconnect.zero.component.Component;
import com.github.fluorumlabs.disconnect.zero.component.HasComponents;
import com.github.fluorumlabs.disconnect.zero.component.HasStyle;
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
*/
@WebComponent
public class CookieConsent extends AbstractComponent
implements HasElementMixin,
HasStyle, HasComponents> {
public CookieConsent() {
super(CookieConsentElement.TAGNAME());
}
/**
* The message to show in the popup.
*/
@Nullable
public String message() {
return getNode().getMessage();
}
/**
* The message to show in the popup.
*/
public CookieConsent message(String message) {
getNode().setMessage(message);
return this;
}
/**
* The text to show on the dismiss/consent button.
*/
@Nullable
public String dismiss() {
return getNode().getDismiss();
}
/**
* The text to show on the dismiss/consent button.
*/
public CookieConsent dismiss(String dismiss) {
getNode().setDismiss(dismiss);
return this;
}
/**
* The text to show on the 'learn more' link.
*/
@Nullable
public String learnMore() {
return getNode().getLearnMore();
}
/**
* The text to show on the 'learn more' link.
*/
public CookieConsent learnMore(String learnMore) {
getNode().setLearnMore(learnMore);
return this;
}
/**
* The URL the 'learn more' link should open.
*/
@Nullable
public String learnMoreLink() {
return getNode().getLearnMoreLink();
}
/**
* The URL the 'learn more' link should open.
*/
public CookieConsent learnMoreLink(String learnMoreLink) {
getNode().setLearnMoreLink(learnMoreLink);
return this;
}
/**
* 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
public CookieConsentPosition position() {
return getNode().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.
*/
public CookieConsent position(CookieConsentPosition position) {
getNode().setPosition(position);
return this;
}
/**
* The name of the cookie to set to remember that the user has consented.
*
* This rarely needs to be changed.
*/
@Nullable
public String cookieName() {
return getNode().getCookieName();
}
/**
* The name of the cookie to set to remember that the user has consented.
*
* This rarely needs to be changed.
*/
public CookieConsent cookieName(String cookieName) {
getNode().setCookieName(cookieName);
return this;
}
}