Interface AdSkipButtonConfig

Configuration interface for the AdSkipButton.

interface AdSkipButtonConfig {
    acceptsTouchWithUiHidden?: boolean;
    ariaLabel?: LocalizableText;
    cssClass?: string;
    cssClasses?: string[];
    cssPrefix?: string;
    disabled?: boolean;
    hidden?: boolean;
    id?: string;
    role?: string;
    skippableMessage?: string;
    tabIndex?: number;
    tag?: string;
    text?: LocalizableText;
    untilSkippableMessage?: string;
}

Hierarchy (view full)

Properties

acceptsTouchWithUiHidden? ariaLabel? cssClass? cssClasses? cssPrefix? disabled? hidden? id? role? skippableMessage? tabIndex? tag? text? untilSkippableMessage?

Properties

OptionalacceptsTouchWithUiHidden

acceptsTouchWithUiHidden?: boolean

Specifies whether the first touch event received by the UIContainer should be prevented or not.

Default: false

OptionalariaLabel

ariaLabel?: LocalizableText

WCAG20 standard for defining info about the component (usually the name)

OptionalcssClass

cssClass?: string

The CSS classes of the component. This is usually the class from where the component takes its styling.

OptionalcssClasses

cssClasses?: string[]

Additional CSS classes of the component.

OptionalcssPrefix

cssPrefix?: string

A prefix to prepend all CSS classes with.

Optionaldisabled

disabled?: boolean

Specifies if the component is enabled (interactive) or not. Default: false

Optionalhidden

hidden?: boolean

Specifies if the component should be hidden at startup. Default: false

Optionalid

id?: string

The HTML ID of the component. Default: automatically generated with pattern 'ui-id-{guid}'.

Optionalrole

role?: string

Specifies the component role for WCAG20 standard

OptionalskippableMessage

skippableMessage?: string

Message displayed when the ad is skippable. Supported placeholders: look at StringUtils.replaceAdMessagePlaceholders

OptionaltabIndex

tabIndex?: number

WCAG20 requirement for screen reader navigation

Optionaltag

tag?: string

The HTML tag name of the component. Default: 'div'

Optionaltext

text?: LocalizableText

The text as string or localize callback on the button.

OptionaluntilSkippableMessage

untilSkippableMessage?: string

Message which gets displayed during the countdown is active. Supported placeholders: look at StringUtils.replaceAdMessagePlaceholders

Settings

Member Visibility

On This Page

Properties