Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Injected

JavaScript-injected user interface elements for Poppy I/O clients.

Using this is optional - you can supply your own user interface code, but for convenience this provides a basic implementation of a Launcher and Modal Overlay as a JavaScript module.

To use it you need to install localized user-facing strings using one of the "inject-*" modules, for instance:

import "poppyio/inject-en";

The "inject-*" modules only have side effects and don't export any members. Installation occurs by passing an object with the strings to the add() method.

Hierarchy

  • Injected

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Static translations

translations: undefined | {}[]

Available translations

Methods

Static add

  • add(translation: {}): void

  • Add localized strings to the UI, and if not yet configured set a default launcher and/or overlay in ModalRequest using those strings.

    Parameters

    • translation: {}

      localized strings to present in the UI

      • [key: string]: string

    Returns void

Static apply

  • apply<R>(tag: string, request: R): R

  • Install both a launcher and overlay for the given language into the specific request

    Type parameters

    Parameters

    • tag: string

      Language tag to create a UI for

    • request: R

      ModalRequest to configure UI for

    Returns R

    The request object given

Static launcher

  • launcher(tag: string): (popup: Window, request: ModalRequest) => void

  • Create a launcher function using the localized strings of the given tag. If no translation exists for the given tag, used the first one available. If none exist, presents an error message in the launcher.

    Parameters

    • tag: string

      Language tag of localized strings.

    Returns (popup: Window, request: ModalRequest) => void

    Launch function that can be assigned to ModalRequest.laucher

Static overlay

  • overlay(tag: string): undefined | ((request: ModalRequest) => () => void)

  • Create a modal overlay using the localized strings of the given tag. If no translation exists for the given tag, used the first one available. If none exist, returns nothing (undefined).

    Parameters

    • tag: string

      Language tag of localized strings.

    Returns undefined | ((request: ModalRequest) => () => void)

    Overlay function that can be assigned to ModalRequest.overlay

Generated using TypeDoc