ui-ninezone

Classes

Name Description
Backstage Backstage component of 9-Zone UI app. Beta
BackstageItem Item in the BackstageItem.Backstage. Beta
BackstageSeparator Item separator in the BackstageSeparator.Backstage component. Beta
Dialog Dialog used in footer indicators. Beta
ExpandableItem Expandable toolbar item. Beta
Footer component. Beta
FooterIndicator Indicator used in FooterIndicator.Footer component. Beta
FooterPopup Popup component used in FooterPopup.Footer component. Beta
FooterSeparator Footer indicator separator used in FooterSeparator.Footer component. Beta
Item Toolbar item component. Beta
MergeTarget Zone target used to merge widgets. Beta
Message Component used to define toast, sticky and activity message. Beta
MessageButton Button component used in MessageButton.Message component. Beta
MessageCenter Message center indicator used in MessageCenter.Footer component. Beta
MessageCenterDialog Message center dialog used with MessageCenterDialog.MessageCenter component. Beta
MessageCenterMessage Message entry in MessageCenterMessage.MessageCenterDialog component. Beta
MessageCenterTab Message center tab used in MessageCenterTab.MessageCenterDialog component. Beta
Hyperlink component used in MessageHyperlink.Message component. Beta
MessageLayout Layout used in MessageLayout.Message component. Beta
MessageProgress Progress bar component used in MessageProgress.Message component. Beta
NestedStagePanelsManager Class used to manage NestedStagePanelsManager.NestedStagePanelsManagerProps. Beta
NestedToolSettings Used in NestedToolSettings.ToolSettings component to display nested tool settings. Beta
Outline Zone outline displayed when merging/unmerging zones. Beta
Overflow Expandable toolbar item component that displays ellipsis icon. Beta
ScrollableToolSettings Used in ScrollableToolSettings.ToolSettings or ScrollableToolSettings.NestedToolSettings components to display scrollable tool settings. Beta
Snap Snap row used in Snap.SnapModePanel component. Beta
SnapMode Snap mode indicator used in SnapMode.Footer component. Beta
SnapModePanel Snap mode panel used with SnapModePanel.SnapMode component. Beta
Splitter Splitter component of 9-Zone UI app. Beta
SplitterPaneTarget Visual target component used to merge widgets in a splitter pane. Beta
SplitterTarget Visual target component used to add widgets to a splitter. Beta
StagePanel Stage panel used in StagePanel.StagePanels component. Beta
StagePanelManager Class used to manage StagePanelManager.StagePanelManagerProps. Beta
StagePanels Stage panels component of 9-Zone UI app. Beta
StagePanelsManager Class used to manage StagePanelsManager.StagePanelsManagerProps. Beta
StagePanelTarget Zone target used to merge widgets to stage panels. Beta
TitleBar Title bar of TitleBar.Dialog component. Beta
TitleBarButton Button used in TitleBarButton.TitleBar component. Beta
ToolAssistance Tool assistance indicator used in ToolAssistance.Footer component. Beta
ToolAssistanceDialog Tool assistance dialog used with ToolAssistanceDialog.ToolAssistance component. Beta
ToolAssistanceInstruction Tool assistance instruction used in ToolAssistanceInstruction.ToolAssistanceDialog component. Beta
ToolAssistanceItem Tool assistance item used in ToolAssistanceItem.ToolAssistanceDialog component. Beta
ToolAssistanceSeparator Tool assistance item separator used in ToolAssistanceSeparator.ToolAssistanceDialog component. Beta
Toolbar A toolbar that contains toolbar items. Beta
ToolSettings Tool settings widget is used to display Tool Settings and Tool Assistance (in Zone 2 of 9-Zone UI). Beta
ToolSettingsPopup Popup component used in ToolSettingsPopup.ToolSettings component. Beta
ToolSettingsTab Tool settings widget tab is displayed when the ToolSettingsTab.ToolSettings widget is closed. Beta
Tooltip Positionable tooltip component. Beta
UserProfile User profile component used in UserProfile.Backstage header. Beta
Zone Zone component of 9-Zone UI app. Beta
Zones Zones container component of 9-Zone UI app. Beta
ZonesManager Class used to manage ZonesManager.ZonesManagerProps. Beta

