@univerjs/ui v0.1.17 • Docs

Class: UniverUIPlugin

UI plugin provides basic interaction with users. Including workbench (menus, UI parts, notifications etc.), copy paste, shortcut.

Extends

Plugin

Constructors

new UniverUIPlugin()

new UniverUIPlugin(
   _config, 
   _contextService, 
   _injector): UniverUIPlugin

Parameters

Parameter	Type
`_config`	`Partial`<`IUniverUIConfig`>
`_contextService`	`IContextService`
`_injector`	`Injector`

Properties

Property	Modifier	Type	Default value	Overrides	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	-	`Plugin`.`_disposed`	packages/core/src/shared/lifecycle.ts:93 (opens in a new tab)
`_injector`	`readonly`	`Injector`	`undefined`	-	`Plugin`.`_injector`	packages/ui/src/ui-plugin.ts:76 (opens in a new tab)
`pluginName`	`static`	`string`	`PLUGIN_NAME`	`Plugin`.`pluginName`	-	packages/ui/src/ui-plugin.ts:71 (opens in a new tab)
`type`	`static`	`UniverInstanceType`	`UniverInstanceType.UNIVER_UNKNOWN`	-	`Plugin`.`type`	packages/core/src/services/plugin/plugin.ts:35 (opens in a new tab)

Methods

dispose()

dispose(): void

Returns

void

Inherited from

Plugin.dispose

Defined in

packages/core/src/shared/lifecycle.ts:106 (opens in a new tab)

disposeWithMe()

protected disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

Plugin.disposeWithMe

Defined in

packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Plugin.ensureNotDisposed

Defined in

packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)

getPluginName()

getPluginName(): string

Returns

string

Inherited from

Plugin.getPluginName

Defined in

packages/core/src/services/plugin/plugin.ts:60 (opens in a new tab)

getUniverInstanceType()

getUniverInstanceType(): UniverInstanceType

Returns

UniverInstanceType

Inherited from

Plugin.getUniverInstanceType

Defined in

packages/core/src/services/plugin/plugin.ts:56 (opens in a new tab)

onReady()

onReady(): void

Returns

void

Inherited from

Plugin.onReady

Defined in

packages/core/src/services/plugin/plugin.ts:44 (opens in a new tab)

onRendered()

onRendered(): void

Returns

void

Inherited from

Plugin.onRendered

Defined in

packages/core/src/services/plugin/plugin.ts:48 (opens in a new tab)

onStarting()

onStarting(injector): void

Parameters

Parameter	Type
`injector`	`Injector`

Returns

void

Overrides

Plugin.onStarting

Defined in

packages/ui/src/ui-plugin.ts:87 (opens in a new tab)

onSteady()

onSteady(): void

Returns

void

Inherited from

Plugin.onSteady

Defined in

packages/core/src/services/plugin/plugin.ts:52 (opens in a new tab)

Uipartsservice Zindexmanager