PlentyONE Shop Docs

Appearance

@plentymarkets/shop-api / heroesGetters

Variable: heroesGetters ​

const heroesGetters: object

Defined in: getters/heroesGetters.ts:54

Type Declaration ​

getBackground ​

getBackground: (banner) => string

Returns the background value of a hero banner (e.g. a color or image URL).

Parameters ​

Hero

The hero banner object.

Returns ​

string

The background string, or an empty string if not set.

getClassName ​

getClassName: (banner) => string

Returns the CSS class name applied to a hero banner.

Parameters ​

Hero

The hero banner object.

Returns ​

string

The CSS class name string, or an empty string if not set.

getImage ​

getImage: (banner) => string

Returns the image URL of a hero banner.

Parameters ​

Hero

The hero banner object.

Returns ​

string

The image URL string, or an empty string if not set.

getSubTitle ​

getSubTitle: (banner) => string

Returns the subtitle of a hero banner.

Parameters ​

Hero

The hero banner object.

Returns ​

string

The subtitle string, or an empty string if not set.

getTitle ​

getTitle: (banner) => string

Returns the title of a hero banner.

Parameters ​

Hero

The hero banner object.

Returns ​

string

The title string, or an empty string if not set.