useFetch.js
2 days ago
useFileUploader.js
2 days ago
useModalState.js
2 days ago
useSearchCombobox.js
2 days ago
useModalState.js
40 lines
| 1 | /** |
| 2 | * WordPress Dependencies |
| 3 | */ |
| 4 | import { useCallback, useState } from '@wordpress/element'; |
| 5 | |
| 6 | /** |
| 7 | * Boolean open/close state for modals, dialogs, and similar UI. |
| 8 | * |
| 9 | * @param {boolean} [initialOpen=false] Whether the modal starts open. |
| 10 | * @return {Object} An object with the following properties: |
| 11 | * - isOpen: boolean |
| 12 | * - open: () => void |
| 13 | * - close: () => void |
| 14 | * - toggle: () => void |
| 15 | * @example |
| 16 | * const { isOpen, open, close, toggle } = useModalState( false ); |
| 17 | * return ( |
| 18 | * <button onClick={ open }>Open</button> |
| 19 | * <button onClick={ close }>Close</button> |
| 20 | * <button onClick={ toggle }>Toggle</button> |
| 21 | * ); |
| 22 | */ |
| 23 | export function useModalState( initialOpen = false ) { |
| 24 | const [ isOpen, setIsOpen ] = useState( initialOpen ); |
| 25 | |
| 26 | const open = useCallback( () => { |
| 27 | setIsOpen( true ); |
| 28 | }, [] ); |
| 29 | |
| 30 | const close = useCallback( () => { |
| 31 | setIsOpen( false ); |
| 32 | }, [] ); |
| 33 | |
| 34 | const toggle = useCallback( () => { |
| 35 | setIsOpen( ( prev ) => ! prev ); |
| 36 | }, [] ); |
| 37 | |
| 38 | return { isOpen, open, close, toggle }; |
| 39 | } |
| 40 |