Class H5PConfirmationDialog

Hierarchy (View Summary)

EventDispatcher
- H5PConfirmationDialog

Index

Constructors

constructor

new H5PConfirmationDialog(
    options: {
        cancelText?: string;
        classes?: string[];
        confirmText?: string;
        dialogText?: string;
        headerText?: string;
        hideCancel?: boolean;
        hideExit?: boolean;
        instance: IH5PContentType;
        skipRestoreFocus?: boolean;
    },
): H5PConfirmationDialog
Parameters
- options: {
      cancelText?: string;
      classes?: string[];
      confirmText?: string;
      dialogText?: string;
      headerText?: string;
      hideCancel?: boolean;
      hideExit?: boolean;
      instance: IH5PContentType;
      skipRestoreFocus?: boolean;
  }
Returns H5PConfirmationDialog
Overrides EventDispatcher.constructor
- Defined in types/H5PConfirmationDialog.ts:5

Properties

off

off: <TData = unknown>(type: string, listener?: (event: TData) => void) => void

Remove event listener If no listener is specified, all listeners will be removed

Type declaration

- <TData = unknown>(type: string, listener?: (event: TData) => void): void
- Type Parameters
  - TData = unknown
  Parameters
  - type: string
    Event type
  - Optionallistener: (event: TData) => void
    Event listener
  Returns void

Throws

listener must be a function

on

on: <TData = unknown, TType extends string = string>(
    type: TType,
    listener: EventListener<TData, TType>,
    thisArg?: ThisType<unknown>,
) => void

Add new event listener

Type declaration

- <TData = unknown, TType extends string = string>(
      type: TType,
      listener: EventListener<TData, TType>,
      thisArg?: ThisType<unknown>,
  ): void
- Type Parameters
  - TData = unknown
  - TType extends string = string
  Parameters
  - type: TType
    Event type. If the event type is xAPI, the listener's event parameter will be of type XAPIEvent. Any dispatched XAPIEvent will trigger the xAPI event.
  - listener: EventListener<TData, TType>
    Event listener
  - OptionalthisArg: ThisType<unknown>
    Optionally specify the listener's this value
  Returns void

Throws

listener must be a function

once

once: <TData = unknown, TType extends string = string>(
    type: TType,
    listener: EventListener<TData, TType>,
    thisArg?: ThisType<unknown>,
) => void

Add new event listener that will be fired only once

Type declaration

- <TData = unknown, TType extends string = string>(
      type: TType,
      listener: EventListener<TData, TType>,
      thisArg?: ThisType<unknown>,
  ): void
- Type Parameters
  - TData = unknown
  - TType extends string = string
  Parameters
  - type: TType
    Event type. If the event type is xAPI, the listener's event parameter will be of type XAPIEvent. Any dispatched XAPIEvent will trigger the xAPI event.
  - listener: EventListener<TData, TType>
    Event listener
  - OptionalthisArg: ThisType<unknown>
    Optionally specify the listener's this value
  Returns void

Throws

listener must be a function

trigger

trigger: <TData = unknown>(
    event: unknown,
    eventData?: TData,
    extras?: { bubbles?: boolean; external?: boolean },
) => void

Dispatch event

Type declaration

- <TData = unknown>(
      event: unknown,
      eventData?: TData,
      extras?: { bubbles?: boolean; external?: boolean },
  ): void
- Type Parameters
  - TData = unknown
  Parameters
  - event: unknown
    Event object or event type as string
  - OptionaleventData: TData
    Custom event data (used when event type as string is used as first argument)
  - Optionalextras: { bubbles?: boolean; external?: boolean }
  Returns void

triggerXAPI

triggerXAPI: (verb: XAPIVerb, extra: unknown) => void

Methods

createXAPIEventTemplate

createXAPIEventTemplate<TVerb extends XAPIVerb>(
verb: TVerb,
extra: unknown,
): XAPIEvent
Type Parameters
- TVerb extends XAPIVerb
Parameters
- verb: TVerb
- extra: unknown
Returns XAPIEvent
Inherited from EventDispatcher.createXAPIEventTemplate
- Defined in types/EventDispatcher.ts:72

getElement

getElement(): HTMLElement
Returns HTMLElement
The ConfirmationDialog HTML element
- Defined in types/H5PConfirmationDialog.ts:23

getPreviouslyFocused

getPreviouslyFocused(): HTMLElement
Returns HTMLElement
The element that had focus before the ConfirmationDialog was opened
- Defined in types/H5PConfirmationDialog.ts:28

hide

hide(): ThisType<H5PConfirmationDialog>
Returns ThisType<H5PConfirmationDialog>
- Defined in types/H5PConfirmationDialog.ts:18

setViewPortMinimumHeight

setViewPortMinimumHeight(minimumHeight: null | number): void
Parameters
- minimumHeight: null | number
Returns void
- Defined in types/H5PConfirmationDialog.ts:30

show

show(offsetTop: number): ThisType<H5PConfirmationDialog>
Parameters
- offsetTop: number
Returns ThisType<H5PConfirmationDialog>
- Defined in types/H5PConfirmationDialog.ts:17

Class H5PConfirmationDialog

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns H5PConfirmationDialog

Properties

off

Type declaration

Type Parameters

Parameters

Returns void

Throws

on

Type declaration

Type Parameters

Parameters

Returns void

Throws

once

Type declaration

Type Parameters

Parameters

Returns void

Throws

trigger

Type declaration

Type Parameters

Parameters

Returns void

triggerXAPI

Methods

createXAPIEventTemplate

Type Parameters

Parameters

Returns XAPIEvent

getElement

Returns HTMLElement

getPreviouslyFocused

Returns HTMLElement

hide

Returns ThisType<H5PConfirmationDialog>

setViewPortMinimumHeight

Parameters

Returns void

show

Parameters

Returns ThisType<H5PConfirmationDialog>

Settings

On This Page