Rate this page:
The Modal
class enables your custom UI app to open a modal dialog with a specified resource.
1 2interface ModalOptions { resource?: string | null; onClose?: (payload?: any) => any; size?: 'small' | 'medium' | 'large' | 'xlarge' | 'max'; context?: any; closeOnEscape?: boolean; closeOnOverlayClick?: boolean; } class Modal { constructor(opts?: ModalOptions); open(): Promise<void>; }
view.close(payload)
from inside the modal resource.modal
key in the context object returned from view.getContext()
.Implementing a custom UI modal requires two files:
index.js
file in your app logicmy-modal-resource.js
file
in the example belowindex.js
1 2import { Modal } from '@forge/bridge'; const modal = new Modal({ resource: 'my-modal-resource', onClose: (payload) => { console.log('onClose called with', payload); }, size: 'medium', context: { customKey: 'custom-value', }, }); modal.open();
my-modal-resource.js
1 2import { view } from '@forge/bridge'; const context = await view.getContext(); const customValue = context.modal.customKey; view.close({ formValues: [], });
Rate this page: