@jupyterlite / @jupyterlite/apputils / LiteExtensionListModel
Class: LiteExtensionListModel#
Defined in: packages/apputils/src/extensionmanager.ts:21
The extension manager model for JupyterLite.
Lists the federated extensions shipped with the site from their package.json,
instead of querying the server extensions API.
Extends#
ListModel
Constructors#
Constructor#
new LiteExtensionListModel(
serviceManager,translator?):LiteExtensionListModel
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:136
Parameters#
serviceManager#
IManager
translator?#
ITranslator
Returns#
LiteExtensionListModel
Inherited from#
ListModel.constructor
Properties#
actionError#
actionError:
string|null
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:308
Inherited from#
ListModel.actionError
canInstall#
readonlycanInstall:boolean
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:148
Whether the extension manager supports installing extensions.
When false, extensions are listed read-only: there is no registry to
search and no un-/installation. They can still be enabled or disabled
when canManage is true.
Inherited from#
ListModel.canInstall
canManage#
readonlycanManage:boolean
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:156
Whether the extension manager supports enabling and disabling extensions.
It is independent of canInstall, so a read-only manager still
exposes enable and disable actions by default. Set it to false for a
pure listing with no actions at all.
Inherited from#
ListModel.canManage
installedError#
installedError:
string|null
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:312
Contains an error message if an error occurred when querying installed extensions.
Inherited from#
ListModel.installedError
installPath#
installPath:
string|null
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:160
Extensions installation path.
Inherited from#
ListModel.installPath
name#
readonlyname:string
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:140
Extension manager name.
Inherited from#
ListModel.name
promptReload#
promptReload:
boolean
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:320
Whether a reload should be considered due to actions taken.
Inherited from#
ListModel.promptReload
searchError#
searchError:
string|null
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:316
Contains an error message if an error occurred when searching for extensions.
Inherited from#
ListModel.searchError
serviceManager#
protectedserviceManager:IManager
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:324
The service manager to use for building.
Inherited from#
ListModel.serviceManager
stateChanged#
readonlystateChanged:Signal<LiteExtensionListModel,void>
Defined in: node_modules/@jupyterlab/ui-components/lib/components/vdom.d.ts:195
A signal emitted when any model state changes.
Inherited from#
ListModel.stateChanged
translator#
protectedtranslator:ITranslator
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:325
Inherited from#
ListModel.translator
Accessors#
canFetch#
Get Signature#
get canFetch():
boolean
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:178
Whether the model may fetch data from external web services, such as extension author avatars.
Notes#
Fetching requires the user to have accepted the disclaimer (see isDisclaimed); this holds for a read-only manager too.
Returns#
boolean
Inherited from#
ListModel.canFetch
canPerformActions#
Get Signature#
get canPerformActions():
boolean
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:187
Whether actions may currently be performed on installed extensions.
Notes#
Requires canManage. An installable manager additionally requires the disclaimer, as its actions may contact external services; a read-only manager only toggles extensions locally.
Returns#
boolean
Inherited from#
ListModel.canPerformActions
installed#
Get Signature#
get installed(): readonly
IEntry[]
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:164
A readonly array of the installed extensions.
Returns#
readonly IEntry[]
Inherited from#
ListModel.installed
isDisclaimed#
Get Signature#
get isDisclaimed():
boolean
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:168
Whether the warning is disclaimed or not.
Returns#
boolean
Set Signature#
set isDisclaimed(
v):void
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:169
Parameters#
v#
boolean
Returns#
void
Inherited from#
ListModel.isDisclaimed
isDisposed#
Get Signature#
get isDisposed():
boolean
Defined in: node_modules/@jupyterlab/ui-components/lib/components/vdom.d.ts:199
Test whether the model is disposed.
Returns#
boolean
Inherited from#
ListModel.isDisposed
isEnabled#
Get Signature#
get isEnabled():
boolean
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:191
Whether the extension manager is enabled or not.
Returns#
boolean
Set Signature#
set isEnabled(
v):void
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:192
Parameters#
v#
boolean
Returns#
void
Inherited from#
ListModel.isEnabled
isLoadingInstalledExtensions#
Get Signature#
get isLoadingInstalledExtensions():
boolean
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:193
Returns#
boolean
Inherited from#
ListModel.isLoadingInstalledExtensions
isSearching#
Get Signature#
get isSearching():
boolean
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:194
Returns#
boolean
Inherited from#
ListModel.isSearching
lastPage#
Get Signature#
get lastPage():
number
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:226
The last page of results in the current search.
Returns#
number
Inherited from#
ListModel.lastPage
page#
Get Signature#
get page():
number
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:214
The current search page.
Setting its value triggers a new search.
Notes#
First page is 1.
Returns#
number
Set Signature#
set page(
value):void
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:215
Parameters#
value#
number
Returns#
void
Inherited from#
ListModel.page
pagination#
Get Signature#
get pagination():
number
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:221
The search pagination.
Setting its value triggers a new search.
Returns#
number
Set Signature#
set pagination(
value):void
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:222
Parameters#
value#
number
Returns#
void
Inherited from#
ListModel.pagination
query#
Get Signature#
get query():
string
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:204
The search query.
Setting its value triggers a new search.
Returns#
string
Set Signature#
set query(
value):void
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:205
Parameters#
value#
string
Returns#
void
Inherited from#
ListModel.query
searchResult#
Get Signature#
get searchResult(): readonly
IEntry[]
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:198
A readonly array containing the latest search result
Returns#
readonly IEntry[]
Inherited from#
ListModel.searchResult
Methods#
addPendingAction()#
protectedaddPendingAction(pending):void
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:307
Add a pending action.
Parameters#
pending#
Promise<any>
A promise that resolves when the action is completed.
Returns#
void
Inherited from#
ListModel.addPendingAction
disable()#
disable(
entry):Promise<void>
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:261
Disable an extension.
Parameters#
entry#
IEntry
An entry indicating which extension to disable.
Returns#
Promise<void>
Inherited from#
ListModel.disable
dispose()#
dispose():
void
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:230
Dispose the extensions list model.
Returns#
void
Inherited from#
ListModel.dispose
enable()#
enable(
entry):Promise<void>
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:255
Enable an extension.
Parameters#
entry#
IEntry
An entry indicating which extension to enable.
Returns#
Promise<void>
Inherited from#
ListModel.enable
fetchInstalled()#
protectedfetchInstalled(force):Promise<IEntry[]>
Defined in: packages/apputils/src/extensionmanager.ts:28
Fetch the federated extensions of the site as extension entries.
Extensions disabled via the disabledExtensions of the site are skipped, as
they cannot be enabled from the browser.
Parameters#
force#
boolean
Returns#
Promise<IEntry[]>
Overrides#
ListModel.fetchInstalled
hasPendingActions()#
hasPendingActions():
boolean
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:234
Whether there are currently any actions pending.
Returns#
boolean
Inherited from#
ListModel.hasPendingActions
install()#
install(
entry,options?):Promise<void>
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:241
Install an extension.
Parameters#
entry#
IEntry
An entry indicating which extension to install.
options?#
Additional options for the action.
useVersion?#
string
Returns#
Promise<void>
Inherited from#
ListModel.install
performAction()#
protectedperformAction(action,entry):Promise<IActionReply>
Defined in: packages/apputils/src/extensionmanager.ts:59
Store the extension enabled or disabled by the user, and offer to reload the page to apply it.
Parameters#
action#
string
entry#
IEntry
Returns#
Promise<IActionReply>
Overrides#
ListModel.performAction
refreshInstalled()#
refreshInstalled(
force?):Promise<void>
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:267
Refresh installed packages
Parameters#
force?#
boolean
Force refreshing the list of installed packages
Returns#
Promise<void>
Inherited from#
ListModel.refreshInstalled
search()#
protectedsearch(force?):Promise<void>
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:285
Search with current query.
Sets searchError and totalEntries as appropriate.
Parameters#
force?#
boolean
Returns#
Promise<void>
The extensions matching the current query.
Inherited from#
ListModel.search
uninstall()#
uninstall(
entry):Promise<void>
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:249
Uninstall an extension.
Parameters#
entry#
IEntry
An entry indicating which extension to uninstall.
Returns#
Promise<void>
Inherited from#
ListModel.uninstall
update()#
protectedupdate(force?):Promise<void>
Defined in: node_modules/@jupyterlab/extensionmanager/lib/model.d.ts:293
Update the current model.
This will query the packages repository, and the notebook server.
Emits the stateChanged signal on successful completion.
Parameters#
force?#
boolean
Returns#
Promise<void>
Inherited from#
ListModel.update