Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TwinkleModule

Base class for all Twinkle modules

Hierarchy

Index

Constructors

constructor

Properties

footerlinks

footerlinks: {}

Set of links shown in the bottom right of the module dialog. Object keys are labels and values are the wiki page names.

Type declaration

  • [label: string]: string

moduleName

moduleName: string

portletId

portletId: string

Optional ID for the portlet. This defaults to twinkle-${portletName.toLowerCase()} if unspecified

portletName

portletName: string

Name displayed on the portlet

portletTooltip

portletTooltip: string

Tooltip shown when hovering on the portlet

Static moduleName

moduleName: string

The name of the module, used to check if the user has the module disabled

Methods

addMenu

  • addMenu(): void

addPreference

  • addPreference(pref: any): void
  • Add a preference to this module's preference group

    Parameters

    • pref: any

    Returns void

makeWindow

  • makeWindow(): void
  • Generate the GUI dialog for this module. Invoked when the portlet generated by addMenu is clicked.

    Returns void

Static userPreferences

Generated using TypeDoc