Pull to refresh
Material pull-to-refresh behavior with application-owned refresh lifecycle, top-edge gesture arbitration, and accessible status feedback.
Pull to refresh requests new data when users drag downward from the top edge of scrollable content. The component owns Material gesture progress and indicator presentation; the application owns the refresh operation and decides when it is complete.
import { PullToRefresh } from '@m3-ui/ui';
const [isRefreshing, setRefreshing] = useState(false);
<PullToRefresh
isRefreshing={isRefreshing}
onRefresh={() => {
setRefreshing(true);
refreshData();
}}
>
<Feed />
</PullToRefresh>When to use
Use pull to refresh when the surrounding product already uses a scrollable refresh pattern and a top-edge drag is discoverable in context. Always keep another reasonable refresh path where product/accessibility requirements call for one; a gesture should not become the only possible data-reload mechanism.
Refresh lifecycle is application-owned
onRefresh is a request callback, not a hidden promise/network contract. Keep isRefreshing true while application work is active, then set it false when that work finishes or fails.
The component does not fetch data, choose retry policy, cancel requests, or infer completion from a timeout.
Gesture arbitration
A downward pointer gesture is claimed only when the pull-to-refresh root and the originating nested scrollable are already at their top edge. Vertical scrolling therefore remains with nested/page content until the Material refresh gesture is actually eligible.
Crossing the threshold arms the request; releasing while armed calls onRefresh once. Releasing early returns to idle. enabled={false} disables the gesture without disabling the wrapped content.
Indicator customization
The default indicator communicates pull/refresh presentation and exposes polite refresh status. A custom indicator receives the logical lifecycle/progress state but must not take ownership of the refresh operation itself.
Accessibility
Do not require users to discover a pointer-only gesture to understand or operate critical refresh behavior. Keep the refreshing status stable enough to be announced meaningfully and avoid repeatedly toggling status during one request.
Wrapped controls retain their own semantics; the refresh wrapper should not turn the entire scroll surface into a button.
API reference
PullToRefresh
Material 3 pull-to-refresh adapted to Pointer Events and a web scroll container. The component only claims a downward gesture at the container's top boundary.
PullToRefresh({ isRefreshing, onRefresh, enabled, threshold: thresholdProp, indicator, children, className, onPointerDown, onPointerMove, onPointerUp, onPointerCancel, onScroll, ...props }: PullToRefreshProps): JSX.ElementProps
| Name | Type | Default | Description | Origin |
|---|---|---|---|---|
children* | ReactNode | — | Scrollable content rendered inside the pull-to-refresh container. | @m3-ui/ui |
enabled | boolean | undefined | true | — | @m3-ui/ui |
indicator | ReactNode | ((state: PullToRefreshIndicatorState) => ReactNode) | — | Custom indicator slot. A render function receives stable pull progress/state. | @m3-ui/ui |
isRefreshing* | boolean | — | — | @m3-ui/ui |
onRefresh* | () => void | — | — | @m3-ui/ui |
threshold | number | undefined | — | Refresh threshold in CSS pixels. Defaults to AndroidX's 80dp positional threshold projected to 80px. | @m3-ui/ui |
Inherited React / web props (277)
| Name | Type | Default | Description | Origin |
|---|---|---|---|---|
about | string | undefined | — | — | @types/react |
accessKey | string | undefined | — | — | @types/react |
aria-activedescendant | string | undefined | — | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | @types/react |
aria-atomic | Booleanish | undefined | — | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | @types/react |
aria-autocomplete | "none" | "list" | "inline" | "both" | undefined | — | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | @types/react |
aria-braillelabel | string | undefined | — | Defines a string value that labels the current element, which is intended to be converted into Braille. | @types/react |
aria-brailleroledescription | string | undefined | — | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. | @types/react |
aria-busy | Booleanish | undefined | — | — | @types/react |
aria-checked | boolean | "true" | "false" | "mixed" | undefined | — | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. | @types/react |
aria-colcount | number | undefined | — | Defines the total number of columns in a table, grid, or treegrid. | @types/react |
aria-colindex | number | undefined | — | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. | @types/react |
aria-colindextext | string | undefined | — | Defines a human readable text alternative of aria-colindex. | @types/react |
aria-colspan | number | undefined | — | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. | @types/react |
aria-controls | string | undefined | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. | @types/react |
aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | undefined | — | Indicates the element that represents the current item within a container or set of related elements. | @types/react |
aria-describedby | string | undefined | — | Identifies the element (or elements) that describes the object. | @types/react |
aria-description | string | undefined | — | Defines a string value that describes or annotates the current element. | @types/react |
aria-details | string | undefined | — | Identifies the element that provides a detailed, extended description for the object. | @types/react |
aria-disabled | Booleanish | undefined | — | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. | @types/react |
aria-dropeffect | "none" | "link" | "copy" | "execute" | "move" | "popup" | undefined | — | Indicates what functions can be performed when a dragged object is released on the drop target. | @types/react |
aria-errormessage | string | undefined | — | Identifies the element that provides an error message for the object. | @types/react |
aria-expanded | Booleanish | undefined | — | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | @types/react |
aria-flowto | string | undefined | — | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | @types/react |
aria-grabbed | Booleanish | undefined | — | Indicates an element's "grabbed" state in a drag-and-drop operation. | @types/react |
aria-haspopup | boolean | "true" | "false" | "dialog" | "grid" | "listbox" | "menu" | "tree" | undefined | — | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | @types/react |
aria-hidden | Booleanish | undefined | — | Indicates whether the element is exposed to an accessibility API. | @types/react |
aria-invalid | boolean | "true" | "false" | "grammar" | "spelling" | undefined | — | Indicates the entered value does not conform to the format expected by the application. | @types/react |
aria-keyshortcuts | string | undefined | — | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | @types/react |
aria-label | string | undefined | — | Defines a string value that labels the current element. | @types/react |
aria-labelledby | string | undefined | — | Identifies the element (or elements) that labels the current element. | @types/react |
aria-level | number | undefined | — | Defines the hierarchical level of an element within a structure. | @types/react |
aria-live | "off" | "assertive" | "polite" | undefined | — | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | @types/react |
aria-modal | Booleanish | undefined | — | Indicates whether an element is modal when displayed. | @types/react |
aria-multiline | Booleanish | undefined | — | Indicates whether a text box accepts multiple lines of input or only a single line. | @types/react |
aria-multiselectable | Booleanish | undefined | — | Indicates that the user may select more than one item from the current selectable descendants. | @types/react |
aria-orientation | "horizontal" | "vertical" | undefined | — | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | @types/react |
aria-owns | string | undefined | — | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. | @types/react |
aria-placeholder | string | undefined | — | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | @types/react |
aria-posinset | number | undefined | — | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | @types/react |
aria-pressed | boolean | "true" | "false" | "mixed" | undefined | — | Indicates the current "pressed" state of toggle buttons. | @types/react |
aria-readonly | Booleanish | undefined | — | Indicates that the element is not editable, but is otherwise operable. | @types/react |
aria-relevant | "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals" | undefined | — | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. | @types/react |
aria-required | Booleanish | undefined | — | Indicates that user input is required on the element before a form may be submitted. | @types/react |
aria-roledescription | string | undefined | — | Defines a human-readable, author-localized description for the role of an element. | @types/react |
aria-rowcount | number | undefined | — | Defines the total number of rows in a table, grid, or treegrid. | @types/react |
aria-rowindex | number | undefined | — | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. | @types/react |
aria-rowindextext | string | undefined | — | Defines a human readable text alternative of aria-rowindex. | @types/react |
aria-rowspan | number | undefined | — | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. | @types/react |
aria-selected | Booleanish | undefined | — | Indicates the current "selected" state of various widgets. | @types/react |
aria-setsize | number | undefined | — | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | @types/react |
aria-sort | "none" | "ascending" | "descending" | "other" | undefined | — | Indicates if items in a table or grid are sorted in ascending or descending order. | @types/react |
aria-valuemax | number | undefined | — | Defines the maximum allowed value for a range widget. | @types/react |
aria-valuemin | number | undefined | — | Defines the minimum allowed value for a range widget. | @types/react |
aria-valuenow | number | undefined | — | Defines the current value for a range widget. | @types/react |
aria-valuetext | string | undefined | — | Defines the human readable text alternative of aria-valuenow for a range widget. | @types/react |
autoCapitalize | (string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters" | undefined | — | — | @types/react |
autoCorrect | string | undefined | — | — | @types/react |
autoFocus | boolean | undefined | — | — | @types/react |
autoSave | string | undefined | — | — | @types/react |
className | string | undefined | — | — | @types/react |
color | string | undefined | — | — | @types/react |
content | string | undefined | — | — | @types/react |
contentEditable | "inherit" | Booleanish | "plaintext-only" | undefined | — | — | @types/react |
contextMenu | string | undefined | — | — | @types/react |
dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | undefined | — | — | @types/react |
datatype | string | undefined | — | — | @types/react |
defaultChecked | boolean | undefined | — | — | @types/react |
defaultValue | string | number | readonly string[] | undefined | — | — | @types/react |
dir | string | undefined | — | — | @types/react |
draggable | Booleanish | undefined | — | — | @types/react |
enterKeyHint | "enter" | "done" | "go" | "next" | "previous" | "search" | "send" | undefined | — | — | @types/react |
exportparts | string | undefined | — | — | @types/react |
hidden | boolean | undefined | — | — | @types/react |
id | string | undefined | — | — | @types/react |
inert | boolean | undefined | — | — | @types/react |
inlist | any | — | — | @types/react |
inputMode | "none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | undefined | — | Hints at the type of data that might be entered by the user while editing the element or its contents | @types/react |
is | string | undefined | — | Specify that a standard HTML element should behave like a defined custom built-in element | @types/react |
itemID | string | undefined | — | — | @types/react |
itemProp | string | undefined | — | — | @types/react |
itemRef | string | undefined | — | — | @types/react |
itemScope | boolean | undefined | — | — | @types/react |
itemType | string | undefined | — | — | @types/react |
lang | string | undefined | — | — | @types/react |
nonce | string | undefined | — | — | @types/react |
onAbort | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onAbortCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onAuxClick | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onBeforeInput | InputEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onBeforeInputCapture | InputEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onBeforeToggle | ToggleEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onBlur | FocusEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onBlurCapture | FocusEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onCanPlay | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onCanPlayCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onCanPlayThrough | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onCanPlayThroughCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onChange | ChangeEventHandler<HTMLDivElement, Element> | undefined | — | — | @types/react |
onChangeCapture | ChangeEventHandler<HTMLDivElement, Element> | undefined | — | — | @types/react |
onClick | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onClickCapture | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onCompositionEnd | CompositionEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onCompositionEndCapture | CompositionEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onCompositionStart | CompositionEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onCompositionStartCapture | CompositionEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onCompositionUpdate | CompositionEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onCompositionUpdateCapture | CompositionEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onContextMenu | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onCopy | ClipboardEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onCopyCapture | ClipboardEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onCut | ClipboardEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onCutCapture | ClipboardEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDoubleClick | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDrag | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDragCapture | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDragEnd | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDragEndCapture | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDragEnter | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDragEnterCapture | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDragExit | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDragExitCapture | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDragLeave | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDragLeaveCapture | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDragOver | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDragOverCapture | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDragStart | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDragStartCapture | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDrop | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDropCapture | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDurationChange | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDurationChangeCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onEmptied | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onEmptiedCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onEncrypted | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onEncryptedCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onEnded | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onEndedCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onError | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onErrorCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onFocus | FocusEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onFocusCapture | FocusEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onInput | InputEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onInputCapture | InputEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onInvalid | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onInvalidCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onKeyDown | KeyboardEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onKeyDownCapture | KeyboardEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onKeyPress | KeyboardEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onKeyPressCapture | KeyboardEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onKeyUp | KeyboardEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onKeyUpCapture | KeyboardEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onLoad | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onLoadCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onLoadedData | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onLoadedDataCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onLoadedMetadata | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onLoadedMetadataCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onLoadStart | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onLoadStartCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onMouseDown | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onMouseEnter | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onMouseLeave | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onMouseMove | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onMouseOut | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onMouseOver | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onMouseUp | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPaste | ClipboardEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPasteCapture | ClipboardEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPause | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPauseCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPlay | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPlayCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPlaying | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPlayingCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPointerCancel | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPointerDown | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPointerEnter | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPointerLeave | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPointerMove | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPointerOut | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPointerOver | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPointerUp | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onProgress | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onProgressCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onRateChange | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onRateChangeCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onReset | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onResetCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onScroll | UIEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onScrollCapture | UIEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onScrollEnd | UIEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onScrollEndCapture | UIEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onSeeked | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onSeekedCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onSeeking | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onSeekingCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onSelect | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onSelectCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onStalled | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onStalledCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onSubmit | SubmitEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onSubmitCapture | SubmitEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onSuspend | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onSuspendCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTimeUpdate | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTimeUpdateCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onToggle | ToggleEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTouchCancel | TouchEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTouchEnd | TouchEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTouchMove | TouchEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTouchStart | TouchEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onVolumeChange | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onVolumeChangeCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onWaiting | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onWaitingCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onWheel | WheelEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onWheelCapture | WheelEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
part | string | undefined | — | — | @types/react |
popover | "" | "auto" | "manual" | "hint" | undefined | — | — | @types/react |
popoverTarget | string | undefined | — | — | @types/react |
popoverTargetAction | "toggle" | "show" | "hide" | undefined | — | — | @types/react |
prefix | string | undefined | — | — | @types/react |
property | string | undefined | — | — | @types/react |
radioGroup | string | undefined | — | — | @types/react |
rel | string | undefined | — | — | @types/react |
resource | string | undefined | — | — | @types/react |
results | number | undefined | — | — | @types/react |
rev | string | undefined | — | — | @types/react |
role | AriaRole | undefined | — | — | @types/react |
security | string | undefined | — | — | @types/react |
slot | string | undefined | — | — | @types/react |
spellCheck | Booleanish | undefined | — | — | @types/react |
style | CSSProperties | undefined | — | — | @types/react |
suppressContentEditableWarning | boolean | undefined | — | — | @types/react |
suppressHydrationWarning | boolean | undefined | — | — | @types/react |
tabIndex | number | undefined | — | — | @types/react |
title | string | undefined | — | — | @types/react |
translate | "yes" | "no" | undefined | — | — | @types/react |
typeof | string | undefined | — | — | @types/react |
unselectable | "off" | "on" | undefined | — | — | @types/react |
vocab | string | undefined | — | — | @types/react |
Source: packages/ui/src/components/PullToRefresh/PullToRefresh.tsx:137
Material fidelity and web adaptation
- Family
- Pull to refresh
- Provenance
- compose: Compose Material3 contract · web: Browser and React Aria semantics · adaptation: m3-ui web adaptation
- Compose mapping
- PullToRefreshBox · PullToRefreshState · PullToRefreshDefaults.Indicator
- Visual fidelity
- partial: Legacy visual fidelity has not received an explicit reviewed disposition. Current implementation evidence: Implements Material pull progress, armed/refreshing lifecycle, thresholded release, app-controlled refreshing state, a customizable indicator render contract, and top-edge arbitration across nested scrollable content.
- Behavior fidelity
- adapted: Pointer input and DOM scroll inspection replace Compose nested-scroll plumbing. The component claims a downward gesture only when the relevant scroll roots are at their top edge, invokes onRefresh once after an armed release, and exposes the default refreshing indicator through a polite status region while the application remains the owner of refresh completion.
- Semantics fidelity
- adapted: Pointer input and DOM scroll inspection replace Compose nested-scroll plumbing. The component claims a downward gesture only when the relevant scroll roots are at their top edge, invokes onRefresh once after an armed release, and exposes the default refreshing indicator through a polite status region while the application remains the owner of refresh completion.
- Adaptations
- Pointer input and DOM scroll inspection replace Compose nested-scroll plumbing. The component claims a downward gesture only when the relevant scroll roots are at their top edge, invokes onRefresh once after an armed release, and exposes the default refreshing indicator through a polite status region while the application remains the owner of refresh completion.
The interaction follows the audited Compose Material3 PullToRefresh contract: external refreshing state, a threshold request, and indicator progress. Browser pointer/nested-scroll inspection replaces Compose nested-scroll internals while application data lifecycle remains external.
Related components
- Loading indicator — standalone loading/progress presentation.
- Snackbar — transient result/error feedback after refresh.