Common Props 🚧

Props¶

These special React props are supported for all built-in components:

• children: A React node (an element, a string, a number, a portal, an empty node like null, undefined and booleans, or an array of other React nodes). Specifies the content inside the component. When you use JSX, you will usually specify the children prop implicitly by nesting tags like <div><span /></div>.

• dangerouslySetInnerHTML: An object of the form { __html: '<p>some html</p>' } with a raw HTML string inside. Overrides the innerHTML property of the DOM node and displays the passed HTML inside. This should be used with extreme caution! If the HTML inside isn't trusted (for example, if it's based on user data), you risk introducing an XSS vulnerability. Read more about using dangerouslySetInnerHTML.

• ref: A ref object from useRef or createRef, or a ref callback function, or a string for legacy refs. Your ref will be filled with the DOM element for this node. Read more about manipulating the DOM with refs.

• suppressContentEditableWarning: A boolean. If true, suppresses the warning that React shows for elements that both have children and contentEditable={true} (which normally do not work together). Use this if you're building a text input library that manages the contentEditable content manually.

• suppressHydrationWarning: A boolean. If you use server rendering, normally there is a warning when the server and the client render different content. In some rare cases (like timestamps), it is very hard or impossible to guarantee an exact match. If you set suppressHydrationWarning to true, React will not warn you about mismatches in the attributes and the content of that element. It only works one level deep, and is intended to be used as an escape hatch. Don't overuse it. Read about suppressing hydration errors.

• style: An object with CSS styles, for example { fontWeight: 'bold', margin: 20 }. Similarly to the DOM style property, the CSS property names need to be written as camelCase, for example fontWeight instead of font-weight. You can pass strings or numbers as values. If you pass a number, like width: 100, React will automatically append px ("pixels") to the value unless it's a unitless property. We recommend using style only for dynamic styles where you don't know the style values ahead of time. In other cases, applying plain CSS classes with className is more efficient. Read more about className and style.

These standard DOM props are also supported for all built-in components:

