API Reference > ui-framework > Frontstage > FrontstageComposer

FrontstageComposer<SS> Class

FrontstageComposer React component.

Extends

Implements

Methods

Name Description
constructor(props: CommonProps): FrontstageComposer    
componentDidMount(): void    
componentWillUnmount(): void    
getGhostOutlineBounds(zoneId: WidgetZoneId): RectangleProps | undefined    
getZoneDef(zoneId: number): ZoneDef | undefined    
handleResize(zoneId: WidgetZoneId, resizeBy: number, handle: ResizeHandle, filledHeightDiff: number): void    
handleTabClick(widgetId: WidgetZoneId, tabIndex: number): void    
handleTabDrag(dragged: PointProps): void    
handleTabDragEnd(): void    
handleTabDragStart(widgetId: WidgetZoneId, tabIndex: number, initialPosition: PointProps, widgetBounds: RectangleProps): void    
handleTargetChanged(zoneId: WidgetZoneId, type: ZoneTargetType, isTargeted: boolean): void    
handleWidgetStateChange(widgetId: WidgetZoneId, tabIndex: number, isOpening: boolean): void    
handleZonesBoundsChange(bounds: RectangleProps): void    
mergeZones(toMergeId: WidgetZoneId, targetId: WidgetZoneId): void    
render(): React.ReactNode    
setZoneAllowsMerging(zoneId: WidgetZoneId, allowsMerging: boolean): void    

Inherited methods

Name Inherited from Description
UNSAFE_componentWillMount(): void Optional DeprecatedLifecycle Called immediately before mounting occurs, and before Component#render.
UNSAFE_componentWillReceiveProps(nextProps: Readonly<CommonProps>, nextContext: any): void Optional DeprecatedLifecycle Called when the component may be receiving new props.
UNSAFE_componentWillUpdate(nextProps: Readonly<CommonProps>, nextState: Readonly<FrontstageComposerState>, nextContext: any): void Optional DeprecatedLifecycle Called immediately before rendering when new props or state is received.
componentDidCatch(error: Error, errorInfo: ErrorInfo): void Optional ComponentLifecycle Catches exceptions generated in descendant components.
componentDidUpdate(prevProps: Readonly<CommonProps>, prevState: Readonly<FrontstageComposerState>, snapshot?: SS): void Optional NewLifecycle Called immediately after updating occurs.
componentWillMount(): void Optional DeprecatedLifecycle Called immediately before mounting occurs, and before Component#render.
componentWillReceiveProps(nextProps: Readonly<CommonProps>, nextContext: any): void Optional DeprecatedLifecycle Called when the component may be receiving new props.
componentWillUpdate(nextProps: Readonly<CommonProps>, nextState: Readonly<FrontstageComposerState>, nextContext: any): void Optional DeprecatedLifecycle Called immediately before rendering when new props or state is received.
forceUpdate(callback?: () => void): void Component  
getSnapshotBeforeUpdate(prevProps: Readonly<CommonProps>, prevState: Readonly<FrontstageComposerState>): SS | null Optional NewLifecycle Runs before React applies the result of render to the document, and
returns an object to be given to componentDidUpdate.
setState<K extends undefined>(state: (prevState: Readonly<FrontstageComposerState>, props: Readonly<CommonProps>) => null | S | object | null | S | object, callback?: () => void): void Component  
shouldComponentUpdate(nextProps: Readonly<CommonProps>, nextState: Readonly<FrontstageComposerState>, nextContext: any): boolean Optional ComponentLifecycle Called to determine whether the change in props and state should trigger a re-render.

Inherited properties

Name Type Inherited from Description
context any Component If using the new style context, re-declare this in your class to be the
React.ContextType of your static contextType.
contextType Static undefined | Context<any> Component If set, this.context will be set at runtime to the current value of the given Context.
props undefined Component  
refs [key: string]: ReactInstance Component  

Defined in

Last Updated: 08 January, 2020