Skip to main content

Interface: WorkspaceLayoutItemProps

Defined in: src/workspace/workspaceLayout.tsx:123

Props for WorkspaceLayoutItem component.

See

WorkspaceLayoutItem

Extends

  • CommonWorkspaceLayoutProps

Properties

PropertyTypeDescriptionInherited from

aria-label?

string

ARIA-label to mark <section> layout item with.

Default is heading value if it is a string otherwise undefined.

children

ReactElement

Layout item children.

When the layout item is collapsed, the children will not render.

className?

string

Additional CSS class for the component.

CommonWorkspaceLayoutProps.className

collapsedSize?

number

Size to use when the layout component is collapsed.

The size is width if the component is inside layout row and height if it is inside column.

Default is 28 for a layout row, otherwise it is computed automatically.

CommonWorkspaceLayoutProps.collapsedSize

defaultCollapsed?

boolean

Whether the layout component is collapsed by default.

Default

false

CommonWorkspaceLayoutProps.defaultCollapsed

defaultSize?

number

Default size for the layout component.

The size is width if the component is inside layout row and height if it is inside column.

Default is computed automatically by dividing the space evenly between child components.

CommonWorkspaceLayoutProps.defaultSize

heading?

ReactNode

Heading content for the layout item.

id

string

Unique layout component ID withing the layout component tree.

minSize?

number

Minimum size for the layout component.

If the layout component is resized below this size it would be considered collapsed.

The size is width if the component is inside layout row and height if it is inside column.

CommonWorkspaceLayoutProps.minSize

style?

CSSProperties

Additional CSS styles for the component.

CommonWorkspaceLayoutProps.style

undocked?

boolean

Disables the docking for the layout component.

A layout component with docking displays controls to expand/collapse it if the component is the first or the last one within a column.

Default

false

CommonWorkspaceLayoutProps.undocked