@plentymarkets/shop-api / cookieBarGetters
Variable: cookieBarGetters ​
constcookieBarGetters:object
Defined in: getters/cookieBarGetters.ts:92
Type Declaration ​
getBarDescription ​
getBarDescription: (
cookieGroups) =>string
Returns the description text shown in the cookie consent bar.
Parameters ​
cookieGroups ​
CookieGroups
The cookie groups configuration object.
Returns ​
string
The bar description string.
getBarTitle ​
getBarTitle: (
CookieGroups) =>string
Returns the title shown in the cookie consent bar.
Parameters ​
CookieGroups ​
CookieGroups
The cookie groups configuration object.
Returns ​
string
The bar title string.
getCookieGroupDescription ​
getCookieGroupDescription: (
CookieGroup) =>string
Returns the description of a cookie group.
Parameters ​
CookieGroup ​
CookieGroup
The cookie group object.
Returns ​
string
The group description string, or an empty string if not set.
getCookieGroupName ​
getCookieGroupName: (
CookieGroup) =>string
Returns the display name of a cookie group.
Parameters ​
CookieGroup ​
CookieGroup
The cookie group object.
Returns ​
string
The group name string, or an empty string if not set.
getCookieGroupNameWithCount ​
getCookieGroupNameWithCount: (
CookieGroup) =>string
Returns the display name of a cookie group with its cookie count appended in parentheses.
Parameters ​
CookieGroup ​
CookieGroup
The cookie group object.
Returns ​
string
A string in the format "<name> (<count>)".
getCookieName ​
getCookieName: (
Cookie) =>string
Returns the display name of a cookie.
Parameters ​
Cookie ​
Cookie
The cookie object.
Returns ​
string
The cookie name string, or an empty string if not set.
getCookiesList ​
getCookiesList: (
CookieGroup) =>Cookie[]
Returns the list of cookies belonging to a cookie group.
Parameters ​
CookieGroup ​
CookieGroup
The cookie group object.
Returns ​
Cookie[]
An array of Cookie objects.
getShowMore ​
getShowMore: (
CookieGroup) =>boolean
Returns whether the cookie group's details are currently expanded (show more).
Parameters ​
CookieGroup ​
CookieGroup
The cookie group object.
Returns ​
boolean
true if the group is expanded, otherwise false.