Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Interface IIgrContentPaneProps

Hierarchy

Hierarchy

Properties

Properties

Optional acceptsInnerDock

acceptsInnerDock?: string | boolean

Determines whether the end user can inner dock another pane in this one. Defaults to true.

Optional allowClose

allowClose?: string | boolean

Determines whether the end user is allowed to close the pane. Defaults to true.

Optional allowDocking

allowDocking?: string | boolean

Determines whether the end user is allowed to dock the pane. Defaults to true.

Optional allowFloating

allowFloating?: string | boolean

Determines whether the end user is allowed to make the pane floating. Defaults to true.

Optional allowMaximize

allowMaximize?: string | boolean

Determines whether the end user is allowed to maximize the pane.

Optional allowPinning

allowPinning?: string | boolean

Determines whether the end user is allowed to pin/unpin the pane. Defaults to true.

Optional children

children?: ReactNode

Optional className

className?: string

Optional contentId

contentId?: string

The slot attribute's value of the content element.

Optional disabled

disabled?: string | boolean

Determines whether a pane is disabled. Defaults to false.

Optional documentOnly

documentOnly?: string | boolean

Marks that a content pane can be docked only inside a document host.

Optional floatingHeaderId

floatingHeaderId?: string

The slot attribute's value of the floating header element. If not set, the headerId property value is used.

Optional header

header?: string

The text header of the content pane. Even if header slot templates are used, the text header is used for aria label.

Optional headerId

headerId?: string

The slot attribute's value of the content pane header element. If not set, the header property value is used.

Optional hidden

hidden?: string | boolean

Determines whether a pane is hidden in the UI. Defaults to false.

Optional id

id?: string

The id of the pane. If not set the Dock Manager generates it automatically.

Optional isMaximized

isMaximized?: string | boolean

Determines whether a content pane is maximized or not. Defaults to false.

Optional isPinned

isPinned?: string | boolean

Determines whether a content pane is pinned or not. Defaults to true.

Optional name

name?: string

Optional size

size?: string | number

The size of the pane relative to its sibling panes' sizes. Defaults to 100.

Optional style

style?: CSSProperties

Optional tabHeaderId

tabHeaderId?: string

The slot attribute's value of the tab header element. If not set, the header property value is used.

Optional type

type?: string | DockManagerPaneType

The type of the pane.

Optional unpinnedHeaderId

unpinnedHeaderId?: string

The slot attribute's value of the unpinned header element. If not set, the header property value is used.

Optional unpinnedLocation

unpinnedLocation?: string | UnpinnedLocation

The desired unpinned location of the content pane. If not set the Dock Manager automatically calculates it based on the location of the pane relatively to the document host. If more than one document host is presented, the closest one in the pane hierarchy will be used for the calculation. If there is no document host, the default location is left.

Optional unpinnedSize

unpinnedSize?: string | number

The absolute size of the pane in an unpinned state. Defaults to 200.