maia.component-library / ModalBackdropProps
Interface: ModalBackdropProps
Defined in: node_modules/.pnpm/@heroui+react@3.2.1_@react-_0c36d9022f1aaf46c104e0a6d2192bf4/node_modules/@heroui/react/dist/components/modal/modal.d.ts:19
Extends
ComponentPropsWithRef<typeofModalOverlayPrimitive>
Properties
children?
optionalchildren?:ChildrenOrFunction<ModalRenderProps>
Defined in: node_modules/.pnpm/react-aria-components@1.18._652bbfc7b5fa5f84b16cd32a1196785b/node_modules/react-aria-components/dist/types/src/utils.d.ts:128
The children of the component. A function may be provided to alter the children based on component state.
Inherited from
ComponentPropsWithRef.children
className?
optionalclassName?:ClassNameOrFunction<ModalRenderProps>
Defined in: node_modules/.pnpm/react-aria-components@1.18._652bbfc7b5fa5f84b16cd32a1196785b/node_modules/react-aria-components/dist/types/src/Modal.d.ts:13
The CSS className for the element. A function may be provided to compute the class based on component state.
Default
'react-aria-ModalOverlay'Inherited from
ComponentPropsWithRef.className
defaultOpen?
optionaldefaultOpen?:boolean
Defined in: node_modules/.pnpm/react-stately@3.47.0_react@19.2.7/node_modules/react-stately/dist/types/src/overlays/useOverlayTriggerState.d.ts:5
Whether the overlay is open by default (uncontrolled).
Inherited from
ComponentPropsWithRef.defaultOpen
dir?
optionaldir?:string
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:299
Inherited from
hidden?
optionalhidden?:boolean
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:301
Inherited from
inert?
optionalinert?:boolean
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:302
Inherited from
isDismissable?
optionalisDismissable?:boolean
Defined in: node_modules/.pnpm/@heroui+react@3.2.1_@react-_0c36d9022f1aaf46c104e0a6d2192bf4/node_modules/@heroui/react/dist/components/modal/modal.d.ts:25
Whether to close the modal when the user interacts outside it.
Default
trueOverrides
ComponentPropsWithRef.isDismissable
isEntering?
optionalisEntering?:boolean
Defined in: node_modules/.pnpm/react-aria-components@1.18._652bbfc7b5fa5f84b16cd32a1196785b/node_modules/react-aria-components/dist/types/src/Modal.d.ts:17
Whether the modal is currently performing an entry animation.
Inherited from
ComponentPropsWithRef.isEntering
isExiting?
optionalisExiting?:boolean
Defined in: node_modules/.pnpm/react-aria-components@1.18._652bbfc7b5fa5f84b16cd32a1196785b/node_modules/react-aria-components/dist/types/src/Modal.d.ts:21
Whether the modal is currently performing an exit animation.
Inherited from
ComponentPropsWithRef.isExiting
isKeyboardDismissDisabled?
optionalisKeyboardDismissDisabled?:boolean
Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/overlays/useModalOverlay.d.ts:16
Whether pressing the escape key to close the modal should be disabled.
Default
falseInherited from
ComponentPropsWithRef.isKeyboardDismissDisabled
isOpen?
optionalisOpen?:boolean
Defined in: node_modules/.pnpm/react-stately@3.47.0_react@19.2.7/node_modules/react-stately/dist/types/src/overlays/useOverlayTriggerState.d.ts:3
Whether the overlay is open by default (controlled).
Inherited from
ComponentPropsWithRef.isOpen
key?
optionalkey?:Key|null
Defined in: node_modules/.pnpm/@types+react@19.2.17/node_modules/@types/react/index.d.ts:259
Inherited from
ComponentPropsWithRef.key
lang?
optionallang?:string
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:300
Inherited from
onAnimationEnd?
optionalonAnimationEnd?:AnimationEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:382
Inherited from
ComponentPropsWithRef.onAnimationEnd
onAnimationEndCapture?
optionalonAnimationEndCapture?:AnimationEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:383
Inherited from
ComponentPropsWithRef.onAnimationEndCapture
onAnimationIteration?
optionalonAnimationIteration?:AnimationEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:384
Inherited from
ComponentPropsWithRef.onAnimationIteration
onAnimationIterationCapture?
optionalonAnimationIterationCapture?:AnimationEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:385
Inherited from
ComponentPropsWithRef.onAnimationIterationCapture
onAnimationStart?
optionalonAnimationStart?:AnimationEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:380
Inherited from
ComponentPropsWithRef.onAnimationStart
onAnimationStartCapture?
optionalonAnimationStartCapture?:AnimationEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:381
Inherited from
ComponentPropsWithRef.onAnimationStartCapture
onAuxClick?
optionalonAuxClick?:MouseEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:322
Inherited from
ComponentPropsWithRef.onAuxClick
onAuxClickCapture?
optionalonAuxClickCapture?:MouseEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:323
Inherited from
ComponentPropsWithRef.onAuxClickCapture
onClick?
optionalonClick?:MouseEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:320
Inherited from
ComponentPropsWithRef.onClick
onClickCapture?
optionalonClickCapture?:MouseEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:321
Inherited from
ComponentPropsWithRef.onClickCapture
onContextMenu?
optionalonContextMenu?:MouseEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:324
Inherited from
ComponentPropsWithRef.onContextMenu
onContextMenuCapture?
optionalonContextMenuCapture?:MouseEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:325
Inherited from
ComponentPropsWithRef.onContextMenuCapture
onDoubleClick?
optionalonDoubleClick?:MouseEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:326
Inherited from
ComponentPropsWithRef.onDoubleClick
onDoubleClickCapture?
optionalonDoubleClickCapture?:MouseEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:327
Inherited from
ComponentPropsWithRef.onDoubleClickCapture
onGotPointerCapture?
optionalonGotPointerCapture?:PointerEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:366
Inherited from
ComponentPropsWithRef.onGotPointerCapture
onGotPointerCaptureCapture?
optionalonGotPointerCaptureCapture?:PointerEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:367
Inherited from
ComponentPropsWithRef.onGotPointerCaptureCapture
onLostPointerCapture?
optionalonLostPointerCapture?:PointerEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:368
Inherited from
ComponentPropsWithRef.onLostPointerCapture
onLostPointerCaptureCapture?
optionalonLostPointerCaptureCapture?:PointerEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:369
Inherited from
ComponentPropsWithRef.onLostPointerCaptureCapture
onMouseDown?
optionalonMouseDown?:MouseEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:328
Inherited from
ComponentPropsWithRef.onMouseDown
onMouseDownCapture?
optionalonMouseDownCapture?:MouseEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:329
Inherited from
ComponentPropsWithRef.onMouseDownCapture
onMouseEnter?
optionalonMouseEnter?:MouseEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:330
Inherited from
ComponentPropsWithRef.onMouseEnter
onMouseLeave?
optionalonMouseLeave?:MouseEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:331
Inherited from
ComponentPropsWithRef.onMouseLeave
onMouseMove?
optionalonMouseMove?:MouseEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:332
Inherited from
ComponentPropsWithRef.onMouseMove
onMouseMoveCapture?
optionalonMouseMoveCapture?:MouseEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:333
Inherited from
ComponentPropsWithRef.onMouseMoveCapture
onMouseOut?
optionalonMouseOut?:MouseEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:334
Inherited from
ComponentPropsWithRef.onMouseOut
onMouseOutCapture?
optionalonMouseOutCapture?:MouseEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:335
Inherited from
ComponentPropsWithRef.onMouseOutCapture
onMouseOver?
optionalonMouseOver?:MouseEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:336
Inherited from
ComponentPropsWithRef.onMouseOver
onMouseOverCapture?
optionalonMouseOverCapture?:MouseEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:337
Inherited from
ComponentPropsWithRef.onMouseOverCapture
onMouseUp?
optionalonMouseUp?:MouseEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:338
Inherited from
ComponentPropsWithRef.onMouseUp
onMouseUpCapture?
optionalonMouseUpCapture?:MouseEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:339
Inherited from
ComponentPropsWithRef.onMouseUpCapture
onOpenChange?
optionalonOpenChange?: (isOpen) =>void
Defined in: node_modules/.pnpm/react-stately@3.47.0_react@19.2.7/node_modules/react-stately/dist/types/src/overlays/useOverlayTriggerState.d.ts:7
Handler that is called when the overlay's open state changes.
Parameters
isOpen
boolean
Returns
void
Inherited from
ComponentPropsWithRef.onOpenChange
onPointerCancel?
optionalonPointerCancel?:PointerEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:358
Inherited from
ComponentPropsWithRef.onPointerCancel
onPointerCancelCapture?
optionalonPointerCancelCapture?:PointerEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:359
Inherited from
ComponentPropsWithRef.onPointerCancelCapture
onPointerDown?
optionalonPointerDown?:PointerEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:352
Inherited from
ComponentPropsWithRef.onPointerDown
onPointerDownCapture?
optionalonPointerDownCapture?:PointerEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:353
Inherited from
ComponentPropsWithRef.onPointerDownCapture
onPointerEnter?
optionalonPointerEnter?:PointerEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:360
Inherited from
ComponentPropsWithRef.onPointerEnter
onPointerLeave?
optionalonPointerLeave?:PointerEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:361
Inherited from
ComponentPropsWithRef.onPointerLeave
onPointerMove?
optionalonPointerMove?:PointerEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:354
Inherited from
ComponentPropsWithRef.onPointerMove
onPointerMoveCapture?
optionalonPointerMoveCapture?:PointerEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:355
Inherited from
ComponentPropsWithRef.onPointerMoveCapture
onPointerOut?
optionalonPointerOut?:PointerEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:364
Inherited from
ComponentPropsWithRef.onPointerOut
onPointerOutCapture?
optionalonPointerOutCapture?:PointerEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:365
Inherited from
ComponentPropsWithRef.onPointerOutCapture
onPointerOver?
optionalonPointerOver?:PointerEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:362
Inherited from
ComponentPropsWithRef.onPointerOver
onPointerOverCapture?
optionalonPointerOverCapture?:PointerEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:363
Inherited from
ComponentPropsWithRef.onPointerOverCapture
onPointerUp?
optionalonPointerUp?:PointerEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:356
Inherited from
ComponentPropsWithRef.onPointerUp
onPointerUpCapture?
optionalonPointerUpCapture?:PointerEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:357
Inherited from
ComponentPropsWithRef.onPointerUpCapture
onScroll?
optionalonScroll?:UIEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:372
Inherited from
ComponentPropsWithRef.onScroll
onScrollCapture?
optionalonScrollCapture?:UIEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:373
Inherited from
ComponentPropsWithRef.onScrollCapture
onTouchCancel?
optionalonTouchCancel?:TouchEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:342
Inherited from
ComponentPropsWithRef.onTouchCancel
onTouchCancelCapture?
optionalonTouchCancelCapture?:TouchEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:343
Inherited from
ComponentPropsWithRef.onTouchCancelCapture
onTouchEnd?
optionalonTouchEnd?:TouchEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:344
Inherited from
ComponentPropsWithRef.onTouchEnd
onTouchEndCapture?
optionalonTouchEndCapture?:TouchEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:345
Inherited from
ComponentPropsWithRef.onTouchEndCapture
onTouchMove?
optionalonTouchMove?:TouchEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:346
Inherited from
ComponentPropsWithRef.onTouchMove
onTouchMoveCapture?
optionalonTouchMoveCapture?:TouchEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:347
Inherited from
ComponentPropsWithRef.onTouchMoveCapture
onTouchStart?
optionalonTouchStart?:TouchEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:348
Inherited from
ComponentPropsWithRef.onTouchStart
onTouchStartCapture?
optionalonTouchStartCapture?:TouchEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:349
Inherited from
ComponentPropsWithRef.onTouchStartCapture
onTransitionCancel?
optionalonTransitionCancel?:TransitionEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:388
Inherited from
ComponentPropsWithRef.onTransitionCancel
onTransitionCancelCapture?
optionalonTransitionCancelCapture?:TransitionEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:389
Inherited from
ComponentPropsWithRef.onTransitionCancelCapture
onTransitionEnd?
optionalonTransitionEnd?:TransitionEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:390
Inherited from
ComponentPropsWithRef.onTransitionEnd
onTransitionEndCapture?
optionalonTransitionEndCapture?:TransitionEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:391
Inherited from
ComponentPropsWithRef.onTransitionEndCapture
onTransitionRun?
optionalonTransitionRun?:TransitionEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:392
Inherited from
ComponentPropsWithRef.onTransitionRun
onTransitionRunCapture?
optionalonTransitionRunCapture?:TransitionEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:393
Inherited from
ComponentPropsWithRef.onTransitionRunCapture
onTransitionStart?
optionalonTransitionStart?:TransitionEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:394
Inherited from
ComponentPropsWithRef.onTransitionStart
onTransitionStartCapture?
optionalonTransitionStartCapture?:TransitionEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:395
Inherited from
ComponentPropsWithRef.onTransitionStartCapture
onWheel?
optionalonWheel?:WheelEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:376
Inherited from
ComponentPropsWithRef.onWheel
onWheelCapture?
optionalonWheelCapture?:WheelEventHandler<HTMLDivElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:377
Inherited from
ComponentPropsWithRef.onWheelCapture
ref?
optionalref?:Ref<HTMLDivElement>
Defined in: node_modules/.pnpm/@types+react@19.2.17/node_modules/@types/react/index.d.ts:301
Allows getting a ref to the component instance. Once the component unmounts, React will set ref.current to null (or call the ref with null if you passed a callback ref).
See
Inherited from
ComponentPropsWithRef.ref
render?
optionalrender?:DOMRenderFunction<"div",ModalRenderProps>
Defined in: node_modules/.pnpm/react-aria-components@1.18._652bbfc7b5fa5f84b16cd32a1196785b/node_modules/react-aria-components/dist/types/src/utils.d.ts:194
Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components.
Requirements:
- You must render the expected element type (e.g. if
<button>is expected, you cannot render an<a>). - Only a single root DOM element can be rendered (no fragments).
- You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate.
Inherited from
ComponentPropsWithRef.render
shouldCloseOnInteractOutside?
optionalshouldCloseOnInteractOutside?: (element) =>boolean
Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/overlays/useOverlay.d.ts:27
When user interacts with the argument element outside of the overlay ref, return true if onClose should be called. This gives you a chance to filter out interaction with elements that should not dismiss the overlay. By default, onClose will always be called on interaction outside the overlay ref.
Parameters
element
Element
Returns
boolean
Inherited from
ComponentPropsWithRef.shouldCloseOnInteractOutside
slot?
optionalslot?:string|null
Defined in: node_modules/.pnpm/react-aria-components@1.18._652bbfc7b5fa5f84b16cd32a1196785b/node_modules/react-aria-components/dist/types/src/utils.d.ts:158
A slot name for the component. Slots allow the component to receive props from a parent component. An explicit null value indicates that the local props completely override all props received from a parent.
Inherited from
ComponentPropsWithRef.slot
style?
optionalstyle?:StyleOrFunction<ModalRenderProps>
Defined in: node_modules/.pnpm/react-aria-components@1.18._652bbfc7b5fa5f84b16cd32a1196785b/node_modules/react-aria-components/dist/types/src/utils.d.ts:118
The inline style for the element. A function may be provided to compute the style based on component state.
Inherited from
ComponentPropsWithRef.style
translate?
optionaltranslate?:"yes"|"no"
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:303
Inherited from
BreadcrumbsItemProps.translate
UNSTABLE_portalContainer?
optionalUNSTABLE_portalContainer?:Element
Defined in: node_modules/.pnpm/react-aria-components@1.18._652bbfc7b5fa5f84b16cd32a1196785b/node_modules/react-aria-components/dist/types/src/Modal.d.ts:29
The container element in which the overlay portal will be placed. This may have unknown behavior depending on where it is portalled to.
Deprecated
- Use a parent UNSAFE_PortalProvider to set your portal container instead.
Default
document.bodyInherited from
ComponentPropsWithRef.UNSTABLE_portalContainer
variant?
optionalvariant?:"transparent"|"opaque"|"blur"
Defined in: node_modules/.pnpm/@heroui+react@3.2.1_@react-_0c36d9022f1aaf46c104e0a6d2192bf4/node_modules/@heroui/react/dist/components/modal/modal.d.ts:20