HtmlForgeX

API Reference

Class

CookieBannerSettings

Edit on GitHub
Namespace HtmlForgeX
Assembly HtmlForgeX
Source Containers/Tabler/Settings/CookieBannerSettings.cs:11
Modifiers sealed

Settings sub-builder for TablerCookieBanner.

Inheritance

  • Object
  • CookieBannerSettings

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Accepted by parameters

Methods

public CookieBannerSettings AllowAllButton(String text) #
Containers/Tabler/Settings/CookieBannerSettings.cs:39
Returns: CookieBannerSettings

Sets the "allow all" button label.

Parameters

text System.String requiredposition: 0
public CookieBannerSettings AutoShow(Boolean enable = true) #
Containers/Tabler/Settings/CookieBannerSettings.cs:20
Returns: CookieBannerSettings

Controls whether the banner should auto-show when consent is missing.

Parameters

enable System.Boolean = true optionalposition: 0
public CookieBannerSettings Backdrop(Boolean enable = true) #
Containers/Tabler/Settings/CookieBannerSettings.cs:23
Returns: CookieBannerSettings

Controls Bootstrap offcanvas backdrop (default: false).

Parameters

enable System.Boolean = true optionalposition: 0
public TablerCookieBanner End() #
Containers/Tabler/Settings/CookieBannerSettings.cs:42
Returns: TablerCookieBanner

Returns control to the root banner builder.

public CookieBannerSettings EssentialButton(String text) #
Containers/Tabler/Settings/CookieBannerSettings.cs:37
Returns: CookieBannerSettings

Sets the "essential only" button label.

Parameters

text System.String requiredposition: 0
public CookieBannerSettings LearnMore(String href, String text = "Learn more") #
Containers/Tabler/Settings/CookieBannerSettings.cs:35
Returns: CookieBannerSettings

Sets an optional learn-more link appended to the message.

Parameters

href System.String requiredposition: 0
text System.String = "Learn more" optionalposition: 1
public CookieBannerSettings Message(String text) #
Containers/Tabler/Settings/CookieBannerSettings.cs:33
Returns: CookieBannerSettings

Sets the main banner message.

Parameters

text System.String requiredposition: 0
public CookieBannerSettings Scroll(Boolean enable = true) #
Containers/Tabler/Settings/CookieBannerSettings.cs:26
Returns: CookieBannerSettings

Controls Bootstrap offcanvas scroll behavior (default: true).

Parameters

enable System.Boolean = true optionalposition: 0
public CookieBannerSettings StorageKey(String key) #
Containers/Tabler/Settings/CookieBannerSettings.cs:11
Returns: CookieBannerSettings

Sets the localStorage key used to persist consent.

Parameters

key System.String requiredposition: 0
public CookieBannerSettings Title(String text) #
Containers/Tabler/Settings/CookieBannerSettings.cs:31
Returns: CookieBannerSettings

Convenience wrappers for common root methods.

Parameters

text System.String requiredposition: 0
public CookieBannerSettings Values(String essentialValue, String allowAllValue) #
Containers/Tabler/Settings/CookieBannerSettings.cs:17
Returns: CookieBannerSettings

Sets values stored in localStorage for "essential" and "allow all". Defaults: "essential" / "all".

Parameters

essentialValue System.String requiredposition: 0
allowAllValue System.String requiredposition: 1