closeOverpanel
- Updated:
Closes an overpanel opened by showOverpanel.
Description
closeOverpanel takes an optional resolutionData dictionary, closes an overpanel opened by showOverpanel, and passes the resolution data to the promise that showOverpanel returns.
Signature
tecton.actions.closeOverpanel(resolutionData?: Record<string, any>): void;Usage
Close without returning data.
tecton.actions.closeOverpanel();Close and return data to the opener.
tecton.actions.closeOverpanel({ selectedAccount: '12345', confirmed: true });Example
In this example, showOverpanel is provided arguments to modify the width and height of the overpanel. Upon calling showOverpanel, the overpanel will slide upwards into the view. Upon calling closeOverpanel, the overpanel will slide downwards and out of the view. The closeOverpanel method is provided resolution data that will be accessible from within the showOverpanel's Promise handling once the promise has been fulfilled.
Captured on UUX version 4.6.0.10A.
Parameters
resolutionDataPlatform Support
Changelog
The changelog provides a detailed history of new features, improvements, and bug fixes going back to Tecton 1.30.0. If the button is disabled, it indicates there have been no detectable changes since then.