gaschz/trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-10-20 23:29:02 +02:00
Code Issues Actions 19 Packages Projects Releases Wiki Activity

refactor(react/dialogs): add documentation & enforce some properties

Browse Source
This commit is contained in:
Elian Doran 2025-08-10 14:49:58 +03:00
parent b25e9cdee6
commit f7093c035b
No known key found for this signature in database
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
apps/client/src/widgets/react/Modal.tsx
View File

@ -35,8 +35,12 @@ interface ModalProps {
onSubmit?: () => void; onSubmit?: () => void;
/** Called when the modal is shown. */ /** Called when the modal is shown. */
onShown?: () => void; onShown?: () => void;
/** Called when the modal is hidden, either via close button, backdrop click or submit. */ /**
onHidden?: () => void; * Called when the modal is hidden, either via close button, backdrop click or submit.
*
* Here it's generally a good idea to set `show` to false to reflect the actual state of the modal.
*/
onHidden: () => void;
helpPageId?: string; helpPageId?: string;
/** /**
* Gives access to the underlying modal element. This is useful for manipulating the modal directly * Gives access to the underlying modal element. This is useful for manipulating the modal directly
@ -48,7 +52,11 @@ interface ModalProps {
*/ */
formRef?: RefObject<HTMLFormElement>; formRef?: RefObject<HTMLFormElement>;
bodyStyle?: CSSProperties; bodyStyle?: CSSProperties;
show?: boolean; /**
* Controls whether the modal is shown. Setting it to `true` will trigger the modal to be displayed to the user, whereas setting it to `false` will hide the modal.
* This method must generally be coupled with `onHidden` in order to detect when the modal was closed externally (e.g. by the user clicking on the backdrop or on the close button).
*/
show: boolean;
} }
export default function Modal({ children, className, size, title, header, footer, footerStyle, footerAlignment, onShown, onSubmit, helpPageId, minWidth, maxWidth, zIndex, scrollable, onHidden: onHidden, modalRef: _modalRef, formRef: _formRef, bodyStyle, show }: ModalProps) { export default function Modal({ children, className, size, title, header, footer, footerStyle, footerAlignment, onShown, onSubmit, helpPageId, minWidth, maxWidth, zIndex, scrollable, onHidden: onHidden, modalRef: _modalRef, formRef: _formRef, bodyStyle, show }: ModalProps) {