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

Property Type Description
allowSingleChild boolean Whether this parent is allowed to contain a single child (rather than collapsing it).
(Inherited from WorkspaceParent)
autoManageDOM boolean Whether this parent automatically manages the DOM of its children.
(Inherited from WorkspaceParent)
children WorkspaceItem[] The child items contained in this parent.
(Inherited from WorkspaceParent)
collapsed boolean Whether the mobile drawer is collapsed.
parent WorkspaceParent The parent of the mobile drawer.

Methods

Method Returns Description
collapse() void Collapse the mobile drawer.
expand() void Expand the mobile drawer.
insertChild(index, child) void Inserts a child at the given index.
(Inherited from WorkspaceParent)
recomputeChildrenDimensions() void Recomputes the dimensions of the children.
(Inherited from WorkspaceParent)
removeChild(child) void Removes a child.
(Inherited from WorkspaceParent)
replaceChild(index, child) void Replaces the child at the given index.
(Inherited from WorkspaceParent)
toggle() void Toggle the mobile drawer.

Links to this page: