Toast

Presents timed, stacked notifications with action, close, and swipe behavior.

Loading interactive demo…

const toast = useToastManager();

toast.add({ id: "saved", title: "Saved", description: "Your changes are live." });

<Toast.Provider timeout={5000} limit={3}>
  <Toast.Portal>
    <Toast.Viewport toasts={toast.toasts()} onDismiss={toast.dismiss}>
      <For each={toast.toasts()}>{(item) =>
        <Toast.Root toastId={item.id}>
          <Toast.Content><Toast.Title /><Toast.Description /></Toast.Content>
          <Toast.Close><Text>Close</Text></Toast.Close>
        </Toast.Root>
      }</For>
    </Toast.Viewport>
  </Toast.Portal>
</Toast.Provider>

#Import

Import Toast from @quickgui/solid.

import { Toast } from "@quickgui/solid";

#Usage

const toast = useToastManager();

toast.add({ id: "saved", title: "Saved", description: "Your changes are live." });

<Toast.Provider timeout={5000} limit={3}>
  <Toast.Portal>
    <Toast.Viewport toasts={toast.toasts()} onDismiss={toast.dismiss}>
      <For each={toast.toasts()}>{(item) =>
        <Toast.Root toastId={item.id}>
          <Toast.Content><Toast.Title /><Toast.Description /></Toast.Content>
          <Toast.Close><Text>Close</Text></Toast.Close>
        </Toast.Root>
      }</For>
    </Toast.Viewport>
  </Toast.Portal>
</Toast.Provider>

#Anatomy

Toast.Provider
Toast.Portal
Toast.Viewport
Toast.Positioner
Toast.Root
Toast.Content
Toast.Title
Toast.Description
Toast.Action
Toast.Close

<Toast.Root>
  <Toast.Provider />
  <Toast.Portal />
  <Toast.Viewport />
  <Toast.Positioner />
  <Toast.Content />
  <Toast.Title />
  <Toast.Description />
  <Toast.Action />
  <Toast.Close />
</Toast.Root>

#API reference

Expand an entry for its description and complete signature. A dash means no declaration default is documented.

`Toast`

View source

Toast(props: JSX.ToastProps): NativeNode

accessibilityLabelstring—

Declares accessibilityLabel (optional). Reactive JSX expressions update this property in place.

string

View source

childrenunknown—

Declares children (optional). Reactive JSX expressions update this property in place.

unknown

View source

styleStyleProp—

Layout, typography, paint, and interaction-state styles. Arrays merge left to right.

StyleProp

View source

disabledboolean—

Declares disabled (optional). Reactive JSX expressions update this property in place.

boolean

View source

invalidboolean—

Expose web-style invalid state; the `style.invalid` variant paints while it is set.

boolean

View source

selectedboolean—

Expose web-style selected state; the `style.selected` variant paints while it is set.

boolean

View source

groupboolean | string—

Makes this element the group its descendants' `groupHover` and `groupActive` styles follow, like Tailwind's `group`: `true` opens an unnamed group, and a string names it so a descendant can follow it past a nearer group with `groupHover: { group: "name" }`.

boolean | string

View source

rolestring—

Declares role (optional). Reactive JSX expressions update this property in place.

string

View source

tabIndexnumber—

Declares tabIndex (optional). Reactive JSX expressions update this property in place.

number

View source

focusOnPointerboolean—

Keep keyboard focus where it is when this element is activated with a pointer.

boolean

View source

overlayboolean—

Paint this subtree in the viewport overlay plane above embedded native views.

boolean

View source

focusTrapboolean—

Contain keyboard focus within this subtree while it is the topmost trap.

boolean

View source

restorePreviousFocusboolean—

Restore the previously focused mounted control when this surface unmounts.

boolean

View source

autoFocusboolean—

Prefer this control when its containing focus trap takes focus.

boolean

View source

aria-modalboolean—

Expose modal semantics to assistive technology.

boolean

View source

ariaModalboolean—

Declares ariaModal (optional). Reactive JSX expressions update this property in place.

boolean

View source

dismissOnEscapeboolean—

Declares dismissOnEscape (optional). Reactive JSX expressions update this property in place.

boolean

View source

dismissOnPointerOutsideboolean—

Declares dismissOnPointerOutside (optional). Reactive JSX expressions update this property in place.

boolean

View source

tooltipstring—

Delayed, pointer-passive native tooltip text shown while this element is hovered.

string

View source

tooltipPlacementPopoverPlacement—

Declares tooltipPlacement (optional). Reactive JSX expressions update this property in place.

PopoverPlacement

View source

tooltipDelaynumber—

Hover delay in milliseconds, clamped by the Rust core to at most ten seconds.

number

View source

tooltipGapnumber—

Declares tooltipGap (optional). Reactive JSX expressions update this property in place.

number

View source

tooltipViewportMarginnumber—

Declares tooltipViewportMargin (optional). Reactive JSX expressions update this property in place.

number

View source

hitSlopnumber | string—

Declares hitSlop (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopTopnumber | string—

Declares hitSlopTop (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopRightnumber | string—

Declares hitSlopRight (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopBottomnumber | string—

Declares hitSlopBottom (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopLeftnumber | string—

Declares hitSlopLeft (optional). Reactive JSX expressions update this property in place.

number | string

View source

aria-labelstring—

Declares aria-label (optional). Reactive JSX expressions update this property in place.

string

View source

ariaLabelstring—

Declares ariaLabel (optional). Reactive JSX expressions update this property in place.

string

View source

ref((node: NativeNode) => void) | NativeNode—

Declares ref (optional). Reactive JSX expressions update this property in place.

((node: NativeNode) => void) | NativeNode

View source

onClickEventHandler—

Declares onClick (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseEnterEventHandler—

Declares onMouseEnter (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseLeaveEventHandler—

Declares onMouseLeave (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerEnterEventHandler—

Declares onPointerEnter (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerLeaveEventHandler—

Declares onPointerLeave (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerEventHandler—

Captured pointer stream from press through release/cancel, including outside the element.

EventHandler

View source

onInputEventHandler—

Declares onInput (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onChangeEventHandler—

Declares onChange (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onSubmitEventHandler—

Declares onSubmit (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDismissEventHandler—

Declares onDismiss (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onKeyDownEventHandler—

Focused key press. Declare a `tabIndex` to make an ordinary container focusable.

EventHandler

View source

onKeyUpEventHandler—

Declares onKeyUp (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseDownEventHandler—

Declares onMouseDown (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseUpEventHandler—

Declares onMouseUp (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseMoveEventHandler—

Declares onMouseMove (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDoubleClickEventHandler—

Second press of one exact native multi-click sequence.

EventHandler

View source

onWheelEventHandler—

Declares onWheel (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onContextMenuEventHandler—

Secondary-button press. Use `ContextMenu` for a declared native menu.

EventHandler

View source

onPinchEventHandler—

Declares onPinch (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onRotateEventHandler—

Declares onRotate (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onSmartMagnifyEventHandler—

Declares onSmartMagnify (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPressureEventHandler—

Declares onPressure (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onFocusEventHandler—

Declares onFocus (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onBlurEventHandler—

Declares onBlur (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

keymapKeymap—

Bounded accelerator table resolved by the core while this element is focused.

Keymap

View source

onActionEventHandler—

Typed binding id dispatched by `keymap`.

EventHandler

View source

draggableboolean | DragSource—

Declared drag payload promoted when this element starts a drag.

boolean | DragSource

View source

onDragStartEventHandler—

Declares onDragStart (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDragEndEventHandler—

Declares onDragEnd (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

dropKindsDropKind | readonly DropKind[]—

Payload kinds this element accepts, declared ahead of the native drag.

DropKind | readonly DropKind[]

View source

onDropEventHandler—

Declares onDrop (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onFilesDroppedEventHandler—

Declares onFilesDropped (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

scopestring—

Stable key shared by every part of one component instance.

string

View source

toastIdstring—

Declared identifier of the queued toast this part belongs to.

string

View source

`Toast.Provider`

View source

Toast.Provider(props: JSX.ToastProviderProps): NativeNode

childrenunknown—

Declares children (optional). Reactive JSX expressions update this property in place.

unknown

View source

timeoutnumber—

Inherited auto-dismiss duration in milliseconds. Defaults to the core's five seconds.

number

View source

limitnumber—

How many toasts stay unlimited. Older ones are flagged, never silenced. Defaults to 3.

number

View source

expandedboolean—

Whether the stack is expanded.

boolean

View source

swipeDirection"left" | "right" | "up" | "down"—

Which way a swipe dismisses a toast.

"left" | "right" | "up" | "down"

View source

pitchnumber—

Stack pitch in logical pixels, which the core turns into each toast's own offset.

number

View source

`Toast.Portal`

View source

Toast.Portal(props: JSX.NativeScopedProps): NativeNode

accessibilityLabelstring—

Declares accessibilityLabel (optional). Reactive JSX expressions update this property in place.

string

View source

childrenunknown—

Declares children (optional). Reactive JSX expressions update this property in place.

unknown

View source

styleStyleProp—

Layout, typography, paint, and interaction-state styles. Arrays merge left to right.

StyleProp

View source

disabledboolean—

Declares disabled (optional). Reactive JSX expressions update this property in place.

boolean

View source

invalidboolean—

Expose web-style invalid state; the `style.invalid` variant paints while it is set.

boolean

View source

selectedboolean—

Expose web-style selected state; the `style.selected` variant paints while it is set.

boolean

View source

groupboolean | string—

boolean | string

View source

rolestring—

Declares role (optional). Reactive JSX expressions update this property in place.

string

View source

tabIndexnumber—

Declares tabIndex (optional). Reactive JSX expressions update this property in place.

number

View source

focusOnPointerboolean—

Keep keyboard focus where it is when this element is activated with a pointer.

boolean

View source

overlayboolean—

Paint this subtree in the viewport overlay plane above embedded native views.

boolean

View source

focusTrapboolean—

Contain keyboard focus within this subtree while it is the topmost trap.

boolean

View source

restorePreviousFocusboolean—

Restore the previously focused mounted control when this surface unmounts.

boolean

View source

autoFocusboolean—

Prefer this control when its containing focus trap takes focus.

boolean

View source

aria-modalboolean—

Expose modal semantics to assistive technology.

boolean

View source

ariaModalboolean—

Declares ariaModal (optional). Reactive JSX expressions update this property in place.

boolean

View source

dismissOnEscapeboolean—

Declares dismissOnEscape (optional). Reactive JSX expressions update this property in place.

boolean

View source

dismissOnPointerOutsideboolean—

Declares dismissOnPointerOutside (optional). Reactive JSX expressions update this property in place.

boolean

View source

tooltipstring—

Delayed, pointer-passive native tooltip text shown while this element is hovered.

string

View source

tooltipPlacementPopoverPlacement—

Declares tooltipPlacement (optional). Reactive JSX expressions update this property in place.

PopoverPlacement

View source

tooltipDelaynumber—

Hover delay in milliseconds, clamped by the Rust core to at most ten seconds.

number

View source

tooltipGapnumber—

Declares tooltipGap (optional). Reactive JSX expressions update this property in place.

number

View source

tooltipViewportMarginnumber—

Declares tooltipViewportMargin (optional). Reactive JSX expressions update this property in place.

number

View source

hitSlopnumber | string—

Declares hitSlop (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopTopnumber | string—

Declares hitSlopTop (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopRightnumber | string—

Declares hitSlopRight (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopBottomnumber | string—

Declares hitSlopBottom (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopLeftnumber | string—

Declares hitSlopLeft (optional). Reactive JSX expressions update this property in place.

number | string

View source

aria-labelstring—

Declares aria-label (optional). Reactive JSX expressions update this property in place.

string

View source

ariaLabelstring—

Declares ariaLabel (optional). Reactive JSX expressions update this property in place.

string

View source

ref((node: NativeNode) => void) | NativeNode—

Declares ref (optional). Reactive JSX expressions update this property in place.

((node: NativeNode) => void) | NativeNode

View source

onClickEventHandler—

Declares onClick (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseEnterEventHandler—

Declares onMouseEnter (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseLeaveEventHandler—

Declares onMouseLeave (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerEnterEventHandler—

Declares onPointerEnter (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerLeaveEventHandler—

Declares onPointerLeave (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerEventHandler—

Captured pointer stream from press through release/cancel, including outside the element.

EventHandler

View source

onInputEventHandler—

Declares onInput (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onChangeEventHandler—

Declares onChange (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onSubmitEventHandler—

Declares onSubmit (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDismissEventHandler—

Declares onDismiss (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onKeyDownEventHandler—

Focused key press. Declare a `tabIndex` to make an ordinary container focusable.

EventHandler

View source

onKeyUpEventHandler—

Declares onKeyUp (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseDownEventHandler—

Declares onMouseDown (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseUpEventHandler—

Declares onMouseUp (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseMoveEventHandler—

Declares onMouseMove (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDoubleClickEventHandler—

Second press of one exact native multi-click sequence.

EventHandler

View source

onWheelEventHandler—

Declares onWheel (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onContextMenuEventHandler—

Secondary-button press. Use `ContextMenu` for a declared native menu.

EventHandler

View source

onPinchEventHandler—

Declares onPinch (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onRotateEventHandler—

Declares onRotate (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onSmartMagnifyEventHandler—

Declares onSmartMagnify (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPressureEventHandler—

Declares onPressure (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onFocusEventHandler—

Declares onFocus (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onBlurEventHandler—

Declares onBlur (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

keymapKeymap—

Bounded accelerator table resolved by the core while this element is focused.

Keymap

View source

onActionEventHandler—

Typed binding id dispatched by `keymap`.

EventHandler

View source

draggableboolean | DragSource—

Declared drag payload promoted when this element starts a drag.

boolean | DragSource

View source

onDragStartEventHandler—

Declares onDragStart (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDragEndEventHandler—

Declares onDragEnd (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

dropKindsDropKind | readonly DropKind[]—

Payload kinds this element accepts, declared ahead of the native drag.

DropKind | readonly DropKind[]

View source

onDropEventHandler—

Declares onDrop (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onFilesDroppedEventHandler—

Declares onFilesDropped (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

scopestring—

Stable key shared by every part of one component instance.

string

View source

`Toast.Viewport`

View source

Toast.Viewport(props: JSX.ToastViewportProps): NativeNode

accessibilityLabelstring—

Declares accessibilityLabel (optional). Reactive JSX expressions update this property in place.

string

View source

childrenunknown—

Declares children (optional). Reactive JSX expressions update this property in place.

unknown

View source

styleStyleProp—

Layout, typography, paint, and interaction-state styles. Arrays merge left to right.

StyleProp

View source

disabledboolean—

Declares disabled (optional). Reactive JSX expressions update this property in place.

boolean

View source

invalidboolean—

Expose web-style invalid state; the `style.invalid` variant paints while it is set.

boolean

View source

selectedboolean—

Expose web-style selected state; the `style.selected` variant paints while it is set.

boolean

View source

groupboolean | string—

boolean | string

View source

rolestring—

Declares role (optional). Reactive JSX expressions update this property in place.

string

View source

tabIndexnumber—

Declares tabIndex (optional). Reactive JSX expressions update this property in place.

number

View source

focusOnPointerboolean—

Keep keyboard focus where it is when this element is activated with a pointer.

boolean

View source

overlayboolean—

Paint this subtree in the viewport overlay plane above embedded native views.

boolean

View source

focusTrapboolean—

Contain keyboard focus within this subtree while it is the topmost trap.

boolean

View source

restorePreviousFocusboolean—

Restore the previously focused mounted control when this surface unmounts.

boolean

View source

autoFocusboolean—

Prefer this control when its containing focus trap takes focus.

boolean

View source

aria-modalboolean—

Expose modal semantics to assistive technology.

boolean

View source

ariaModalboolean—

Declares ariaModal (optional). Reactive JSX expressions update this property in place.

boolean

View source

dismissOnEscapeboolean—

Declares dismissOnEscape (optional). Reactive JSX expressions update this property in place.

boolean

View source

dismissOnPointerOutsideboolean—

Declares dismissOnPointerOutside (optional). Reactive JSX expressions update this property in place.

boolean

View source

tooltipstring—

Delayed, pointer-passive native tooltip text shown while this element is hovered.

string

View source

tooltipPlacementPopoverPlacement—

Declares tooltipPlacement (optional). Reactive JSX expressions update this property in place.

PopoverPlacement

View source

tooltipDelaynumber—

Hover delay in milliseconds, clamped by the Rust core to at most ten seconds.

number

View source

tooltipGapnumber—

Declares tooltipGap (optional). Reactive JSX expressions update this property in place.

number

View source

tooltipViewportMarginnumber—

Declares tooltipViewportMargin (optional). Reactive JSX expressions update this property in place.

number

View source

hitSlopnumber | string—

Declares hitSlop (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopTopnumber | string—

Declares hitSlopTop (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopRightnumber | string—

Declares hitSlopRight (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopBottomnumber | string—

Declares hitSlopBottom (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopLeftnumber | string—

Declares hitSlopLeft (optional). Reactive JSX expressions update this property in place.

number | string

View source

aria-labelstring—

Declares aria-label (optional). Reactive JSX expressions update this property in place.

string

View source

ariaLabelstring—

Declares ariaLabel (optional). Reactive JSX expressions update this property in place.

string

View source

ref((node: NativeNode) => void) | NativeNode—

Declares ref (optional). Reactive JSX expressions update this property in place.

((node: NativeNode) => void) | NativeNode

View source

onClickEventHandler—

Declares onClick (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseEnterEventHandler—

Declares onMouseEnter (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseLeaveEventHandler—

Declares onMouseLeave (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerEnterEventHandler—

Declares onPointerEnter (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerLeaveEventHandler—

Declares onPointerLeave (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerEventHandler—

Captured pointer stream from press through release/cancel, including outside the element.

EventHandler

View source

onInputEventHandler—

Declares onInput (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onChangeEventHandler—

Declares onChange (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onSubmitEventHandler—

Declares onSubmit (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onKeyDownEventHandler—

Focused key press. Declare a `tabIndex` to make an ordinary container focusable.

EventHandler

View source

onKeyUpEventHandler—

Declares onKeyUp (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseDownEventHandler—

Declares onMouseDown (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseUpEventHandler—

Declares onMouseUp (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseMoveEventHandler—

Declares onMouseMove (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDoubleClickEventHandler—

Second press of one exact native multi-click sequence.

EventHandler

View source

onWheelEventHandler—

Declares onWheel (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onContextMenuEventHandler—

Secondary-button press. Use `ContextMenu` for a declared native menu.

EventHandler

View source

onPinchEventHandler—

Declares onPinch (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onRotateEventHandler—

Declares onRotate (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onSmartMagnifyEventHandler—

Declares onSmartMagnify (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPressureEventHandler—

Declares onPressure (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onFocusEventHandler—

Declares onFocus (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onBlurEventHandler—

Declares onBlur (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

keymapKeymap—

Bounded accelerator table resolved by the core while this element is focused.

Keymap

View source

onActionEventHandler—

Typed binding id dispatched by `keymap`.

EventHandler

View source

draggableboolean | DragSource—

Declared drag payload promoted when this element starts a drag.

boolean | DragSource

View source

onDragStartEventHandler—

Declares onDragStart (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDragEndEventHandler—

Declares onDragEnd (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

dropKindsDropKind | readonly DropKind[]—

Payload kinds this element accepts, declared ahead of the native drag.

DropKind | readonly DropKind[]

View source

onDropEventHandler—

Declares onDrop (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onFilesDroppedEventHandler—

Declares onFilesDropped (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

scopestring—

Stable key shared by every part of one component instance.

string

View source

timeoutnumber—

Declares timeout (optional). Reactive JSX expressions update this property in place.

number

View source

limitnumber—

Declares limit (optional). Reactive JSX expressions update this property in place.

number

View source

expandedboolean—

Declares expanded (optional). Reactive JSX expressions update this property in place.

boolean

View source

swipeDirection"left" | "right" | "up" | "down"—

Declares swipeDirection (optional). Reactive JSX expressions update this property in place.

"left" | "right" | "up" | "down"

View source

pitchnumber—

Declares pitch (optional). Reactive JSX expressions update this property in place.

number

View source

onStackChange(stack: readonly ToastStackEntry[], event: QuickGuiEvent) => void—

Everything the core decided about the queue: index, offset, limited and expanded flags.

(stack: readonly ToastStackEntry[], event: QuickGuiEvent) => void

View source

toastsreadonly ToastDeclaration[]—

The bounded queue. Adding an entry pushes a toast; dropping one dismisses it.

readonly ToastDeclaration[]

View source

onDismiss(ids: readonly string[], event: QuickGuiEvent) => void—

Every dismissal the core decided, including timed auto-dismissals.

(ids: readonly string[], event: QuickGuiEvent) => void

View source

`Toast.Positioner`

View source

Toast.Positioner(props: JSX.ToastProps): NativeNode

accessibilityLabelstring—

Declares accessibilityLabel (optional). Reactive JSX expressions update this property in place.

string

View source

childrenunknown—

Declares children (optional). Reactive JSX expressions update this property in place.

unknown

View source

styleStyleProp—

Layout, typography, paint, and interaction-state styles. Arrays merge left to right.

StyleProp

View source

disabledboolean—

Declares disabled (optional). Reactive JSX expressions update this property in place.

boolean

View source

invalidboolean—

Expose web-style invalid state; the `style.invalid` variant paints while it is set.

boolean

View source

selectedboolean—

Expose web-style selected state; the `style.selected` variant paints while it is set.

boolean

View source

groupboolean | string—

boolean | string

View source

rolestring—

Declares role (optional). Reactive JSX expressions update this property in place.

string

View source

tabIndexnumber—

Declares tabIndex (optional). Reactive JSX expressions update this property in place.

number

View source

focusOnPointerboolean—

Keep keyboard focus where it is when this element is activated with a pointer.

boolean

View source

overlayboolean—

Paint this subtree in the viewport overlay plane above embedded native views.

boolean

View source

focusTrapboolean—

Contain keyboard focus within this subtree while it is the topmost trap.

boolean

View source

restorePreviousFocusboolean—

Restore the previously focused mounted control when this surface unmounts.

boolean

View source

autoFocusboolean—

Prefer this control when its containing focus trap takes focus.

boolean

View source

aria-modalboolean—

Expose modal semantics to assistive technology.

boolean

View source

ariaModalboolean—

Declares ariaModal (optional). Reactive JSX expressions update this property in place.

boolean

View source

dismissOnEscapeboolean—

Declares dismissOnEscape (optional). Reactive JSX expressions update this property in place.

boolean

View source

dismissOnPointerOutsideboolean—

Declares dismissOnPointerOutside (optional). Reactive JSX expressions update this property in place.

boolean

View source

tooltipstring—

Delayed, pointer-passive native tooltip text shown while this element is hovered.

string

View source

tooltipPlacementPopoverPlacement—

Declares tooltipPlacement (optional). Reactive JSX expressions update this property in place.

PopoverPlacement

View source

tooltipDelaynumber—

Hover delay in milliseconds, clamped by the Rust core to at most ten seconds.

number

View source

tooltipGapnumber—

Declares tooltipGap (optional). Reactive JSX expressions update this property in place.

number

View source

tooltipViewportMarginnumber—

Declares tooltipViewportMargin (optional). Reactive JSX expressions update this property in place.

number

View source

hitSlopnumber | string—

Declares hitSlop (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopTopnumber | string—

Declares hitSlopTop (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopRightnumber | string—

Declares hitSlopRight (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopBottomnumber | string—

Declares hitSlopBottom (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopLeftnumber | string—

Declares hitSlopLeft (optional). Reactive JSX expressions update this property in place.

number | string

View source

aria-labelstring—

Declares aria-label (optional). Reactive JSX expressions update this property in place.

string

View source

ariaLabelstring—

Declares ariaLabel (optional). Reactive JSX expressions update this property in place.

string

View source

ref((node: NativeNode) => void) | NativeNode—

Declares ref (optional). Reactive JSX expressions update this property in place.

((node: NativeNode) => void) | NativeNode

View source

onClickEventHandler—

Declares onClick (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseEnterEventHandler—

Declares onMouseEnter (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseLeaveEventHandler—

Declares onMouseLeave (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerEnterEventHandler—

Declares onPointerEnter (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerLeaveEventHandler—

Declares onPointerLeave (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerEventHandler—

Captured pointer stream from press through release/cancel, including outside the element.

EventHandler

View source

onInputEventHandler—

Declares onInput (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onChangeEventHandler—

Declares onChange (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onSubmitEventHandler—

Declares onSubmit (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDismissEventHandler—

Declares onDismiss (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onKeyDownEventHandler—

Focused key press. Declare a `tabIndex` to make an ordinary container focusable.

EventHandler

View source

onKeyUpEventHandler—

Declares onKeyUp (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseDownEventHandler—

Declares onMouseDown (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseUpEventHandler—

Declares onMouseUp (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseMoveEventHandler—

Declares onMouseMove (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDoubleClickEventHandler—

Second press of one exact native multi-click sequence.

EventHandler

View source

onWheelEventHandler—

Declares onWheel (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onContextMenuEventHandler—

Secondary-button press. Use `ContextMenu` for a declared native menu.

EventHandler

View source

onPinchEventHandler—

Declares onPinch (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onRotateEventHandler—

Declares onRotate (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onSmartMagnifyEventHandler—

Declares onSmartMagnify (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPressureEventHandler—

Declares onPressure (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onFocusEventHandler—

Declares onFocus (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onBlurEventHandler—

Declares onBlur (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

keymapKeymap—

Bounded accelerator table resolved by the core while this element is focused.

Keymap

View source

onActionEventHandler—

Typed binding id dispatched by `keymap`.

EventHandler

View source

draggableboolean | DragSource—

Declared drag payload promoted when this element starts a drag.

boolean | DragSource

View source

onDragStartEventHandler—

Declares onDragStart (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDragEndEventHandler—

Declares onDragEnd (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

dropKindsDropKind | readonly DropKind[]—

Payload kinds this element accepts, declared ahead of the native drag.

DropKind | readonly DropKind[]

View source

onDropEventHandler—

Declares onDrop (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onFilesDroppedEventHandler—

Declares onFilesDropped (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

scopestring—

Stable key shared by every part of one component instance.

string

View source

toastIdstring—

Declared identifier of the queued toast this part belongs to.

string

View source

`Toast.Root`

View source

Toast.Root(props: JSX.ToastProps): NativeNode

accessibilityLabelstring—

Declares accessibilityLabel (optional). Reactive JSX expressions update this property in place.

string

View source

childrenunknown—

Declares children (optional). Reactive JSX expressions update this property in place.

unknown

View source

styleStyleProp—

Layout, typography, paint, and interaction-state styles. Arrays merge left to right.

StyleProp

View source

disabledboolean—

Declares disabled (optional). Reactive JSX expressions update this property in place.

boolean

View source

invalidboolean—

Expose web-style invalid state; the `style.invalid` variant paints while it is set.

boolean

View source

selectedboolean—

Expose web-style selected state; the `style.selected` variant paints while it is set.

boolean

View source

groupboolean | string—

boolean | string

View source

rolestring—

Declares role (optional). Reactive JSX expressions update this property in place.

string

View source

tabIndexnumber—

Declares tabIndex (optional). Reactive JSX expressions update this property in place.

number

View source

focusOnPointerboolean—

Keep keyboard focus where it is when this element is activated with a pointer.

boolean

View source

overlayboolean—

Paint this subtree in the viewport overlay plane above embedded native views.

boolean

View source

focusTrapboolean—

Contain keyboard focus within this subtree while it is the topmost trap.

boolean

View source

restorePreviousFocusboolean—

Restore the previously focused mounted control when this surface unmounts.

boolean

View source

autoFocusboolean—

Prefer this control when its containing focus trap takes focus.

boolean

View source

aria-modalboolean—

Expose modal semantics to assistive technology.

boolean

View source

ariaModalboolean—

Declares ariaModal (optional). Reactive JSX expressions update this property in place.

boolean

View source

dismissOnEscapeboolean—

Declares dismissOnEscape (optional). Reactive JSX expressions update this property in place.

boolean

View source

dismissOnPointerOutsideboolean—

Declares dismissOnPointerOutside (optional). Reactive JSX expressions update this property in place.

boolean

View source

tooltipstring—

Delayed, pointer-passive native tooltip text shown while this element is hovered.

string

View source

tooltipPlacementPopoverPlacement—

Declares tooltipPlacement (optional). Reactive JSX expressions update this property in place.

PopoverPlacement

View source

tooltipDelaynumber—

Hover delay in milliseconds, clamped by the Rust core to at most ten seconds.

number

View source

tooltipGapnumber—

Declares tooltipGap (optional). Reactive JSX expressions update this property in place.

number

View source

tooltipViewportMarginnumber—

Declares tooltipViewportMargin (optional). Reactive JSX expressions update this property in place.

number

View source

hitSlopnumber | string—

Declares hitSlop (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopTopnumber | string—

Declares hitSlopTop (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopRightnumber | string—

Declares hitSlopRight (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopBottomnumber | string—

Declares hitSlopBottom (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopLeftnumber | string—

Declares hitSlopLeft (optional). Reactive JSX expressions update this property in place.

number | string

View source

aria-labelstring—

Declares aria-label (optional). Reactive JSX expressions update this property in place.

string

View source

ariaLabelstring—

Declares ariaLabel (optional). Reactive JSX expressions update this property in place.

string

View source

ref((node: NativeNode) => void) | NativeNode—

Declares ref (optional). Reactive JSX expressions update this property in place.

((node: NativeNode) => void) | NativeNode

View source

onClickEventHandler—

Declares onClick (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseEnterEventHandler—

Declares onMouseEnter (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseLeaveEventHandler—

Declares onMouseLeave (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerEnterEventHandler—

Declares onPointerEnter (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerLeaveEventHandler—

Declares onPointerLeave (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerEventHandler—

Captured pointer stream from press through release/cancel, including outside the element.

EventHandler

View source

onInputEventHandler—

Declares onInput (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onChangeEventHandler—

Declares onChange (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onSubmitEventHandler—

Declares onSubmit (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDismissEventHandler—

Declares onDismiss (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onKeyDownEventHandler—

Focused key press. Declare a `tabIndex` to make an ordinary container focusable.

EventHandler

View source

onKeyUpEventHandler—

Declares onKeyUp (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseDownEventHandler—

Declares onMouseDown (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseUpEventHandler—

Declares onMouseUp (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseMoveEventHandler—

Declares onMouseMove (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDoubleClickEventHandler—

Second press of one exact native multi-click sequence.

EventHandler

View source

onWheelEventHandler—

Declares onWheel (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onContextMenuEventHandler—

Secondary-button press. Use `ContextMenu` for a declared native menu.

EventHandler

View source

onPinchEventHandler—

Declares onPinch (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onRotateEventHandler—

Declares onRotate (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onSmartMagnifyEventHandler—

Declares onSmartMagnify (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPressureEventHandler—

Declares onPressure (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onFocusEventHandler—

Declares onFocus (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onBlurEventHandler—

Declares onBlur (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

keymapKeymap—

Bounded accelerator table resolved by the core while this element is focused.

Keymap

View source

onActionEventHandler—

Typed binding id dispatched by `keymap`.

EventHandler

View source

draggableboolean | DragSource—

Declared drag payload promoted when this element starts a drag.

boolean | DragSource

View source

onDragStartEventHandler—

Declares onDragStart (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDragEndEventHandler—

Declares onDragEnd (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

dropKindsDropKind | readonly DropKind[]—

Payload kinds this element accepts, declared ahead of the native drag.

DropKind | readonly DropKind[]

View source

onDropEventHandler—

Declares onDrop (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onFilesDroppedEventHandler—

Declares onFilesDropped (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

scopestring—

Stable key shared by every part of one component instance.

string

View source

toastIdstring—

Declared identifier of the queued toast this part belongs to.

string

View source

`Toast.Content`

View source

Toast.Content(props: JSX.ToastProps): NativeNode

accessibilityLabelstring—

Declares accessibilityLabel (optional). Reactive JSX expressions update this property in place.

string

View source

childrenunknown—

Declares children (optional). Reactive JSX expressions update this property in place.

unknown

View source

styleStyleProp—

Layout, typography, paint, and interaction-state styles. Arrays merge left to right.

StyleProp

View source

disabledboolean—

Declares disabled (optional). Reactive JSX expressions update this property in place.

boolean

View source

invalidboolean—

Expose web-style invalid state; the `style.invalid` variant paints while it is set.

boolean

View source

selectedboolean—

Expose web-style selected state; the `style.selected` variant paints while it is set.

boolean

View source

groupboolean | string—

boolean | string

View source

rolestring—

Declares role (optional). Reactive JSX expressions update this property in place.

string

View source

tabIndexnumber—

Declares tabIndex (optional). Reactive JSX expressions update this property in place.

number

View source

focusOnPointerboolean—

Keep keyboard focus where it is when this element is activated with a pointer.

boolean

View source

overlayboolean—

Paint this subtree in the viewport overlay plane above embedded native views.

boolean

View source

focusTrapboolean—

Contain keyboard focus within this subtree while it is the topmost trap.

boolean

View source

restorePreviousFocusboolean—

Restore the previously focused mounted control when this surface unmounts.

boolean

View source

autoFocusboolean—

Prefer this control when its containing focus trap takes focus.

boolean

View source

aria-modalboolean—

Expose modal semantics to assistive technology.

boolean

View source

ariaModalboolean—

Declares ariaModal (optional). Reactive JSX expressions update this property in place.

boolean

View source

dismissOnEscapeboolean—

Declares dismissOnEscape (optional). Reactive JSX expressions update this property in place.

boolean

View source

dismissOnPointerOutsideboolean—

Declares dismissOnPointerOutside (optional). Reactive JSX expressions update this property in place.

boolean

View source

tooltipstring—

Delayed, pointer-passive native tooltip text shown while this element is hovered.

string

View source

tooltipPlacementPopoverPlacement—

Declares tooltipPlacement (optional). Reactive JSX expressions update this property in place.

PopoverPlacement

View source

tooltipDelaynumber—

Hover delay in milliseconds, clamped by the Rust core to at most ten seconds.

number

View source

tooltipGapnumber—

Declares tooltipGap (optional). Reactive JSX expressions update this property in place.

number

View source

tooltipViewportMarginnumber—

Declares tooltipViewportMargin (optional). Reactive JSX expressions update this property in place.

number

View source

hitSlopnumber | string—

Declares hitSlop (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopTopnumber | string—

Declares hitSlopTop (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopRightnumber | string—

Declares hitSlopRight (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopBottomnumber | string—

Declares hitSlopBottom (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopLeftnumber | string—

Declares hitSlopLeft (optional). Reactive JSX expressions update this property in place.

number | string

View source

aria-labelstring—

Declares aria-label (optional). Reactive JSX expressions update this property in place.

string

View source

ariaLabelstring—

Declares ariaLabel (optional). Reactive JSX expressions update this property in place.

string

View source

ref((node: NativeNode) => void) | NativeNode—

Declares ref (optional). Reactive JSX expressions update this property in place.

((node: NativeNode) => void) | NativeNode

View source

onClickEventHandler—

Declares onClick (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseEnterEventHandler—

Declares onMouseEnter (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseLeaveEventHandler—

Declares onMouseLeave (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerEnterEventHandler—

Declares onPointerEnter (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerLeaveEventHandler—

Declares onPointerLeave (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerEventHandler—

Captured pointer stream from press through release/cancel, including outside the element.

EventHandler

View source

onInputEventHandler—

Declares onInput (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onChangeEventHandler—

Declares onChange (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onSubmitEventHandler—

Declares onSubmit (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDismissEventHandler—

Declares onDismiss (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onKeyDownEventHandler—

Focused key press. Declare a `tabIndex` to make an ordinary container focusable.

EventHandler

View source

onKeyUpEventHandler—

Declares onKeyUp (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseDownEventHandler—

Declares onMouseDown (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseUpEventHandler—

Declares onMouseUp (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseMoveEventHandler—

Declares onMouseMove (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDoubleClickEventHandler—

Second press of one exact native multi-click sequence.

EventHandler

View source

onWheelEventHandler—

Declares onWheel (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onContextMenuEventHandler—

Secondary-button press. Use `ContextMenu` for a declared native menu.

EventHandler

View source

onPinchEventHandler—

Declares onPinch (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onRotateEventHandler—

Declares onRotate (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onSmartMagnifyEventHandler—

Declares onSmartMagnify (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPressureEventHandler—

Declares onPressure (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onFocusEventHandler—

Declares onFocus (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onBlurEventHandler—

Declares onBlur (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

keymapKeymap—

Bounded accelerator table resolved by the core while this element is focused.

Keymap

View source

onActionEventHandler—

Typed binding id dispatched by `keymap`.

EventHandler

View source

draggableboolean | DragSource—

Declared drag payload promoted when this element starts a drag.

boolean | DragSource

View source

onDragStartEventHandler—

Declares onDragStart (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDragEndEventHandler—

Declares onDragEnd (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

dropKindsDropKind | readonly DropKind[]—

Payload kinds this element accepts, declared ahead of the native drag.

DropKind | readonly DropKind[]

View source

onDropEventHandler—

Declares onDrop (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onFilesDroppedEventHandler—

Declares onFilesDropped (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

scopestring—

Stable key shared by every part of one component instance.

string

View source

toastIdstring—

Declared identifier of the queued toast this part belongs to.

string

View source

`Toast.Title`

View source

Toast.Title(props: JSX.ToastProps): NativeNode

accessibilityLabelstring—

Declares accessibilityLabel (optional). Reactive JSX expressions update this property in place.

string

View source

childrenunknown—

Declares children (optional). Reactive JSX expressions update this property in place.

unknown

View source

styleStyleProp—

Layout, typography, paint, and interaction-state styles. Arrays merge left to right.

StyleProp

View source

disabledboolean—

Declares disabled (optional). Reactive JSX expressions update this property in place.

boolean

View source

invalidboolean—

Expose web-style invalid state; the `style.invalid` variant paints while it is set.

boolean

View source

selectedboolean—

Expose web-style selected state; the `style.selected` variant paints while it is set.

boolean

View source

groupboolean | string—

boolean | string

View source

rolestring—

Declares role (optional). Reactive JSX expressions update this property in place.

string

View source

tabIndexnumber—

Declares tabIndex (optional). Reactive JSX expressions update this property in place.

number

View source

focusOnPointerboolean—

Keep keyboard focus where it is when this element is activated with a pointer.

boolean

View source

overlayboolean—

Paint this subtree in the viewport overlay plane above embedded native views.

boolean

View source

focusTrapboolean—

Contain keyboard focus within this subtree while it is the topmost trap.

boolean

View source

restorePreviousFocusboolean—

Restore the previously focused mounted control when this surface unmounts.

boolean

View source

autoFocusboolean—

Prefer this control when its containing focus trap takes focus.

boolean

View source

aria-modalboolean—

Expose modal semantics to assistive technology.

boolean

View source

ariaModalboolean—

Declares ariaModal (optional). Reactive JSX expressions update this property in place.

boolean

View source

dismissOnEscapeboolean—

Declares dismissOnEscape (optional). Reactive JSX expressions update this property in place.

boolean

View source

dismissOnPointerOutsideboolean—

Declares dismissOnPointerOutside (optional). Reactive JSX expressions update this property in place.

boolean

View source

tooltipstring—

Delayed, pointer-passive native tooltip text shown while this element is hovered.

string

View source

tooltipPlacementPopoverPlacement—

Declares tooltipPlacement (optional). Reactive JSX expressions update this property in place.

PopoverPlacement

View source

tooltipDelaynumber—

Hover delay in milliseconds, clamped by the Rust core to at most ten seconds.

number

View source

tooltipGapnumber—

Declares tooltipGap (optional). Reactive JSX expressions update this property in place.

number

View source

tooltipViewportMarginnumber—

Declares tooltipViewportMargin (optional). Reactive JSX expressions update this property in place.

number

View source

hitSlopnumber | string—

Declares hitSlop (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopTopnumber | string—

Declares hitSlopTop (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopRightnumber | string—

Declares hitSlopRight (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopBottomnumber | string—

Declares hitSlopBottom (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopLeftnumber | string—

Declares hitSlopLeft (optional). Reactive JSX expressions update this property in place.

number | string

View source

aria-labelstring—

Declares aria-label (optional). Reactive JSX expressions update this property in place.

string

View source

ariaLabelstring—

Declares ariaLabel (optional). Reactive JSX expressions update this property in place.

string

View source

ref((node: NativeNode) => void) | NativeNode—

Declares ref (optional). Reactive JSX expressions update this property in place.

((node: NativeNode) => void) | NativeNode

View source

onClickEventHandler—

Declares onClick (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseEnterEventHandler—

Declares onMouseEnter (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseLeaveEventHandler—

Declares onMouseLeave (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerEnterEventHandler—

Declares onPointerEnter (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerLeaveEventHandler—

Declares onPointerLeave (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerEventHandler—

Captured pointer stream from press through release/cancel, including outside the element.

EventHandler

View source

onInputEventHandler—

Declares onInput (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onChangeEventHandler—

Declares onChange (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onSubmitEventHandler—

Declares onSubmit (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDismissEventHandler—

Declares onDismiss (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onKeyDownEventHandler—

Focused key press. Declare a `tabIndex` to make an ordinary container focusable.

EventHandler

View source

onKeyUpEventHandler—

Declares onKeyUp (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseDownEventHandler—

Declares onMouseDown (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseUpEventHandler—

Declares onMouseUp (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseMoveEventHandler—

Declares onMouseMove (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDoubleClickEventHandler—

Second press of one exact native multi-click sequence.

EventHandler

View source

onWheelEventHandler—

Declares onWheel (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onContextMenuEventHandler—

Secondary-button press. Use `ContextMenu` for a declared native menu.

EventHandler

View source

onPinchEventHandler—

Declares onPinch (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onRotateEventHandler—

Declares onRotate (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onSmartMagnifyEventHandler—

Declares onSmartMagnify (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPressureEventHandler—

Declares onPressure (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onFocusEventHandler—

Declares onFocus (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onBlurEventHandler—

Declares onBlur (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

keymapKeymap—

Bounded accelerator table resolved by the core while this element is focused.

Keymap

View source

onActionEventHandler—

Typed binding id dispatched by `keymap`.

EventHandler

View source

draggableboolean | DragSource—

Declared drag payload promoted when this element starts a drag.

boolean | DragSource

View source

onDragStartEventHandler—

Declares onDragStart (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDragEndEventHandler—

Declares onDragEnd (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

dropKindsDropKind | readonly DropKind[]—

Payload kinds this element accepts, declared ahead of the native drag.

DropKind | readonly DropKind[]

View source

onDropEventHandler—

Declares onDrop (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onFilesDroppedEventHandler—

Declares onFilesDropped (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

scopestring—

Stable key shared by every part of one component instance.

string

View source

toastIdstring—

Declared identifier of the queued toast this part belongs to.

string

View source

`Toast.Description`

View source

Toast.Description(props: JSX.ToastProps): NativeNode

accessibilityLabelstring—

Declares accessibilityLabel (optional). Reactive JSX expressions update this property in place.

string

View source

childrenunknown—

Declares children (optional). Reactive JSX expressions update this property in place.

unknown

View source

styleStyleProp—

Layout, typography, paint, and interaction-state styles. Arrays merge left to right.

StyleProp

View source

disabledboolean—

Declares disabled (optional). Reactive JSX expressions update this property in place.

boolean

View source

invalidboolean—

Expose web-style invalid state; the `style.invalid` variant paints while it is set.

boolean

View source

selectedboolean—

Expose web-style selected state; the `style.selected` variant paints while it is set.

boolean

View source

groupboolean | string—

boolean | string

View source

rolestring—

Declares role (optional). Reactive JSX expressions update this property in place.

string

View source

tabIndexnumber—

Declares tabIndex (optional). Reactive JSX expressions update this property in place.

number

View source

focusOnPointerboolean—

Keep keyboard focus where it is when this element is activated with a pointer.

boolean

View source

overlayboolean—

Paint this subtree in the viewport overlay plane above embedded native views.

boolean

View source

focusTrapboolean—

Contain keyboard focus within this subtree while it is the topmost trap.

boolean

View source

restorePreviousFocusboolean—

Restore the previously focused mounted control when this surface unmounts.

boolean

View source

autoFocusboolean—

Prefer this control when its containing focus trap takes focus.

boolean

View source

aria-modalboolean—

Expose modal semantics to assistive technology.

boolean

View source

ariaModalboolean—

Declares ariaModal (optional). Reactive JSX expressions update this property in place.

boolean

View source

dismissOnEscapeboolean—

Declares dismissOnEscape (optional). Reactive JSX expressions update this property in place.

boolean

View source

dismissOnPointerOutsideboolean—

Declares dismissOnPointerOutside (optional). Reactive JSX expressions update this property in place.

boolean

View source

tooltipstring—

Delayed, pointer-passive native tooltip text shown while this element is hovered.

string

View source

tooltipPlacementPopoverPlacement—

Declares tooltipPlacement (optional). Reactive JSX expressions update this property in place.

PopoverPlacement

View source

tooltipDelaynumber—

Hover delay in milliseconds, clamped by the Rust core to at most ten seconds.

number

View source

tooltipGapnumber—

Declares tooltipGap (optional). Reactive JSX expressions update this property in place.

number

View source

tooltipViewportMarginnumber—

Declares tooltipViewportMargin (optional). Reactive JSX expressions update this property in place.

number

View source

hitSlopnumber | string—

Declares hitSlop (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopTopnumber | string—

Declares hitSlopTop (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopRightnumber | string—

Declares hitSlopRight (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopBottomnumber | string—

Declares hitSlopBottom (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopLeftnumber | string—

Declares hitSlopLeft (optional). Reactive JSX expressions update this property in place.

number | string

View source

aria-labelstring—

Declares aria-label (optional). Reactive JSX expressions update this property in place.

string

View source

ariaLabelstring—

Declares ariaLabel (optional). Reactive JSX expressions update this property in place.

string

View source

ref((node: NativeNode) => void) | NativeNode—

Declares ref (optional). Reactive JSX expressions update this property in place.

((node: NativeNode) => void) | NativeNode

View source

onClickEventHandler—

Declares onClick (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseEnterEventHandler—

Declares onMouseEnter (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseLeaveEventHandler—

Declares onMouseLeave (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerEnterEventHandler—

Declares onPointerEnter (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerLeaveEventHandler—

Declares onPointerLeave (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerEventHandler—

Captured pointer stream from press through release/cancel, including outside the element.

EventHandler

View source

onInputEventHandler—

Declares onInput (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onChangeEventHandler—

Declares onChange (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onSubmitEventHandler—

Declares onSubmit (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDismissEventHandler—

Declares onDismiss (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onKeyDownEventHandler—

Focused key press. Declare a `tabIndex` to make an ordinary container focusable.

EventHandler

View source

onKeyUpEventHandler—

Declares onKeyUp (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseDownEventHandler—

Declares onMouseDown (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseUpEventHandler—

Declares onMouseUp (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseMoveEventHandler—

Declares onMouseMove (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDoubleClickEventHandler—

Second press of one exact native multi-click sequence.

EventHandler

View source

onWheelEventHandler—

Declares onWheel (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onContextMenuEventHandler—

Secondary-button press. Use `ContextMenu` for a declared native menu.

EventHandler

View source

onPinchEventHandler—

Declares onPinch (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onRotateEventHandler—

Declares onRotate (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onSmartMagnifyEventHandler—

Declares onSmartMagnify (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPressureEventHandler—

Declares onPressure (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onFocusEventHandler—

Declares onFocus (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onBlurEventHandler—

Declares onBlur (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

keymapKeymap—

Bounded accelerator table resolved by the core while this element is focused.

Keymap

View source

onActionEventHandler—

Typed binding id dispatched by `keymap`.

EventHandler

View source

draggableboolean | DragSource—

Declared drag payload promoted when this element starts a drag.

boolean | DragSource

View source

onDragStartEventHandler—

Declares onDragStart (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDragEndEventHandler—

Declares onDragEnd (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

dropKindsDropKind | readonly DropKind[]—

Payload kinds this element accepts, declared ahead of the native drag.

DropKind | readonly DropKind[]

View source

onDropEventHandler—

Declares onDrop (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onFilesDroppedEventHandler—

Declares onFilesDropped (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

scopestring—

Stable key shared by every part of one component instance.

string

View source

toastIdstring—

Declared identifier of the queued toast this part belongs to.

string

View source

`Toast.Action`

View source

Toast.Action(props: JSX.ToastProps): NativeNode

accessibilityLabelstring—

Declares accessibilityLabel (optional). Reactive JSX expressions update this property in place.

string

View source

childrenunknown—

Declares children (optional). Reactive JSX expressions update this property in place.

unknown

View source

styleStyleProp—

Layout, typography, paint, and interaction-state styles. Arrays merge left to right.

StyleProp

View source

disabledboolean—

Declares disabled (optional). Reactive JSX expressions update this property in place.

boolean

View source

invalidboolean—

Expose web-style invalid state; the `style.invalid` variant paints while it is set.

boolean

View source

selectedboolean—

Expose web-style selected state; the `style.selected` variant paints while it is set.

boolean

View source

groupboolean | string—

boolean | string

View source

rolestring—

Declares role (optional). Reactive JSX expressions update this property in place.

string

View source

tabIndexnumber—

Declares tabIndex (optional). Reactive JSX expressions update this property in place.

number

View source

focusOnPointerboolean—

Keep keyboard focus where it is when this element is activated with a pointer.

boolean

View source

overlayboolean—

Paint this subtree in the viewport overlay plane above embedded native views.

boolean

View source

focusTrapboolean—

Contain keyboard focus within this subtree while it is the topmost trap.

boolean

View source

restorePreviousFocusboolean—

Restore the previously focused mounted control when this surface unmounts.

boolean

View source

autoFocusboolean—

Prefer this control when its containing focus trap takes focus.

boolean

View source

aria-modalboolean—

Expose modal semantics to assistive technology.

boolean

View source

ariaModalboolean—

Declares ariaModal (optional). Reactive JSX expressions update this property in place.

boolean

View source

dismissOnEscapeboolean—

Declares dismissOnEscape (optional). Reactive JSX expressions update this property in place.

boolean

View source

dismissOnPointerOutsideboolean—

Declares dismissOnPointerOutside (optional). Reactive JSX expressions update this property in place.

boolean

View source

tooltipstring—

Delayed, pointer-passive native tooltip text shown while this element is hovered.

string

View source

tooltipPlacementPopoverPlacement—

Declares tooltipPlacement (optional). Reactive JSX expressions update this property in place.

PopoverPlacement

View source

tooltipDelaynumber—

Hover delay in milliseconds, clamped by the Rust core to at most ten seconds.

number

View source

tooltipGapnumber—

Declares tooltipGap (optional). Reactive JSX expressions update this property in place.

number

View source

tooltipViewportMarginnumber—

Declares tooltipViewportMargin (optional). Reactive JSX expressions update this property in place.

number

View source

hitSlopnumber | string—

Declares hitSlop (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopTopnumber | string—

Declares hitSlopTop (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopRightnumber | string—

Declares hitSlopRight (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopBottomnumber | string—

Declares hitSlopBottom (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopLeftnumber | string—

Declares hitSlopLeft (optional). Reactive JSX expressions update this property in place.

number | string

View source

aria-labelstring—

Declares aria-label (optional). Reactive JSX expressions update this property in place.

string

View source

ariaLabelstring—

Declares ariaLabel (optional). Reactive JSX expressions update this property in place.

string

View source

ref((node: NativeNode) => void) | NativeNode—

Declares ref (optional). Reactive JSX expressions update this property in place.

((node: NativeNode) => void) | NativeNode

View source

onClickEventHandler—

Declares onClick (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseEnterEventHandler—

Declares onMouseEnter (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseLeaveEventHandler—

Declares onMouseLeave (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerEnterEventHandler—

Declares onPointerEnter (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerLeaveEventHandler—

Declares onPointerLeave (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerEventHandler—

Captured pointer stream from press through release/cancel, including outside the element.

EventHandler

View source

onInputEventHandler—

Declares onInput (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onChangeEventHandler—

Declares onChange (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onSubmitEventHandler—

Declares onSubmit (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDismissEventHandler—

Declares onDismiss (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onKeyDownEventHandler—

Focused key press. Declare a `tabIndex` to make an ordinary container focusable.

EventHandler

View source

onKeyUpEventHandler—

Declares onKeyUp (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseDownEventHandler—

Declares onMouseDown (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseUpEventHandler—

Declares onMouseUp (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseMoveEventHandler—

Declares onMouseMove (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDoubleClickEventHandler—

Second press of one exact native multi-click sequence.

EventHandler

View source

onWheelEventHandler—

Declares onWheel (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onContextMenuEventHandler—

Secondary-button press. Use `ContextMenu` for a declared native menu.

EventHandler

View source

onPinchEventHandler—

Declares onPinch (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onRotateEventHandler—

Declares onRotate (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onSmartMagnifyEventHandler—

Declares onSmartMagnify (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPressureEventHandler—

Declares onPressure (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onFocusEventHandler—

Declares onFocus (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onBlurEventHandler—

Declares onBlur (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

keymapKeymap—

Bounded accelerator table resolved by the core while this element is focused.

Keymap

View source

onActionEventHandler—

Typed binding id dispatched by `keymap`.

EventHandler

View source

draggableboolean | DragSource—

Declared drag payload promoted when this element starts a drag.

boolean | DragSource

View source

onDragStartEventHandler—

Declares onDragStart (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDragEndEventHandler—

Declares onDragEnd (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

dropKindsDropKind | readonly DropKind[]—

Payload kinds this element accepts, declared ahead of the native drag.

DropKind | readonly DropKind[]

View source

onDropEventHandler—

Declares onDrop (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onFilesDroppedEventHandler—

Declares onFilesDropped (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

scopestring—

Stable key shared by every part of one component instance.

string

View source

toastIdstring—

Declared identifier of the queued toast this part belongs to.

string

View source

`Toast.Close`

View source

Toast.Close(props: JSX.ToastProps): NativeNode

accessibilityLabelstring—

Declares accessibilityLabel (optional). Reactive JSX expressions update this property in place.

string

View source

childrenunknown—

Declares children (optional). Reactive JSX expressions update this property in place.

unknown

View source

styleStyleProp—

Layout, typography, paint, and interaction-state styles. Arrays merge left to right.

StyleProp

View source

disabledboolean—

Declares disabled (optional). Reactive JSX expressions update this property in place.

boolean

View source

invalidboolean—

Expose web-style invalid state; the `style.invalid` variant paints while it is set.

boolean

View source

selectedboolean—

Expose web-style selected state; the `style.selected` variant paints while it is set.

boolean

View source

groupboolean | string—

boolean | string

View source

rolestring—

Declares role (optional). Reactive JSX expressions update this property in place.

string

View source

tabIndexnumber—

Declares tabIndex (optional). Reactive JSX expressions update this property in place.

number

View source

focusOnPointerboolean—

Keep keyboard focus where it is when this element is activated with a pointer.

boolean

View source

overlayboolean—

Paint this subtree in the viewport overlay plane above embedded native views.

boolean

View source

focusTrapboolean—

Contain keyboard focus within this subtree while it is the topmost trap.

boolean

View source

restorePreviousFocusboolean—

Restore the previously focused mounted control when this surface unmounts.

boolean

View source

autoFocusboolean—

Prefer this control when its containing focus trap takes focus.

boolean

View source

aria-modalboolean—

Expose modal semantics to assistive technology.

boolean

View source

ariaModalboolean—

Declares ariaModal (optional). Reactive JSX expressions update this property in place.

boolean

View source

dismissOnEscapeboolean—

Declares dismissOnEscape (optional). Reactive JSX expressions update this property in place.

boolean

View source

dismissOnPointerOutsideboolean—

Declares dismissOnPointerOutside (optional). Reactive JSX expressions update this property in place.

boolean

View source

tooltipstring—

Delayed, pointer-passive native tooltip text shown while this element is hovered.

string

View source

tooltipPlacementPopoverPlacement—

Declares tooltipPlacement (optional). Reactive JSX expressions update this property in place.

PopoverPlacement

View source

tooltipDelaynumber—

Hover delay in milliseconds, clamped by the Rust core to at most ten seconds.

number

View source

tooltipGapnumber—

Declares tooltipGap (optional). Reactive JSX expressions update this property in place.

number

View source

tooltipViewportMarginnumber—

Declares tooltipViewportMargin (optional). Reactive JSX expressions update this property in place.

number

View source

hitSlopnumber | string—

Declares hitSlop (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopTopnumber | string—

Declares hitSlopTop (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopRightnumber | string—

Declares hitSlopRight (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopBottomnumber | string—

Declares hitSlopBottom (optional). Reactive JSX expressions update this property in place.

number | string

View source

hitSlopLeftnumber | string—

Declares hitSlopLeft (optional). Reactive JSX expressions update this property in place.

number | string

View source

aria-labelstring—

Declares aria-label (optional). Reactive JSX expressions update this property in place.

string

View source

ariaLabelstring—

Declares ariaLabel (optional). Reactive JSX expressions update this property in place.

string

View source

ref((node: NativeNode) => void) | NativeNode—

Declares ref (optional). Reactive JSX expressions update this property in place.

((node: NativeNode) => void) | NativeNode

View source

onClickEventHandler—

Declares onClick (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseEnterEventHandler—

Declares onMouseEnter (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseLeaveEventHandler—

Declares onMouseLeave (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerEnterEventHandler—

Declares onPointerEnter (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerLeaveEventHandler—

Declares onPointerLeave (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPointerEventHandler—

Captured pointer stream from press through release/cancel, including outside the element.

EventHandler

View source

onInputEventHandler—

Declares onInput (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onChangeEventHandler—

Declares onChange (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onSubmitEventHandler—

Declares onSubmit (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDismissEventHandler—

Declares onDismiss (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onKeyDownEventHandler—

Focused key press. Declare a `tabIndex` to make an ordinary container focusable.

EventHandler

View source

onKeyUpEventHandler—

Declares onKeyUp (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseDownEventHandler—

Declares onMouseDown (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseUpEventHandler—

Declares onMouseUp (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onMouseMoveEventHandler—

Declares onMouseMove (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDoubleClickEventHandler—

Second press of one exact native multi-click sequence.

EventHandler

View source

onWheelEventHandler—

Declares onWheel (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onContextMenuEventHandler—

Secondary-button press. Use `ContextMenu` for a declared native menu.

EventHandler

View source

onPinchEventHandler—

Declares onPinch (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onRotateEventHandler—

Declares onRotate (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onSmartMagnifyEventHandler—

Declares onSmartMagnify (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onPressureEventHandler—

Declares onPressure (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onFocusEventHandler—

Declares onFocus (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onBlurEventHandler—

Declares onBlur (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

keymapKeymap—

Bounded accelerator table resolved by the core while this element is focused.

Keymap

View source

onActionEventHandler—

Typed binding id dispatched by `keymap`.

EventHandler

View source

draggableboolean | DragSource—

Declared drag payload promoted when this element starts a drag.

boolean | DragSource

View source

onDragStartEventHandler—

Declares onDragStart (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onDragEndEventHandler—

Declares onDragEnd (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

dropKindsDropKind | readonly DropKind[]—

Payload kinds this element accepts, declared ahead of the native drag.

DropKind | readonly DropKind[]

View source

onDropEventHandler—

Declares onDrop (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

onFilesDroppedEventHandler—

Declares onFilesDropped (optional). Reactive JSX expressions update this property in place.

EventHandler

View source

scopestring—

Stable key shared by every part of one component instance.

string

View source

toastIdstring—

Declared identifier of the queued toast this part belongs to.

string

View source