Class GalleryPlugin

Readonlyconfig

addEventListener

• addEventListener<
      T extends "show-gallery"
      | "hide-gallery",
      E extends GalleryPluginEvents & { type: T },
  >(
      type: T,
      callback: EventListenerObject | (e: E) => void,
      options?: boolean | AddEventListenerOptions,
  ): void

• Type Parameters

  • T extends "show-gallery" | "hide-gallery"

    the name of event
  • E extends GalleryPluginEvents & { type: T }

    the class of the event

  Parameters

  • type: T
  • callback: EventListenerObject | (e: E) => void
  • Optionaloptions: boolean | AddEventListenerOptions

  Returns void

dispatchEvent

• dispatchEvent(e: GalleryPluginEvents): boolean

• Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

  MDN Reference

  Parameters

  • e: GalleryPluginEvents

  Returns boolean

removeEventListener

• removeEventListener<
      T extends "show-gallery"
      | "hide-gallery",
      E extends GalleryPluginEvents & { type: T },
  >(
      type: "show-gallery" | "hide-gallery",
      callback: EventListenerObject | (e: E) => void,
      options?: boolean | EventListenerOptions,
  ): void

• Type Parameters

  • T extends "show-gallery" | "hide-gallery"

    the name of event
  • E extends GalleryPluginEvents & { type: T }

    the class of the event

  Parameters

  • type: "show-gallery" | "hide-gallery"
  • callback: EventListenerObject | (e: E) => void
  • Optionaloptions: boolean | EventListenerOptions

  Returns void

setOption

• setOption<T extends "hideOnClick" | "thumbnailSize">(
      option: T,
      value: UpdatableGalleryPluginConfig[T],
  ): void

• Update options

  Type Parameters

  • T extends "hideOnClick" | "thumbnailSize"

  Parameters

  • option: T
  • value: UpdatableGalleryPluginConfig[T]

  Returns void