> For AI agents: the complete documentation index is available at https://types-mediawiki-response.pages.dev/llms.txt, the full documentation bundle is available at https://types-mediawiki-response.pages.dev/llms-full.txt.

# Interface: ApiGadgetSettings

Defined in: [extensions/gadgets.ts:24](https://github.com/BearBin1215/types-mediawiki-response/blob/c1e25ea2ef2684b43c79e05d6e0dd36e33fbc9a3/src/extensions/gadgets.ts#L24)

The `metadata.settings` block of a gadget definition.

## Properties

### actions

> **actions**: `string`\[]

Defined in: [extensions/gadgets.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/c1e25ea2ef2684b43c79e05d6e0dd36e33fbc9a3/src/extensions/gadgets.ts#L26)

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

***

### categories?

> `optional` **categories?**: `string`\[]

Defined in: [extensions/gadgets.ts:33](https://github.com/BearBin1215/types-mediawiki-response/blob/c1e25ea2ef2684b43c79e05d6e0dd36e33fbc9a3/src/extensions/gadgets.ts#L33)

Categories the gadget needs the page to be in.

#### Since

MediaWiki 1.42

***

### ~~category?~~

> `optional` **category?**: `string`

Defined in: [extensions/gadgets.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/c1e25ea2ef2684b43c79e05d6e0dd36e33fbc9a3/src/extensions/gadgets.ts#L40)

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

#### Deprecated

since MediaWiki 1.44; superseded by [categories](#categories).

***

### contentModels?

> `optional` **contentModels?**: `string`\[]

Defined in: [extensions/gadgets.ts:47](https://github.com/BearBin1215/types-mediawiki-response/blob/c1e25ea2ef2684b43c79e05d6e0dd36e33fbc9a3/src/extensions/gadgets.ts#L47)

Content models the gadget applies to.

#### Since

MediaWiki 1.41

***

### default

> **default**: `boolean`

Defined in: [extensions/gadgets.ts:50](https://github.com/BearBin1215/types-mediawiki-response/blob/c1e25ea2ef2684b43c79e05d6e0dd36e33fbc9a3/src/extensions/gadgets.ts#L50)

Whether the gadget is on by default.

***

### hidden

> **hidden**: `boolean`

Defined in: [extensions/gadgets.ts:53](https://github.com/BearBin1215/types-mediawiki-response/blob/c1e25ea2ef2684b43c79e05d6e0dd36e33fbc9a3/src/extensions/gadgets.ts#L53)

Whether the gadget is hidden from the preferences list.

***

### ~~legacyscripts?~~

> `optional` **legacyscripts?**: `boolean`

Defined in: [extensions/gadgets.ts:60](https://github.com/BearBin1215/types-mediawiki-response/blob/c1e25ea2ef2684b43c79e05d6e0dd36e33fbc9a3/src/extensions/gadgets.ts#L60)

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](https://github.com/BearBin1215/types-mediawiki-response/blob/c1e25ea2ef2684b43c79e05d6e0dd36e33fbc9a3/src/extensions/gadgets.ts#L67)

Namespace indexes the gadget applies to.

#### Since

MediaWiki 1.41

***

### package

> **package**: `boolean`

Defined in: [extensions/gadgets.ts:70](https://github.com/BearBin1215/types-mediawiki-response/blob/c1e25ea2ef2684b43c79e05d6e0dd36e33fbc9a3/src/extensions/gadgets.ts#L70)

Whether the gadget is packaged with the extension.

***

### ~~requiresES6?~~

> `optional` **requiresES6?**: `boolean`

Defined in: [extensions/gadgets.ts:78](https://github.com/BearBin1215/types-mediawiki-response/blob/c1e25ea2ef2684b43c79e05d6e0dd36e33fbc9a3/src/extensions/gadgets.ts#L78)

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](https://github.com/BearBin1215/types-mediawiki-response/blob/c1e25ea2ef2684b43c79e05d6e0dd36e33fbc9a3/src/extensions/gadgets.ts#L81)

Rights the user must hold.

***

### section?

> `optional` **section?**: `string`

Defined in: [extensions/gadgets.ts:88](https://github.com/BearBin1215/types-mediawiki-response/blob/c1e25ea2ef2684b43c79e05d6e0dd36e33fbc9a3/src/extensions/gadgets.ts#L88)

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

#### Since

MediaWiki 1.44

***

### shared

> **shared**: `boolean`

Defined in: [extensions/gadgets.ts:94](https://github.com/BearBin1215/types-mediawiki-response/blob/c1e25ea2ef2684b43c79e05d6e0dd36e33fbc9a3/src/extensions/gadgets.ts#L94)

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](https://github.com/BearBin1215/types-mediawiki-response/blob/c1e25ea2ef2684b43c79e05d6e0dd36e33fbc9a3/src/extensions/gadgets.ts#L97)

Skins the gadget applies to.

***

### supportsUrlLoad

> **supportsUrlLoad**: `boolean`

Defined in: [extensions/gadgets.ts:100](https://github.com/BearBin1215/types-mediawiki-response/blob/c1e25ea2ef2684b43c79e05d6e0dd36e33fbc9a3/src/extensions/gadgets.ts#L100)

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