Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IConsoleCreator<T>

Interface for a command to create a console for an activity.

Type parameters

  • T: Widget

Hierarchy

Index

Properties

Properties

createConsole

createConsole: (widget: T) => Promise<void>

The function to create the console.

Type declaration

    • (widget: T): Promise<void>

    • Parameters

      • widget: T

      Returns Promise<void>

Optional createConsoleLabel

createConsoleLabel: (n: number) => string

A function to create the label for the createConsoleaction.

This function receives the number of items n to be able to provided correct pluralized forms of tranlsations.

Type declaration

    • (n: number): string

    • Parameters

      • n: number

      Returns string

Optional isEnabled

isEnabled: (widget: T) => boolean

An additional function that determines whether the extender is enabled. By default it is considered enabled if the application active widget is contained in the tracker. If this is also provided, the criterion is equivalent to tracker.has(widget) && extender.isEnabled(widget)

Type declaration

    • (widget: T): boolean

    • Parameters

      • widget: T

      Returns boolean

tracker

tracker: IWidgetTracker<T>

A widget tracker for identifying the appropriate extender.

Generated using TypeDoc