VSinerva/freesewing
1
0
Fork 0
Code Activity

[react] feat: Added docs for components/Modal

Browse source
This commit is contained in:
joostdecock 2025-05-24 18:40:30 +02:00
parent 7317ff5dd8
commit 280ee0e1d3
4 changed files with 104 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

24
packages/react/components/Modal/index.mjs
View file

@ -12,17 +12,19 @@ const slideClasses = {
/**
* This component wraps modal content, making sure the layout is ok and handling transitions
*
* @param {object} props - All React props
* @param {array} children - Content to render inside the modal
* @param {string} flex - Flexbox direction (row or col)
* @param {string} justify - Flexbox justify value
* @param {string} items - Flexbox items value
* @param {string} bg - Background
* @param {string} bgOpacity - Background opacity
* @param {bool} bare - Set true to not handle layout
* @param {bool} keepOpenOnClick - Set to true to prevent a click in the modal content to close the modal
* @param {string} slideFrom - Direction to slide in from
* @param {bool} fullWidth - Set to true to not constrain the width
* @component
* @param {object} props - All component props
* @param {JSX.Element} props.children - The component children, will be rendered inside the mini tip
* @param {string} [props.flex = row] - Flexbox direction (row or col)
* @param {string} [props.justify = center] - Flexbox justify value
* @param {string} [props.items = center] - Flexbox items value
* @param {string} [props.bg = neutral] - Background color (one of the DaisyUI named colors)
* @param {string} [props.bgOpacity = 70] - Background opacity
* @param {bool} [props.bare = false] - Set true to not handle layout within the wrapper
* @param {bool} [keepOpenOnClick = false] - Set to true to prevent a click in the modal content from closing the modal
* @param {string} [slideFrom = left] - Direction to slide in from on mobile
* @param {bool} [fullWidth = false] - Set to true to not constrain the width
* @returns {JSX.Element}
*/
export const ModalWrapper = ({
children = null,