@univerjs/ui v0.5.4


Class: UniverUIPlugin

Defined in: submodules/univer/packages/ui/src/ui-plugin.ts:67

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

Extends

Constructors

new UniverUIPlugin()

new UniverUIPlugin(
   _config, 
   _contextService, 
   _injector, 
   _configService): UniverUIPlugin

Defined in: submodules/univer/packages/ui/src/ui-plugin.ts:70

Parameters

ParameterTypeDefault value
_configPartial<IUniverUIConfig>defaultPluginConfig
_contextServiceIContextServiceundefined
_injectorInjectorundefined
_configServiceIConfigServiceundefined

Returns

UniverUIPlugin

Overrides

Plugin.constructor

Properties

PropertyModifierTypeDefault valueOverridesInherited fromDefined in
_disposedprotectedbooleanfalse-Plugin._disposedsubmodules/univer/packages/core/src/shared/lifecycle.ts:96
_injectorreadonlyInjectorundefined-Plugin._injectorsubmodules/univer/packages/ui/src/ui-plugin.ts:73
pluginNamestaticstringUNIVER_UI_PLUGIN_NAMEPlugin.pluginName-submodules/univer/packages/ui/src/ui-plugin.ts:68
typestaticUniverInstanceTypeUniverInstanceType.UNIVER_UNKNOWN-Plugin.typesubmodules/univer/packages/core/src/services/plugin/plugin.ts:35

Methods

dispose()

dispose(): void

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:109

Returns

void

Inherited from

Plugin.dispose


disposeWithMe()

disposeWithMe(disposable): IDisposable

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:99

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Plugin.disposeWithMe


ensureNotDisposed()

protected ensureNotDisposed(): void

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:103

Returns

void

Inherited from

Plugin.ensureNotDisposed


getPluginName()

getPluginName(): string

Defined in: submodules/univer/packages/core/src/services/plugin/plugin.ts:59

Returns

string

Inherited from

Plugin.getPluginName


getUniverInstanceType()

getUniverInstanceType(): UniverInstanceType

Defined in: submodules/univer/packages/core/src/services/plugin/plugin.ts:55

Returns

UniverInstanceType

Inherited from

Plugin.getUniverInstanceType


onReady()

onReady(): void

Defined in: submodules/univer/packages/ui/src/ui-plugin.ts:131

Returns

void

Overrides

Plugin.onReady


onRendered()

onRendered(): void

Defined in: submodules/univer/packages/core/src/services/plugin/plugin.ts:47

Returns

void

Inherited from

Plugin.onRendered


onStarting()

onStarting(): void

Defined in: submodules/univer/packages/ui/src/ui-plugin.ts:93

Returns

void

Overrides

Plugin.onStarting


onSteady()

onSteady(): void

Defined in: submodules/univer/packages/ui/src/ui-plugin.ts:135

Returns

void

Overrides

Plugin.onSteady