React.Aria.Overlays

newtype UseModal hooks

Constructors

• UseModal hooks

type UseModalOptions = { isDisabled :: Boolean }

type ModalAria = { modalProps :: { "data-ismodal" :: Boolean } }

useModalImpl :: EffectFn1 UseModalOptions ModalAria

useModal :: UseModalOptions -> Hook UseModal ModalAria

newtype UseOverlay hooks

Constructors

• UseOverlay hooks

type UseOverlayProps :: Row Typetype UseOverlayProps = (isDismissable :: Boolean, isKeyboardDismissaDisabled :: Boolean, isOpen :: Boolean, onClose :: Effect Unit, shouldCloseOnBlur :: Boolean, shouldCloseOnInteractOutside :: HTMLElement -> Boolean)

type OverlayAria = { overlayProps :: { onKeyDown :: EventHandler }, underlayProps :: { onPointerDown :: EventHandler } }

useOverlayImpl :: forall useOverlayProps. EffectFn2 useOverlayProps (Ref (Nullable Node)) OverlayAria

useOverlay :: forall props props_. Union props props_ UseOverlayProps => Record props -> Ref (Nullable Node) -> Hook UseOverlay OverlayAria

newtype UseOverlayPosition hooks

Constructors

• UseOverlayPosition hooks

type UseAriaPositionPropsRequired :: Row Type -> Row Typetype UseAriaPositionPropsRequired r = (overlayRef :: Ref (Nullable Node), targetRef :: Ref (Nullable Node) | r)

type UseAriaPositionPropsOptional :: Row Typetype UseAriaPositionPropsOptional = (boundaryElement :: HTMLElement, containerPadding :: Number, crossOffset :: Number, isOpen :: Boolean, offset :: Number, onClose :: Effect Unit, placement :: String, scrollRef :: Ref (Nullable Node), shouldFlip :: Boolean, shouldUpdatePosition :: Boolean)

type PositionAria = { arrowProps :: { style :: CSS }, overlayProps :: { style :: CSS }, placement :: String, updatePosition :: Effect Unit }

useOverlayPositionImpl :: forall props. EffectFn1 props PositionAria

usePosition :: forall props props_. Union props props_ UseAriaPositionPropsOptional => Record (UseAriaPositionPropsRequired props) -> Hook UseOverlayPosition PositionAria

newtype UseOverlayTrigger hooks

Constructors

• UseOverlayTrigger hooks

type UseOverlayTriggerProps = { type :: String }

Type must be one of the following 'dialog' 'menu' 'listbox' 'tree' 'grid'

type UseOverlayTriggerState = { close :: Effect Unit, isOpen :: Boolean, open :: Effect Unit, toggle :: Effect Unit }

type OverlayTriggerAriaImpl = { overlayProps :: { id :: String }, triggerProps :: Object Foreign }

type OverlayTriggerAria = { overlayProps :: { id :: String }, triggerProps :: { _aria :: Object String } }

useOverlayTriggerImpl :: EffectFn3 UseOverlayTriggerProps UseOverlayTriggerState (Ref (Nullable Node)) OverlayTriggerAriaImpl

useOverlayTrigger :: UseOverlayTriggerProps -> UseOverlayTriggerState -> Ref (Nullable Node) -> Hook UseOverlayTrigger OverlayTriggerAria

newtype UsePreventScroll hooks

Constructors

• UsePreventScroll hooks

type UsePreventScrollOptions = { isDisabled :: Boolean }

usePreventScrollImpl :: EffectFn1 UsePreventScrollOptions Unit

usePreventScroll :: UsePreventScrollOptions -> Hook UsePreventScroll Unit

overlayProvider :: ReactComponent { children :: Array JSX }

overlayContainer :: ReactComponent { children :: Array JSX }

dismissButton :: ReactComponent { onDismiss :: Effect Unit }

modalProvider :: ReactComponent { children :: Array JSX }

toPSAria :: Object Foreign -> Object String