Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Interface IgrContentPane

Properties

Properties

OptionalacceptsInnerDock

acceptsInnerDock?: boolean

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

OptionalallowClose

allowClose?: boolean

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

OptionalallowDocking

allowDocking?: boolean

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

OptionalallowFloating

allowFloating?: boolean

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

OptionalallowMaximize

allowMaximize?: boolean

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

OptionalallowPinning

allowPinning?: boolean

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

contentId

contentId: string

The slot attribute's value of the content element.

Optionaldisabled

disabled?: boolean

Determines whether a pane is disabled. Defaults to false.

OptionaldocumentOnly

documentOnly?: boolean

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

OptionalfloatingHeaderId

floatingHeaderId?: string

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

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.

OptionalheaderId

headerId?: string

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

Optionalhidden

hidden?: boolean

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

Optionalid

id?: string

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

OptionalisMaximized

isMaximized?: boolean

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

OptionalisPinned

isPinned?: boolean

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

Optionalsize

size?: number

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

OptionaltabHeaderId

tabHeaderId?: string

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

type

type: contentPane

The type of the pane.

OptionalunpinnedHeaderId

unpinnedHeaderId?: string

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

OptionalunpinnedLocation

unpinnedLocation?: IgrUnpinnedLocation

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.

OptionalunpinnedSize

unpinnedSize?: number

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