Constants

Name Description
widgetZoneIds Array of all widget zone Ids. Beta

Enumerations

Name Description
Direction Available directions. Beta
DisabledResizeHandles Describes disabled resize handles. Beta
FooterPopupContentType Available footer popup content types. Beta
HorizontalAnchor Available HorizontalAnchor.Stacked widget horizontal anchors. Beta
ResizeHandle Available resize handles of rectangular widget. Beta
SafeAreaInsets Describes available safe area insets. Beta
StagePanelType Describes available stage panel types. Beta
Status Available status types of status message. Beta
ToolbarPanelAlignment Available alignment modes of ToolbarPanelAlignment.Toolbar panels. Beta
ToolSettingsWidgetMode Available modes of tool settings widget. Beta
VerticalAnchor Available VerticalAnchor.Stacked widget vertical anchors. Beta
ZoneTargetType Available zone targets. Beta

Global Functions

Name Description
getDefaultStagePanelManagerProps Returns default getDefaultStagePanelManagerProps.StagePanelManagerProps object. Beta
getDefaultStagePanelsManagerProps Returns default getDefaultStagePanelsManagerProps.StagePanelsManagerProps object. Beta
getDefaultZonesManagerProps Returns default getDefaultZonesManagerProps.ZonesManagerProps object. Beta
withDragInteraction HOC to add open panel action via drag interaction. Beta

Interfaces

