@univerjs/ui v0.4.2 • 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, 
   _configService): UniverUIPlugin

Parameters

Returns

UniverUIPlugin

Overrides

Plugin.constructor

Defined in

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

Properties

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()

disposeWithMe(disposable): IDisposable

Parameters

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:59 (opens in a new tab)

getUniverInstanceType()

getUniverInstanceType(): UniverInstanceType

Returns

UniverInstanceType

Inherited from

Plugin.getUniverInstanceType

Defined in

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

onReady()

onReady(): void

Returns

void

Overrides

Plugin.onReady

Defined in

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

onRendered()

onRendered(): void

Returns

void

Inherited from

Plugin.onRendered

Defined in

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

onStarting()

onStarting(): void

Returns

void

Overrides

Plugin.onStarting

Defined in

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

onSteady()

onSteady(): void

Returns

void

Overrides

Plugin.onSteady

Defined in

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