Skip to content

WorkspaceMobileDrawer

Official

Workspace mobile drawer.

Import:

import { WorkspaceMobileDrawer } from 'obsidian';

Signature:

export class WorkspaceMobileDrawer extends WorkspaceParent

Extends: WorkspaceParent

Constructor

new WorkspaceMobileDrawer()

Constructor.

To get the constructor instance, use getWorkspaceMobileDrawerConstructor from obsidian-typings/implementations.

Properties

PropertyTypeDescription
allowSingleChildbooleanWhether this parent is allowed to contain a single child (rather than collapsing it).
(Inherited from WorkspaceParent)
autoManageDOMbooleanWhether this parent automatically manages the DOM of its children.
(Inherited from WorkspaceParent)
childrenWorkspaceItem[]The child items contained in this parent.
(Inherited from WorkspaceParent)
collapsedbooleanWhether the mobile drawer is collapsed.
parentWorkspaceParentThe parent of the mobile drawer.

Methods

MethodReturnsDescription
collapse()voidCollapse the mobile drawer.
expand()voidExpand the mobile drawer.
insertChild(index, child)voidInserts a child at the given index.
(Inherited from WorkspaceParent)
recomputeChildrenDimensions()voidRecomputes the dimensions of the children.
(Inherited from WorkspaceParent)
removeChild(child)voidRemoves a child.
(Inherited from WorkspaceParent)
replaceChild(index, child)voidReplaces the child at the given index.
(Inherited from WorkspaceParent)
toggle()voidToggle the mobile drawer.

Links to this page: