Skip to main content

PopoverTriggerProps

Extends​

  • ComponentProps<typeof Pressable>

Properties​

allowTextSelectionOnPress?​

optional allowTextSelectionOnPress: boolean

Whether text selection should be enabled on the pressable element.

Inherited from​

ComponentProps.allowTextSelectionOnPress

children​

children: ReactElement<DOMAttributes<FocusableElement>, string>

Inherited from​

ComponentProps.children

isDisabled?​

optional isDisabled: boolean

Whether the press events should be disabled.

Inherited from​

ComponentProps.isDisabled

isPressed?​

optional isPressed: boolean

Whether the target is in a controlled press state (e.g. an overlay it triggers is open).

Inherited from​

ComponentProps.isPressed

key?​

optional key: Key | null

Inherited from​

ComponentProps.key

onClick()?​

optional onClick: (e) => void

Not recommended – use onPress instead. onClick is an alias for onPress provided for compatibility with other libraries. onPress provides additional event details for non-mouse interactions.

Parameters​

e​

MouseEvent<FocusableElement>

Returns​

void

Inherited from​

ComponentProps.onClick

onPress()?​

optional onPress: (e) => void

Handler that is called when the press is released over the target.

Parameters​

e​

PressEvent

Returns​

void

Inherited from​

ComponentProps.onPress

onPressChange()?​

optional onPressChange: (isPressed) => void

Handler that is called when the press state changes.

Parameters​

isPressed​

boolean

Returns​

void

Inherited from​

ComponentProps.onPressChange

onPressEnd()?​

optional onPressEnd: (e) => void

Handler that is called when a press interaction ends, either over the target or when the pointer leaves the target.

Parameters​

e​

PressEvent

Returns​

void

Inherited from​

ComponentProps.onPressEnd

onPressStart()?​

optional onPressStart: (e) => void

Handler that is called when a press interaction starts.

Parameters​

e​

PressEvent

Returns​

void

Inherited from​

ComponentProps.onPressStart

onPressUp()?​

optional onPressUp: (e) => void

Handler that is called when a press is released over the target, regardless of whether it started on the target or not.

Parameters​

e​

PressEvent

Returns​

void

Inherited from​

ComponentProps.onPressUp

preventFocusOnPress?​

optional preventFocusOnPress: boolean

Whether the target should not receive focus on press.

Inherited from​

ComponentProps.preventFocusOnPress

ref?​

optional ref: Ref<FocusableElement>

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​

React Docs

Inherited from​

ComponentProps.ref

shouldCancelOnPointerExit?​

optional shouldCancelOnPointerExit: boolean

Whether press events should be canceled when the pointer leaves the target while pressed. By default, this is false, which means if the pointer returns back over the target while still pressed, onPressStart will be fired again. If set to true, the press is canceled when the pointer leaves the target and onPressStart will not be fired if the pointer returns.

Inherited from​

ComponentProps.shouldCancelOnPointerExit