[**@jupyterlite**](../../../README.md)

***

[@jupyterlite](../../../README.md) / [@jupyterlite/apputils](../README.md) / LitePluginListModel

# Class: LitePluginListModel

Defined in: [packages/apputils/src/pluginmanager.ts:10](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/apputils/src/pluginmanager.ts#L10)

Custom PluginModel for use in JupyterLite

## Extends

- `PluginListModel`

## Constructors

### Constructor

> **new LitePluginListModel**(`options`): `LitePluginListModel`

Defined in: [packages/apputils/src/pluginmanager.ts:14](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/apputils/src/pluginmanager.ts#L14)

Create a new PluginListModel.

#### Parameters

##### options

`IOptions`

#### Returns

`LitePluginListModel`

#### Overrides

`PluginListModel.constructor`

## Properties

### actionError

> **actionError**: `null` \| `string`

Defined in: node\_modules/@jupyterlab/pluginmanager/lib/model.d.ts:97

Contains an error message if an error occurred when enabling/disabling plugin.

#### Inherited from

`PluginListModel.actionError`

***

### stateChanged

> `readonly` **stateChanged**: `Signal`\<`LitePluginListModel`, `void`\>

Defined in: node\_modules/@jupyterlab/ui-components/lib/components/vdom.d.ts:181

A signal emitted when any model state changes.

#### Inherited from

`PluginListModel.stateChanged`

***

### statusError

> **statusError**: `null` \| `string`

Defined in: node\_modules/@jupyterlab/pluginmanager/lib/model.d.ts:93

Contains an error message if an error occurred when querying plugin status.

#### Inherited from

`PluginListModel.statusError`

## Accessors

### available

#### Get Signature

> **get** **available**(): readonly `IEntry`[]

Defined in: [packages/apputils/src/pluginmanager.ts:32](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/apputils/src/pluginmanager.ts#L32)

##### Returns

readonly `IEntry`[]

#### Overrides

`PluginListModel.available`

***

### isDisclaimed

#### Get Signature

> **get** **isDisclaimed**(): `boolean`

Defined in: node\_modules/@jupyterlab/pluginmanager/lib/model.d.ts:105

Whether the warning is disclaimed or not.

##### Returns

`boolean`

#### Set Signature

> **set** **isDisclaimed**(`v`): `void`

Defined in: node\_modules/@jupyterlab/pluginmanager/lib/model.d.ts:106

##### Parameters

###### v

`boolean`

##### Returns

`void`

#### Inherited from

`PluginListModel.isDisclaimed`

***

### isDisposed

#### Get Signature

> **get** **isDisposed**(): `boolean`

Defined in: node\_modules/@jupyterlab/ui-components/lib/components/vdom.d.ts:185

Test whether the model is disposed.

##### Returns

`boolean`

#### Inherited from

`PluginListModel.isDisposed`

***

### isLoading

#### Get Signature

> **get** **isLoading**(): `boolean`

Defined in: node\_modules/@jupyterlab/pluginmanager/lib/model.d.ts:101

Whether plugin data is still getting loaded.

##### Returns

`boolean`

#### Inherited from

`PluginListModel.isLoading`

***

### query

#### Get Signature

> **get** **query**(): `string`

Defined in: node\_modules/@jupyterlab/pluginmanager/lib/model.d.ts:112

The search query.

Setting its value triggers a new search.

##### Returns

`string`

#### Set Signature

> **set** **query**(`value`): `void`

Defined in: node\_modules/@jupyterlab/pluginmanager/lib/model.d.ts:113

##### Parameters

###### value

`string`

##### Returns

`void`

#### Inherited from

`PluginListModel.query`

***

### ready

#### Get Signature

> **get** **ready**(): `Promise`\<`void`\>

Defined in: node\_modules/@jupyterlab/pluginmanager/lib/model.d.ts:121

A promise that resolves when the plugins were fetched from the server

##### Returns

`Promise`\<`void`\>

#### Inherited from

`PluginListModel.ready`

***

### trackerDataChanged

#### Get Signature

> **get** **trackerDataChanged**(): `ISignal`\<`PluginListModel`, `void`\>

Defined in: node\_modules/@jupyterlab/pluginmanager/lib/model.d.ts:117

A promise that resolves when the trackable data changes

##### Returns

`ISignal`\<`PluginListModel`, `void`\>

#### Inherited from

`PluginListModel.trackerDataChanged`

## Methods

### disable()

> **disable**(`entry`): `Promise`\<`void`\>

Defined in: [packages/apputils/src/pluginmanager.ts:44](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/apputils/src/pluginmanager.ts#L44)

Disable a plugin.

#### Parameters

##### entry

`IEntry`

An entry indicating which plugin to disable.

#### Returns

`Promise`\<`void`\>

Whether the plugin was disabled

#### Overrides

`PluginListModel.disable`

***

### dispose()

> **dispose**(): `void`

Defined in: node\_modules/@jupyterlab/ui-components/lib/components/vdom.d.ts:189

Dispose the model.

#### Returns

`void`

#### Inherited from

`PluginListModel.dispose`

***

### enable()

> **enable**(`entry`): `Promise`\<`void`\>

Defined in: [packages/apputils/src/pluginmanager.ts:40](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/apputils/src/pluginmanager.ts#L40)

Enable a plugin.

#### Parameters

##### entry

`IEntry`

An entry indicating which plugin to enable.

#### Returns

`Promise`\<`void`\>

#### Overrides

`PluginListModel.enable`

***

### getDependants()

> `protected` **getDependants**(`entry`): `object`

Defined in: node\_modules/@jupyterlab/pluginmanager/lib/model.d.ts:135

#### Parameters

##### entry

`IEntry`

#### Returns

`object`

##### dependants

> **dependants**: `IEntry`[]

##### optionalDependants

> **optionalDependants**: `IEntry`[]

#### Inherited from

`PluginListModel.getDependants`

***

### hasPendingActions()

> **hasPendingActions**(): `boolean`

Defined in: node\_modules/@jupyterlab/pluginmanager/lib/model.d.ts:142

Whether there are currently any actions pending.

#### Returns

`boolean`

#### Inherited from

`PluginListModel.hasPendingActions`

***

### refresh()

> **refresh**(): `Promise`\<`void`\>

Defined in: [packages/apputils/src/pluginmanager.ts:36](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/apputils/src/pluginmanager.ts#L36)

Refresh plugin lock statuses

#### Returns

`Promise`\<`void`\>

#### Overrides

`PluginListModel.refresh`