For AI agents: the complete documentation index is available at https://types-mediawiki-response.pages.dev/zh/llms.txt, the full documentation bundle is available at https://types-mediawiki-response.pages.dev/zh/llms-full.txt, and this page is available as Markdown at https://types-mediawiki-response.pages.dev/zh/api/extensions/gadgets/ApiGadgetSettings.md.
  • 中文
  • Interface: ApiGadgetSettings

    Defined in: extensions/gadgets.ts:24

    The metadata.settings block of a gadget definition.

    Properties

    actions

    actions: string[]

    Defined in: extensions/gadgets.ts:26

    Interface actions the gadget needs, e.g. edit.


    categories?

    optional categories?: string[]

    Defined in: extensions/gadgets.ts:33

    Categories the gadget needs the page to be in.

    Since

    MediaWiki 1.42


    category?

    optional category?: string

    Defined in: extensions/gadgets.ts:40

    Definition category this gadget was declared under ("" when none).

    Deprecated

    since MediaWiki 1.44; superseded by categories.


    contentModels?

    optional contentModels?: string[]

    Defined in: extensions/gadgets.ts:47

    Content models the gadget applies to.

    Since

    MediaWiki 1.41


    default

    default: boolean

    Defined in: extensions/gadgets.ts:50

    Whether the gadget is on by default.


    hidden

    hidden: boolean

    Defined in: extensions/gadgets.ts:53

    Whether the gadget is hidden from the preferences list.


    legacyscripts?

    optional legacyscripts?: boolean

    Defined in: extensions/gadgets.ts:60

    Whether legacy (non-ResourceLoader) scripts are used.

    Deprecated

    since MediaWiki 1.47; the key is no longer emitted.


    namespaces?

    optional namespaces?: number[]

    Defined in: extensions/gadgets.ts:67

    Namespace indexes the gadget applies to.

    Since

    MediaWiki 1.41


    package

    package: boolean

    Defined in: extensions/gadgets.ts:70

    Whether the gadget is packaged with the extension.


    requiresES6?

    optional requiresES6?: boolean

    Defined in: extensions/gadgets.ts:78

    Whether the gadget requires ES6.

    Since

    MediaWiki 1.40

    Deprecated

    since MediaWiki 1.47; the key is no longer emitted.


    rights

    rights: string[]

    Defined in: extensions/gadgets.ts:81

    Rights the user must hold.


    section?

    optional section?: string

    Defined in: extensions/gadgets.ts:88

    Definition section this gadget was declared under ("" when none).

    Since

    MediaWiki 1.44


    shared

    shared: boolean

    Defined in: extensions/gadgets.ts:94

    Whether the gadget comes from a shared/common repo. The API module reports false for every gadget.


    skins

    skins: string[]

    Defined in: extensions/gadgets.ts:97

    Skins the gadget applies to.


    supportsUrlLoad

    supportsUrlLoad: boolean

    Defined in: extensions/gadgets.ts:100

    Whether the gadget can be loaded via load.php gadget URLs.