• accessKey: A string. Specifies a keyboard shortcut for the element. Not generally recommended.
• aria-*: ARIA attributes let you specify the accessibility tree information for this element. See ARIA attributes for a complete reference. In React, all ARIA attribute names are exactly the same as in HTML.
• autoCapitalize: A string. Specifies whether and how the user input should be capitalized.
• className: A string. Specifies the element's CSS class name. Read more about applying CSS styles.
• contentEditable: A boolean. If true, the browser lets the user edit the rendered element directly. This is used to implement rich text input libraries like Lexical. React warns if you try to pass React children to an element with contentEditable={true} because React will not be able to update its content after user edits.
• data-*: Data attributes let you attach some string data to the element, for example data-fruit="banana". In React, they are not commonly used because you would usually read data from props or state instead.
• dir: Either 'ltr' or 'rtl'. Specifies the text direction of the element.
• draggable: A boolean. Specifies whether the element is draggable. Part of HTML Drag and Drop API.
• enterKeyHint: A string. Specifies which action to present for the enter key on virtual keyboards.
• htmlFor: A string. For <label> and <output>, lets you associate the label with some control. Same as for HTML attribute. React uses the standard DOM property names (htmlFor) instead of HTML attribute names.
• hidden: A boolean or a string. Specifies whether the element should be hidden.
• id: A string. Specifies a unique identifier for this element, which can be used to find it later or connect it with other elements. Generate it with useId to avoid clashes between multiple instances of the same component.
• is: A string. If specified, the component will behave like a custom element.
• inputMode: A string. Specifies what kind of keyboard to display (for example, text, number or telephone).
• itemProp: A string. Specifies which property the element represents for structured data crawlers.
• lang: A string. Specifies the language of the element.
• onAnimationEnd: An AnimationEvent handler function. Fires when a CSS animation completes.
• onAnimationEndCapture: A version of onAnimationEnd that fires in the capture phase.
• onAnimationIteration: An AnimationEvent handler function. Fires when an iteration of a CSS animation ends, and another one begins.
• onAnimationIterationCapture: A version of onAnimationIteration that fires in the capture phase.
• onAnimationStart: An AnimationEvent handler function. Fires when a CSS animation starts.
• onAnimationStartCapture: onAnimationStart, but fires in the capture phase.
• onAuxClick: A MouseEvent handler function. Fires when a non-primary pointer button was clicked.
• onAuxClickCapture: A version of onAuxClick that fires in the capture phase.
• onBeforeInput: An InputEvent handler function. Fires before the value of an editable element is modified. React does not yet use the native beforeinput event, and instead attempts to polyfill it using other events.
• onBeforeInputCapture: A version of onBeforeInput that fires in the capture phase.
• onBlur: A FocusEvent handler function. Fires when an element lost focus. Unlike the built-in browser blur event, in React the onBlur event bubbles.
• onBlurCapture: A version of onBlur that fires in the capture phase.
• onClick: A MouseEvent handler function. Fires when the primary button was clicked on the pointing device.
• onClickCapture: A version of onClick that fires in the capture phase.
• onCompositionStart: A CompositionEvent handler function. Fires when an input method editor starts a new composition session.
• onCompositionStartCapture: A version of onCompositionStart that fires in the capture phase.
• onCompositionEnd: A CompositionEvent handler function. Fires when an input method editor completes or cancels a composition session.
• onCompositionEndCapture: A version of onCompositionEnd that fires in the capture phase.
• onCompositionUpdate: A CompositionEvent handler function. Fires when an input method editor receives a new character.
• onCompositionUpdateCapture: A version of onCompositionUpdate that fires in the capture phase.
• onContextMenu: A MouseEvent handler function. Fires when the user tries to open a context menu.
• onContextMenuCapture: A version of onContextMenu that fires in the capture phase.
• onCopy: A ClipboardEvent handler function. Fires when the user tries to copy something into the clipboard.
• onCopyCapture: A version of onCopy that fires in the capture phase.
• onCut: A ClipboardEvent handler function. Fires when the user tries to cut something into the clipboard.
• onCutCapture: A version of onCut that fires in the capture phase.
• onDoubleClick: A MouseEvent handler function. Fires when the user clicks twice. Corresponds to the browser dblclick event.
• onDoubleClickCapture: A version of onDoubleClick that fires in the capture phase.
• onDrag: A DragEvent handler function. Fires while the user is dragging something.
• onDragCapture: A version of onDrag that fires in the capture phase.
• onDragEnd: A DragEvent handler function. Fires when the user stops dragging something.
• onDragEndCapture: A version of onDragEnd that fires in the capture phase.
• onDragEnter: A DragEvent handler function. Fires when the dragged content enters a valid drop target.
• onDragEnterCapture: A version of onDragEnter that fires in the capture phase.
• onDragOver: A DragEvent handler function. Fires on a valid drop target while the dragged content is dragged over it. You must call e.preventDefault() here to allow dropping.
• onDragOverCapture: A version of onDragOver that fires in the capture phase.
• onDragStart: A DragEvent handler function. Fires when the user starts dragging an element.
• onDragStartCapture: A version of onDragStart that fires in the capture phase.
• onDrop: A DragEvent handler function. Fires when something is dropped on a valid drop target.
• onDropCapture: A version of onDrop that fires in the capture phase.
• onFocus: A FocusEvent handler function. Fires when an element lost focus. Unlike the built-in browser focus event, in React the onFocus event bubbles.
• onFocusCapture: A version of onFocus that fires in the capture phase.
• onGotPointerCapture: A PointerEvent handler function. Fires when an element programmatically captures a pointer.
• onGotPointerCaptureCapture: A version of onGotPointerCapture that fires in the capture phase.
• onKeyDown: A KeyboardEvent handler function. Fires when a key is pressed.
• onKeyDownCapture: A version of onKeyDown that fires in the capture phase.
• onKeyPress: A KeyboardEvent handler function. Deprecated. Use onKeyDown or onBeforeInput instead.
• onKeyPressCapture: A version of onKeyPress that fires in the capture phase.
• onKeyUp: A KeyboardEvent handler function. Fires when a key is released.
• onKeyUpCapture: A version of onKeyUp that fires in the capture phase.
• onLostPointerCapture: A PointerEvent handler function. Fires when an element stops capturing a pointer.
• onLostPointerCaptureCapture: A version of onLostPointerCapture that fires in the capture phase.
• onMouseDown: A MouseEvent handler function. Fires when the pointer is pressed down.
• onMouseDownCapture: A version of onMouseDown that fires in the capture phase.
• onMouseEnter: A MouseEvent handler function. Fires when the pointer moves inside an element. Does not have a capture phase. Instead, onMouseLeave and onMouseEnter propagate from the element being left to the one being entered.
• onMouseLeave: A MouseEvent handler function. Fires when the pointer moves outside an element. Does not have a capture phase. Instead, onMouseLeave and onMouseEnter propagate from the element being left to the one being entered.
• onMouseMove: A MouseEvent handler function. Fires when the pointer changes coordinates.
• onMouseMoveCapture: A version of onMouseMove that fires in the capture phase.
• onMouseOut: A MouseEvent handler function. Fires when the pointer moves outside an element, or if it moves into a child element.
• onMouseOutCapture: A version of onMouseOut that fires in the capture phase.
• onMouseUp: A MouseEvent handler function. Fires when the pointer is released.
• onMouseUpCapture: A version of onMouseUp that fires in the capture phase.
• onPointerCancel: A PointerEvent handler function. Fires when the browser cancels a pointer interaction.
• onPointerCancelCapture: A version of onPointerCancel that fires in the capture phase.
• onPointerDown: A PointerEvent handler function. Fires when a pointer becomes active.
• onPointerDownCapture: A version of onPointerDown that fires in the capture phase.
• onPointerEnter: A PointerEvent handler function. Fires when a pointer moves inside an element. Does not have a capture phase. Instead, onPointerLeave and onPointerEnter propagate from the element being left to the one being entered.
• onPointerLeave: A PointerEvent handler function. Fires when a pointer moves outside an element. Does not have a capture phase. Instead, onPointerLeave and onPointerEnter propagate from the element being left to the one being entered.
• onPointerMove: A PointerEvent handler function. Fires when a pointer changes coordinates.
• onPointerMoveCapture: A version of onPointerMove that fires in the capture phase.
• onPointerOut: A PointerEvent handler function. Fires when a pointer moves outside an element, if the pointer interaction is cancelled, and a few other reasons.
• onPointerOutCapture: A version of onPointerOut that fires in the capture phase.
• onPointerUp: A PointerEvent handler function. Fires when a pointer is no longer active.
• onPointerUpCapture: A version of onPointerUp that fires in the capture phase.
• onPaste: A ClipboardEvent handler function. Fires when the user tries to paste something from the clipboard.
• onPasteCapture: A version of onPaste that fires in the capture phase.
• onScroll: An Event handler function. Fires when an element has been scrolled. This event does not bubble.
• onScrollCapture: A version of onScroll that fires in the capture phase.
• onSelect: An Event handler function. Fires after the selection inside an editable element like an input changes. React extends the onSelect event to work for contentEditable={true} elements as well. In addition, React extends it to fire for empty selection and on edits (which may affect the selection).
• onSelectCapture: A version of onSelect that fires in the capture phase.
• onTouchCancel: A TouchEvent handler function. Fires when the browser cancels a touch interaction.
• onTouchCancelCapture: A version of onTouchCancel that fires in the capture phase.
• onTouchEnd: A TouchEvent handler function. Fires when one or more touch points are removed.
• onTouchEndCapture: A version of onTouchEnd that fires in the capture phase.
• onTouchMove: A TouchEvent handler function. Fires one or more touch points are moved.
• onTouchMoveCapture: A version of onTouchMove that fires in the capture phase.
• onTouchStart: A TouchEvent handler function. Fires when one or more touch points are placed.
• onTouchStartCapture: A version of onTouchStart that fires in the capture phase.
• onTransitionEnd: A TransitionEvent handler function. Fires when a CSS transition completes.
• onTransitionEndCapture: A version of onTransitionEnd that fires in the capture phase.
• onWheel: A WheelEvent handler function. Fires when the user rotates a wheel button.
• onWheelCapture: A version of onWheel that fires in the capture phase.
• role: A string. Specifies the element role explicitly for assistive technologies. nt.
• slot: A string. Specifies the slot name when using shadow DOM. In React, an equivalent pattern is typically achieved by passing JSX as props, for example <Layout left={<Sidebar />} right={<Content />} />.
• spellCheck: A boolean or null. If explicitly set to true or false, enables or disables spellchecking.
• tabIndex: A number. Overrides the default Tab button behavior. Avoid using values other than -1 and 0.
• title: A string. Specifies the tooltip text for the element.
• translate: Either 'yes' or 'no'. Passing 'no' excludes the element content from being translated.

