API Reference › appui-react › Popup › PopupManager

PopupManager Class

Popup Manager class

Methods

Name Description
constructor(): PopupManager    
addOrUpdatePopup(popupInfo: PopupInfo): void Static    
closeToolSettings(): boolean Static    
displayCard(content: ReactNode, options: DisplayCardPopupOptions): boolean Static    
displayToolbar(items: ToolbarItem[], options: CommonPopupOptions & { onItemExecuted: (item: any) => void }): boolean Static    
getPopupPosition(el: HTMLElement, pt: Readonly<WritableXAndY>, offset: Readonly<WritableXAndY>, size: SizeProps): Point Static    
hideCard(id?: string): boolean Static    
hideComponent(id?: string): boolean Static    
hideHTMLElement(): boolean Static    
hideInputEditor(): boolean Static    
hideKeyinPalette(): boolean Static    
hideToolbar(): boolean Static    
openToolSettings(dataProvider: DialogLayoutDataProvider, el: HTMLElement, pt: Readonly<WritableXAndY>, offset: Readonly<WritableXAndY>, onCancel: () => void, relativePosition: RelativePosition): boolean Static    
removePopup(id: string): boolean Static    
showCard(content: PopupContentType, title: undefined | string | PropertyRecord, toolbarProps: undefined | AbstractToolbarProps, el: HTMLElement, pt: Readonly<WritableXAndY>, offset: Readonly<WritableXAndY>, onItemExecuted: (item: any) => void, onCancel: () => void, relativePosition: RelativePosition): boolean Static    
showComponent(displayElement: ReactElement<any, string | JSXElementConstructor<any>>, options: CommonPopupOptions): boolean Static Displays a React component as a popup.  
showHTMLElement(displayElement: HTMLElement, el: HTMLElement, pt: Readonly<WritableXAndY>, offset: Readonly<WritableXAndY>, onCancel: () => void, relativePosition: RelativePosition): boolean Static    
showInputEditor(el: HTMLElement, pt: Readonly<WritableXAndY>, value: Value, propertyDescription: PropertyDescription, onCommit: OnValueCommitFunc, onCancel: () => void): boolean Static    
showKeyinPalette(keyins: KeyinEntry[], el: HTMLElement, onItemExecuted?: (item: any) => void, onCancel?: () => void): boolean Static    
showToolbar(toolbarProps: AbstractToolbarProps, el: HTMLElement, pt: Readonly<WritableXAndY>, offset: Readonly<WritableXAndY>, onItemExecuted: (item: any) => void, onCancel: () => void, relativePosition: RelativePosition): boolean Static    

Properties

Name Type Description
defaultOffset Accessor Static Readonly<WritableXAndY>    
onPopupsChangedEvent StaticReadonly PopupsChangedEvent    
popupCount Accessor StaticReadOnly number    
popups Accessor Static undefined    

Defined in

Last Updated: 05 April, 2024