Name Description
BackstageItemProps Properties of BackstageItemProps.BackstageItem component. Beta
BackstageProps Properties of BackstageProps.Backstage component. Beta
DialogProps Properties of DialogProps.Dialog component. Beta
DraggedWidgetManagerProps Dragged widget properties used in DraggedWidgetManagerProps.ZonesManagerProps. Beta
ExpandableItemProps Properties of ExpandableItemProps.ExpandableItem component. Beta
FooterIndicatorProps Properties of FooterIndicatorProps.FooterIndicator component. Beta
FooterPopupProps Properties of FooterPopupProps.FooterPopup component. Beta
FooterProps Properties of FooterProps.Footer component. Beta
FooterSeparatorProps Properties of FooterSeparatorProps.FooterSeparator component. Beta
ItemProps Properties of ItemProps.Item component. Beta
MergeTargetProps Properties of MergeTargetProps.MergeTarget component. Beta
MessageButtonProps Properties of MessageButtonProps.MessageButton component. Beta
MessageCenterDialogProps Properties of MessageCenterDialogProps.MessageCenterDialog component. Beta
MessageCenterMessageProps Properties of MessageCenterMessageProps.MessageCenterMessage component. Beta
MessageCenterProps Properties of MessageCenterProps.MessageCenter component. Beta
MessageCenterTabProps Properties of MessageCenterTabProps.MessageCenterTab component. Beta
MessageHyperlinkProps Properties of MessageHyperlinkProps.MessageHyperlink component. Beta
MessageLayoutProps Properties of MessageLayoutProps.MessageLayout component. Beta
NestedStagePanelKey Key used to identify stage panel in NestedStagePanelKey.NestedStagePanelsManagerProps. Beta
NestedStagePanelsManagerProps Properties used by NestedStagePanelsManagerProps.NestedStagePanelsManager. Beta
NestedToolSettingsProps Properties of NestedToolSettingsProps.NestedToolSettings component. Beta
OutlineProps Properties of OutlineProps.OutlineProps component. Beta
OverflowProps Properties of OverflowProps.Overflow component. Beta
ProgressProps Properties of ProgressProps.MessageProgress component. Beta
ScrollableToolSettingsProps Properties of ScrollableToolSettingsProps.ScrollableToolSettings component. Beta
SnapModePanelProps Properties of SnapModePanelProps.SnapModePanel component. Beta
SnapModeProps Properties of SnapModeProps.SnapMode component. Beta
SnapProps Properties of SnapProps.Snap component. Beta
SplitterProps Properties of SplitterProps.Splitter component. Beta
SplitterTargetProps Properties of SplitterTargetProps.SplitterTarget component. Beta
StagePanelManagerProps Properties used by StagePanelManagerProps.StagePanelManager. Beta
StagePanelProps Properties of StagePanelProps.StagePanel component. Beta
StagePanelsManagerProps Properties used to manage stage panels. Beta
StagePanelsProps Properties of StagePanelsProps.StagePanels component. Beta
StagePanelTargetProps Properties of StagePanelTargetProps.StagePanel component. Beta
StatusMessageProps Properties of StatusMessageProps.Message component. Beta
TitleBarButtonProps Properties of TitleBarButtonProps.TitleBarButton component. Beta
TitleBarProps Properties of TitleBarProps.TitleBar component. Beta
ToolAssistanceDialogProps Properties of ToolAssistanceDialogProps.ToolAssistanceDialog component. Beta
ToolAssistanceInstructionProps Properties of ToolAssistanceInstructionProps.ToolAssistanceInstruction component. Beta
ToolAssistanceItemProps Properties of ToolAssistanceItemProps.ToolAssistanceItem component. Beta
ToolAssistanceProps Properties of ToolAssistanceProps.ToolAssistance component. Beta
ToolAssistanceSeparatorProps Properties of ToolAssistanceSeparatorProps.ToolAssistanceSeparator component. Beta
ToolbarProps Properties of ToolbarProps.Toolbar component. Beta
ToolSettingsPopupProps Properties of ToolSettingsPopupProps.ToolSettingsPopup component. Beta
ToolSettingsProps Properties of ToolSettingsProps.ToolSettings component. Beta
ToolSettingsTabProps Properties of ToolSettingsTabProps.ToolSettingsTab component. Beta
ToolSettingsWidgetManagerProps Tool settings widget properties used in ToolSettingsWidgetManagerProps.ZonesManagerProps. Beta
TooltipProps Properties of TooltipProps.Tooltip component. Beta
UserProfileProps Properties of UserProfileProps.UserProfile component. Beta
WidgetManagerProps Widget properties used in WidgetManagerProps.ZonesManagerProps. Beta
WithDragInteractionProps Properties of WithDragInteractionProps.withDragInteraction HOC. Beta
ZoneManagerFloatingProps Floating zone properties used in ZoneManagerFloatingProps.ZoneManagerProps. Beta
ZoneManagerProps Zone properties used in ZoneManagerProps.ZonesManagerProps. Beta
ZoneProps Properties of ZoneProps.Zone component. Beta
ZonesManagerProps Properties used by ZonesManagerProps.ZonesManager. Beta
ZonesManagerTargetProps Zone target used in ZonesManagerTargetProps.ZonesManagerProps. Beta
ZonesManagerWidgetResizeArgs Arguments used in ZonesManager.handleWidgetResize. Beta
ZonesProps Properties of ZonesProps.Zones component. Beta

Type Aliases

Name Description
BackstageDefaultProps Default properties of BackstageDefaultProps.Backstage component. Beta
FooterPopupDefaultProps Default properties of FooterPopupDefaultProps.FooterPopup component. Beta
NestedStagePanelsId Used to identify stage panels in NestedStagePanelsId.NestedStagePanelsManagerProps. Beta
TooltipDefaultProps Default properties of TooltipDefaultProps.Tooltip component. Beta
WidgetZoneId Widget zone id. Beta
ZonesManagerWidgetsProps Widgets used in ZonesManagerWidgetsProps.ZonesManagerProps. Beta
ZonesManagerZonesProps Zones used in ZonesManagerZonesProps.ZonesManagerProps. Beta

Last Updated: 24 January, 2020