You can also pass custom attributes as props, for example mycustomprop="someValue". This can be useful when integrating with third-party libraries. The custom attribute name must be lowercase and must not start with on. The value will be converted to a string. If you pass null or undefined, the custom attribute will be removed.

These events fire only for the <form> elements:

• onReset: An Event handler function. Fires when a form gets reset.
• onResetCapture: A version of onReset that fires in the capture phase.
• onSubmit: An Event handler function. Fires when a form gets submitted.
• onSubmitCapture: A version of onSubmit that fires in the capture phase.

These events fire only for the <dialog> elements. Unlike browser events, they bubble in React:

• onCancel: An Event handler function. Fires when the user tries to dismiss the dialog.
• onCancelCapture: A version of onCancel that fires in the capture phase. capture-phase-events)
• onClose: An Event handler function. Fires when a dialog has been closed.
• onCloseCapture: A version of onClose that fires in the capture phase.

These events fire only for the <details> elements. Unlike browser events, they bubble in React:

• onToggle: An Event handler function. Fires when the user toggles the details.
• onToggleCapture: A version of onToggle that fires in the capture phase. capture-phase-events)

These events fire for <img>, <iframe>, <object>, <embed>, <link>, and SVG <image> elements. Unlike browser events, they bubble in React:

• onLoad: An Event handler function. Fires when the resource has loaded.
• onLoadCapture: A version of onLoad that fires in the capture phase.
• onError: An Event handler function. Fires when the resource could not be loaded.
• onErrorCapture: A version of onError that fires in the capture phase.

