Skip to main content

MosaicControlledProps

react-mosaic-component

react-mosaic-component / MosaicControlledProps

Interface: MosaicControlledProps<T>

Defined in: libs/react-mosaic-component/src/lib/Mosaic.tsx:138

Extends​

  • MosaicBaseProps<T>

Type Parameters​

T​

T extends MosaicKey

Properties​

blueprintNamespace?​

optional blueprintNamespace?: string

Defined in: libs/react-mosaic-component/src/lib/Mosaic.tsx:125

Make it possible to use different versions of Blueprint with mosaic-blueprint-theme Note: does not support updating after instantiation default: 'bp3'

Inherited from​

MosaicBaseProps.blueprintNamespace

canClose?​

optional canClose?: TabCanCloseFunction<T>

Defined in: libs/react-mosaic-component/src/lib/Mosaic.tsx:80

Function to determine if a tab can be closed

Inherited from​

MosaicBaseProps.canClose

className?​

optional className?: string

Defined in: libs/react-mosaic-component/src/lib/Mosaic.tsx:103

Additional classes to affix to the root element Default: 'mosaic-blueprint-theme'

Inherited from​

MosaicBaseProps.className

createNode?​

optional createNode?: CreateNode<T>

Defined in: libs/react-mosaic-component/src/lib/Mosaic.tsx:82

Inherited from​

MosaicBaseProps.createNode

dragAndDropManager?​

optional dragAndDropManager?: DragDropManager

Defined in: libs/react-mosaic-component/src/lib/Mosaic.tsx:129

Override the react-dnd provider to allow applications to inject an existing drag and drop context

Inherited from​

MosaicBaseProps.dragAndDropManager

dropBehavior?​

optional dropBehavior?: MosaicDropBehavior

Defined in: libs/react-mosaic-component/src/lib/Mosaic.tsx:135

What dropping a window on another window does: 'split' it along the edge (default), 'swap' the two windows, or 'split-and-swap' (edges split, the centre swaps). Windows inside tab groups are not affected.

Inherited from​

MosaicBaseProps.dropBehavior

mosaicId?​

optional mosaicId?: string

Defined in: libs/react-mosaic-component/src/lib/Mosaic.tsx:119

Override the mosaicId passed to react-dnd to control how drag and drop works with other components Note: does not support updating after instantiation default: Random UUID

Inherited from​

MosaicBaseProps.mosaicId

onChange​

onChange: (newNode, meta?) => void

Defined in: libs/react-mosaic-component/src/lib/Mosaic.tsx:147

Called when a user initiates any change to the tree (removing, adding, moving, resizing, etc.) meta describes what caused the change, see [[MosaicChangeMeta]].

Parameters​

newNode​

MosaicNode<T> | null

meta?​

MosaicChangeMeta<T>

Returns​

void

Overrides​

MosaicBaseProps.onChange

onRelease?​

optional onRelease?: (newNode, meta?) => void

Defined in: libs/react-mosaic-component/src/lib/Mosaic.tsx:95

Called when a user completes a change (fires like above except for the interpolation during resizing) meta describes what caused the change, see [[MosaicChangeMeta]].

Parameters​

newNode​

MosaicNode<T> | null

meta?​

MosaicChangeMeta<T>

Returns​

void

Inherited from​

MosaicBaseProps.onRelease

renderTabButton?​

optional renderTabButton?: TabButtonRenderer<T>

Defined in: libs/react-mosaic-component/src/lib/Mosaic.tsx:76

Custom tab button renderer

Inherited from​

MosaicBaseProps.renderTabButton

renderTabTitle?​

optional renderTabTitle?: TabTitleRenderer<T>

Defined in: libs/react-mosaic-component/src/lib/Mosaic.tsx:72

Function to render custom tab titles

Inherited from​

MosaicBaseProps.renderTabTitle

renderTabToolbar?​

optional renderTabToolbar?: TabToolbarRenderer<T>

Defined in: libs/react-mosaic-component/src/lib/Mosaic.tsx:60

Lookup function to convert tab title to a displayable ReactElement

Inherited from​

MosaicBaseProps.renderTabToolbar

renderTabToolbarControls?​

optional renderTabToolbarControls?: TabToolbarControlsRenderer<T>

Defined in: libs/react-mosaic-component/src/lib/Mosaic.tsx:68

Override the right-hand controls cluster in the default tab bar — the add, split, and remove buttons. Compose from DefaultAddTabButton, TabSplitButton, TabRemoveButton, or your own elements. The library keeps ownership of the tab-group drag handle. Ignored when renderTabToolbar is provided.

Inherited from​

MosaicBaseProps.renderTabToolbarControls

renderTile​

renderTile: TileRenderer<T>

Defined in: libs/react-mosaic-component/src/lib/Mosaic.tsx:56

Lookup function to convert T to a displayable ReactElement

Inherited from​

MosaicBaseProps.renderTile

resize?​

optional resize?: ResizeOptions

Defined in: libs/react-mosaic-component/src/lib/Mosaic.tsx:108

Options that control resizing @see: [[ResizeOptions]]

Inherited from​

MosaicBaseProps.resize

value​

value: T | MosaicSplitNode<T> | MosaicTabsNode<T> | LegacyMosaicParent<T> | null

Defined in: libs/react-mosaic-component/src/lib/Mosaic.tsx:146

The tree to render. A legacy binary (first/second) tree is converted on mount and the converted tree is reported through onChange once (without onRelease), so the caller can store and pass back the modern n-ary format.

zeroStateView?​

optional zeroStateView?: ReactElement<unknown, string | JSXElementConstructor<any>>

Defined in: libs/react-mosaic-component/src/lib/Mosaic.tsx:113

View to display when the current value is null default: Simple NonIdealState view

Inherited from​

MosaicBaseProps.zeroStateView