@univerjs/ui v0.5.4


Interface: ILayoutService

Defined in: submodules/univer/packages/ui/src/services/layout/layout.service.ts:34

Properties

PropertyModifierTypeDefined in
isFocusedreadonlybooleansubmodules/univer/packages/ui/src/services/layout/layout.service.ts:35

Accessors

rootContainerElement

Get Signature

get rootContainerElement(): Nullable<HTMLElement>

Defined in: submodules/univer/packages/ui/src/services/layout/layout.service.ts:37

Returns

Nullable<HTMLElement>

Methods

checkContentIsFocused()

checkContentIsFocused(): boolean

Defined in: submodules/univer/packages/ui/src/services/layout/layout.service.ts:53

Returns

boolean


checkElementInCurrentContainers()

checkElementInCurrentContainers(element): boolean

Defined in: submodules/univer/packages/ui/src/services/layout/layout.service.ts:52

Parameters

ParameterType
elementHTMLElement

Returns

boolean


focus()

focus(): void

Defined in: submodules/univer/packages/ui/src/services/layout/layout.service.ts:39

Re-focus the currently focused Univer business instance.

Returns

void


getContentElement()

getContentElement(): HTMLElement

Defined in: submodules/univer/packages/ui/src/services/layout/layout.service.ts:50

Returns

HTMLElement


registerContainerElement()

registerContainerElement(container): IDisposable

Defined in: submodules/univer/packages/ui/src/services/layout/layout.service.ts:48

Register an element as a container, especially floating components like Dialogs and Notifications.

Parameters

ParameterType
containerHTMLElement

Returns

IDisposable


registerContentElement()

registerContentElement(container): IDisposable

Defined in: submodules/univer/packages/ui/src/services/layout/layout.service.ts:46

Register a content element.

Parameters

ParameterType
containerHTMLElement

Returns

IDisposable


registerFocusHandler()

registerFocusHandler(type, handler): IDisposable

Defined in: submodules/univer/packages/ui/src/services/layout/layout.service.ts:42

Register a focus handler to focus on certain type of Univer unit.

Parameters

ParameterType
typeUniverInstanceType
handlerFocusHandlerFn

Returns

IDisposable


registerRootContainerElement()

registerRootContainerElement(container): IDisposable

Defined in: submodules/univer/packages/ui/src/services/layout/layout.service.ts:44

Register the root container element.

Parameters

ParameterType
containerHTMLElement

Returns

IDisposable