These events fire for resources like <audio> and <video>. Unlike browser events, they bubble in React:

• onAbort: An Event handler function. Fires when the resource has not fully loaded, but not due to an error.
• onAbortCapture: A version of onAbort that fires in the capture phase.
• onCanPlay: An Event handler function. Fires when there's enough data to start playing, but not enough to play to the end without buffering.
• onCanPlayCapture: A version of onCanPlay that fires in the capture phase.
• onCanPlayThrough: An Event handler function. Fires when there's enough data that it's likely possible to start playing without buffering until the end.
• onCanPlayThroughCapture: A version of onCanPlayThrough that fires in the capture phase.
• onDurationChange: An Event handler function. Fires when the media duration has updated.
• onDurationChangeCapture: A version of onDurationChange that fires in the capture phase.
• onEmptied: An Event handler function. Fires when the media has become empty.
• onEmptiedCapture: A version of onEmptied that fires in the capture phase.
• onEncrypted: An Event handler function. Fires when the browser encounters encrypted media.
• onEncryptedCapture: A version of onEncrypted that fires in the capture phase.
• onEnded: An Event handler function. Fires when the playback stops because there's nothing left to play.
• onEndedCapture: A version of onEnded that fires in the capture phase.
• onError: An Event handler function. Fires when the resource could not be loaded.
• onErrorCapture: A version of onError that fires in the capture phase.
• onLoadedData: An Event handler function. Fires when the current playback frame has loaded.
• onLoadedDataCapture: A version of onLoadedData that fires in the capture phase.
• onLoadedMetadata: An Event handler function. Fires when metadata has loaded.
• onLoadedMetadataCapture: A version of onLoadedMetadata that fires in the capture phase.
• onLoadStart: An Event handler function. Fires when the browser started loading the resource.
• onLoadStartCapture: A version of onLoadStart that fires in the capture phase.
• onPause: An Event handler function. Fires when the media was paused.
• onPauseCapture: A version of onPause that fires in the capture phase.
• onPlay: An Event handler function. Fires when the media is no longer paused.
• onPlayCapture: A version of onPlay that fires in the capture phase.
• onPlaying: An Event handler function. Fires when the media starts or restarts playing.
• onPlayingCapture: A version of onPlaying that fires in the capture phase.
• onProgress: An Event handler function. Fires periodically while the resource is loading.
• onProgressCapture: A version of onProgress that fires in the capture phase.
• onRateChange: An Event handler function. Fires when playback rate changes.
• onRateChangeCapture: A version of onRateChange that fires in the capture phase.
• onResize: An Event handler function. Fires when video changes size.
• onResizeCapture: A version of onResize that fires in the capture phase.
• onSeeked: An Event handler function. Fires when a seek operation completes.
• onSeekedCapture: A version of onSeeked that fires in the capture phase.
• onSeeking: An Event handler function. Fires when a seek operation starts.
• onSeekingCapture: A version of onSeeking that fires in the capture phase.
• onStalled: An Event handler function. Fires when the browser is waiting for data but it keeps not loading.
• onStalledCapture: A version of onStalled that fires in the capture phase.
• onSuspend: An Event handler function. Fires when loading the resource was suspended.
• onSuspendCapture: A version of onSuspend that fires in the capture phase.
• onTimeUpdate: An Event handler function. Fires when the current playback time updates.
• onTimeUpdateCapture: A version of onTimeUpdate that fires in the capture phase.
• onVolumeChange: An Event handler function. Fires when the volume has changed.
• onVolumeChangeCapture: A version of onVolumeChange that fires in the capture phase.
• onWaiting: An Event handler function. Fires when the playback stopped due to temporary lack of data.
• onWaitingCapture: A version of onWaiting that fires in the capture phase.

Caveats¶

• You cannot pass both children and dangerouslySetInnerHTML at the same time.
• Some events (like onAbort and onLoad) don't bubble in the browser, but bubble in React.