@wordpress/components
Version:
UI components for WordPress.
268 lines • 20.7 kB
TypeScript
/// <reference types="react" />
/**
* Internal dependencies
*/
import { WordPressComponentProps } from '../../ui/context';
import type { ItemProps } from '../types';
export declare function useItem(props: WordPressComponentProps<ItemProps, 'div'>): {
children: import("react").ReactNode;
defaultValue?: string | number | readonly string[] | undefined;
onChange?: import("react").FormEventHandler<HTMLDivElement> | undefined;
color?: string | undefined;
translate?: "no" | "yes" | undefined;
hidden?: boolean | undefined;
style?: import("react").CSSProperties | undefined;
key?: import("react").Key | null | undefined;
slot?: string | undefined;
title?: string | undefined;
id?: string | undefined;
defaultChecked?: boolean | undefined;
suppressContentEditableWarning?: boolean | undefined;
suppressHydrationWarning?: boolean | undefined;
accessKey?: string | undefined;
contentEditable?: "inherit" | (boolean | "false" | "true") | undefined;
contextMenu?: string | undefined;
dir?: string | undefined;
draggable?: (boolean | "false" | "true") | undefined;
lang?: string | undefined;
placeholder?: string | undefined;
spellCheck?: (boolean | "false" | "true") | undefined;
tabIndex?: number | undefined;
radioGroup?: string | undefined;
about?: string | undefined;
datatype?: string | undefined;
inlist?: any;
prefix?: string | undefined;
property?: string | undefined;
resource?: string | undefined;
typeof?: string | undefined;
vocab?: string | undefined;
autoCapitalize?: string | undefined;
autoCorrect?: string | undefined;
autoSave?: string | undefined;
itemProp?: string | undefined;
itemScope?: boolean | undefined;
itemType?: string | undefined;
itemID?: string | undefined;
itemRef?: string | undefined;
results?: number | undefined;
security?: string | undefined;
unselectable?: "on" | "off" | undefined;
inputMode?: "none" | "text" | "search" | "email" | "tel" | "url" | "numeric" | "decimal" | undefined;
is?: string | undefined;
'aria-activedescendant'?: string | undefined;
'aria-atomic'?: (boolean | "false" | "true") | undefined;
'aria-autocomplete'?: "both" | "none" | "inline" | "list" | undefined;
'aria-busy'?: (boolean | "false" | "true") | undefined;
'aria-checked'?: boolean | "mixed" | "false" | "true" | undefined;
'aria-colcount'?: number | undefined;
'aria-colindex'?: number | undefined;
'aria-colspan'?: number | undefined;
'aria-controls'?: string | undefined;
'aria-current'?: boolean | "page" | "false" | "true" | "time" | "location" | "step" | "date" | undefined;
'aria-describedby'?: string | undefined;
'aria-details'?: string | undefined;
'aria-disabled'?: (boolean | "false" | "true") | undefined;
'aria-dropeffect'?: "none" | "copy" | "move" | "link" | "execute" | "popup" | undefined;
'aria-errormessage'?: string | undefined;
'aria-expanded'?: (boolean | "false" | "true") | undefined;
'aria-flowto'?: string | undefined;
'aria-grabbed'?: (boolean | "false" | "true") | undefined;
'aria-haspopup'?: boolean | "grid" | "listbox" | "menu" | "false" | "true" | "dialog" | "tree" | undefined;
'aria-hidden'?: (boolean | "false" | "true") | undefined;
'aria-invalid'?: boolean | "false" | "true" | "grammar" | "spelling" | undefined;
'aria-keyshortcuts'?: string | undefined;
'aria-label'?: string | undefined;
'aria-labelledby'?: string | undefined;
'aria-level'?: number | undefined;
'aria-live'?: "off" | "assertive" | "polite" | undefined;
'aria-modal'?: (boolean | "false" | "true") | undefined;
'aria-multiline'?: (boolean | "false" | "true") | undefined;
'aria-multiselectable'?: (boolean | "false" | "true") | undefined;
'aria-orientation'?: "horizontal" | "vertical" | undefined;
'aria-owns'?: string | undefined;
'aria-placeholder'?: string | undefined;
'aria-posinset'?: number | undefined;
'aria-pressed'?: boolean | "mixed" | "false" | "true" | undefined;
'aria-readonly'?: (boolean | "false" | "true") | undefined;
'aria-relevant'?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals" | undefined;
'aria-required'?: (boolean | "false" | "true") | undefined;
'aria-roledescription'?: string | undefined;
'aria-rowcount'?: number | undefined;
'aria-rowindex'?: number | undefined;
'aria-rowspan'?: number | undefined;
'aria-selected'?: (boolean | "false" | "true") | undefined;
'aria-setsize'?: number | undefined;
'aria-sort'?: "none" | "ascending" | "descending" | "other" | undefined;
'aria-valuemax'?: number | undefined;
'aria-valuemin'?: number | undefined;
'aria-valuenow'?: number | undefined;
'aria-valuetext'?: string | undefined;
dangerouslySetInnerHTML?: {
__html: string;
} | undefined;
onCopy?: import("react").ClipboardEventHandler<HTMLDivElement> | undefined;
onCopyCapture?: import("react").ClipboardEventHandler<HTMLDivElement> | undefined;
onCut?: import("react").ClipboardEventHandler<HTMLDivElement> | undefined;
onCutCapture?: import("react").ClipboardEventHandler<HTMLDivElement> | undefined;
onPaste?: import("react").ClipboardEventHandler<HTMLDivElement> | undefined;
onPasteCapture?: import("react").ClipboardEventHandler<HTMLDivElement> | undefined;
onCompositionEnd?: import("react").CompositionEventHandler<HTMLDivElement> | undefined;
onCompositionEndCapture?: import("react").CompositionEventHandler<HTMLDivElement> | undefined;
onCompositionStart?: import("react").CompositionEventHandler<HTMLDivElement> | undefined;
onCompositionStartCapture?: import("react").CompositionEventHandler<HTMLDivElement> | undefined;
onCompositionUpdate?: import("react").CompositionEventHandler<HTMLDivElement> | undefined;
onCompositionUpdateCapture?: import("react").CompositionEventHandler<HTMLDivElement> | undefined;
onFocus?: import("react").FocusEventHandler<HTMLDivElement> | undefined;
onFocusCapture?: import("react").FocusEventHandler<HTMLDivElement> | undefined;
onBlur?: import("react").FocusEventHandler<HTMLDivElement> | undefined;
onBlurCapture?: import("react").FocusEventHandler<HTMLDivElement> | undefined;
onChangeCapture?: import("react").FormEventHandler<HTMLDivElement> | undefined;
onBeforeInput?: import("react").FormEventHandler<HTMLDivElement> | undefined;
onBeforeInputCapture?: import("react").FormEventHandler<HTMLDivElement> | undefined;
onInput?: import("react").FormEventHandler<HTMLDivElement> | undefined;
onInputCapture?: import("react").FormEventHandler<HTMLDivElement> | undefined;
onReset?: import("react").FormEventHandler<HTMLDivElement> | undefined;
onResetCapture?: import("react").FormEventHandler<HTMLDivElement> | undefined;
onSubmit?: import("react").FormEventHandler<HTMLDivElement> | undefined;
onSubmitCapture?: import("react").FormEventHandler<HTMLDivElement> | undefined;
onInvalid?: import("react").FormEventHandler<HTMLDivElement> | undefined;
onInvalidCapture?: import("react").FormEventHandler<HTMLDivElement> | undefined;
onLoad?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onLoadCapture?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onError?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onErrorCapture?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onKeyDown?: import("react").KeyboardEventHandler<HTMLDivElement> | undefined;
onKeyDownCapture?: import("react").KeyboardEventHandler<HTMLDivElement> | undefined;
onKeyPress?: import("react").KeyboardEventHandler<HTMLDivElement> | undefined;
onKeyPressCapture?: import("react").KeyboardEventHandler<HTMLDivElement> | undefined;
onKeyUp?: import("react").KeyboardEventHandler<HTMLDivElement> | undefined;
onKeyUpCapture?: import("react").KeyboardEventHandler<HTMLDivElement> | undefined;
onAbort?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onAbortCapture?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onCanPlay?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onCanPlayCapture?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onCanPlayThrough?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onCanPlayThroughCapture?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onDurationChange?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onDurationChangeCapture?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onEmptied?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onEmptiedCapture?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onEncrypted?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onEncryptedCapture?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onEnded?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onEndedCapture?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onLoadedData?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onLoadedDataCapture?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onLoadedMetadata?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onLoadedMetadataCapture?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onLoadStart?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onLoadStartCapture?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onPause?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onPauseCapture?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onPlay?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onPlayCapture?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onPlaying?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onPlayingCapture?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onProgress?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onProgressCapture?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onRateChange?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onRateChangeCapture?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onSeeked?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onSeekedCapture?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onSeeking?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onSeekingCapture?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onStalled?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onStalledCapture?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onSuspend?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onSuspendCapture?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onTimeUpdate?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onTimeUpdateCapture?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onVolumeChange?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onVolumeChangeCapture?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onWaiting?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onWaitingCapture?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onAuxClick?: import("react").MouseEventHandler<HTMLDivElement> | undefined;
onAuxClickCapture?: import("react").MouseEventHandler<HTMLDivElement> | undefined;
onClickCapture?: import("react").MouseEventHandler<HTMLDivElement> | undefined;
onContextMenu?: import("react").MouseEventHandler<HTMLDivElement> | undefined;
onContextMenuCapture?: import("react").MouseEventHandler<HTMLDivElement> | undefined;
onDoubleClick?: import("react").MouseEventHandler<HTMLDivElement> | undefined;
onDoubleClickCapture?: import("react").MouseEventHandler<HTMLDivElement> | undefined;
onDrag?: import("react").DragEventHandler<HTMLDivElement> | undefined;
onDragCapture?: import("react").DragEventHandler<HTMLDivElement> | undefined;
onDragEnd?: import("react").DragEventHandler<HTMLDivElement> | undefined;
onDragEndCapture?: import("react").DragEventHandler<HTMLDivElement> | undefined;
onDragEnter?: import("react").DragEventHandler<HTMLDivElement> | undefined;
onDragEnterCapture?: import("react").DragEventHandler<HTMLDivElement> | undefined;
onDragExit?: import("react").DragEventHandler<HTMLDivElement> | undefined;
onDragExitCapture?: import("react").DragEventHandler<HTMLDivElement> | undefined;
onDragLeave?: import("react").DragEventHandler<HTMLDivElement> | undefined;
onDragLeaveCapture?: import("react").DragEventHandler<HTMLDivElement> | undefined;
onDragOver?: import("react").DragEventHandler<HTMLDivElement> | undefined;
onDragOverCapture?: import("react").DragEventHandler<HTMLDivElement> | undefined;
onDragStart?: import("react").DragEventHandler<HTMLDivElement> | undefined;
onDragStartCapture?: import("react").DragEventHandler<HTMLDivElement> | undefined;
onDrop?: import("react").DragEventHandler<HTMLDivElement> | undefined;
onDropCapture?: import("react").DragEventHandler<HTMLDivElement> | undefined;
onMouseDown?: import("react").MouseEventHandler<HTMLDivElement> | undefined;
onMouseDownCapture?: import("react").MouseEventHandler<HTMLDivElement> | undefined;
onMouseEnter?: import("react").MouseEventHandler<HTMLDivElement> | undefined;
onMouseLeave?: import("react").MouseEventHandler<HTMLDivElement> | undefined;
onMouseMove?: import("react").MouseEventHandler<HTMLDivElement> | undefined;
onMouseMoveCapture?: import("react").MouseEventHandler<HTMLDivElement> | undefined;
onMouseOut?: import("react").MouseEventHandler<HTMLDivElement> | undefined;
onMouseOutCapture?: import("react").MouseEventHandler<HTMLDivElement> | undefined;
onMouseOver?: import("react").MouseEventHandler<HTMLDivElement> | undefined;
onMouseOverCapture?: import("react").MouseEventHandler<HTMLDivElement> | undefined;
onMouseUp?: import("react").MouseEventHandler<HTMLDivElement> | undefined;
onMouseUpCapture?: import("react").MouseEventHandler<HTMLDivElement> | undefined;
onSelect?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onSelectCapture?: import("react").ReactEventHandler<HTMLDivElement> | undefined;
onTouchCancel?: import("react").TouchEventHandler<HTMLDivElement> | undefined;
onTouchCancelCapture?: import("react").TouchEventHandler<HTMLDivElement> | undefined;
onTouchEnd?: import("react").TouchEventHandler<HTMLDivElement> | undefined;
onTouchEndCapture?: import("react").TouchEventHandler<HTMLDivElement> | undefined;
onTouchMove?: import("react").TouchEventHandler<HTMLDivElement> | undefined;
onTouchMoveCapture?: import("react").TouchEventHandler<HTMLDivElement> | undefined;
onTouchStart?: import("react").TouchEventHandler<HTMLDivElement> | undefined;
onTouchStartCapture?: import("react").TouchEventHandler<HTMLDivElement> | undefined;
onPointerDown?: import("react").PointerEventHandler<HTMLDivElement> | undefined;
onPointerDownCapture?: import("react").PointerEventHandler<HTMLDivElement> | undefined;
onPointerMove?: import("react").PointerEventHandler<HTMLDivElement> | undefined;
onPointerMoveCapture?: import("react").PointerEventHandler<HTMLDivElement> | undefined;
onPointerUp?: import("react").PointerEventHandler<HTMLDivElement> | undefined;
onPointerUpCapture?: import("react").PointerEventHandler<HTMLDivElement> | undefined;
onPointerCancel?: import("react").PointerEventHandler<HTMLDivElement> | undefined;
onPointerCancelCapture?: import("react").PointerEventHandler<HTMLDivElement> | undefined;
onPointerEnter?: import("react").PointerEventHandler<HTMLDivElement> | undefined;
onPointerEnterCapture?: import("react").PointerEventHandler<HTMLDivElement> | undefined;
onPointerLeave?: import("react").PointerEventHandler<HTMLDivElement> | undefined;
onPointerLeaveCapture?: import("react").PointerEventHandler<HTMLDivElement> | undefined;
onPointerOver?: import("react").PointerEventHandler<HTMLDivElement> | undefined;
onPointerOverCapture?: import("react").PointerEventHandler<HTMLDivElement> | undefined;
onPointerOut?: import("react").PointerEventHandler<HTMLDivElement> | undefined;
onPointerOutCapture?: import("react").PointerEventHandler<HTMLDivElement> | undefined;
onGotPointerCapture?: import("react").PointerEventHandler<HTMLDivElement> | undefined;
onGotPointerCaptureCapture?: import("react").PointerEventHandler<HTMLDivElement> | undefined;
onLostPointerCapture?: import("react").PointerEventHandler<HTMLDivElement> | undefined;
onLostPointerCaptureCapture?: import("react").PointerEventHandler<HTMLDivElement> | undefined;
onScroll?: import("react").UIEventHandler<HTMLDivElement> | undefined;
onScrollCapture?: import("react").UIEventHandler<HTMLDivElement> | undefined;
onWheel?: import("react").WheelEventHandler<HTMLDivElement> | undefined;
onWheelCapture?: import("react").WheelEventHandler<HTMLDivElement> | undefined;
onAnimationStart?: import("react").AnimationEventHandler<HTMLDivElement> | undefined;
onAnimationStartCapture?: import("react").AnimationEventHandler<HTMLDivElement> | undefined;
onAnimationEnd?: import("react").AnimationEventHandler<HTMLDivElement> | undefined;
onAnimationEndCapture?: import("react").AnimationEventHandler<HTMLDivElement> | undefined;
onAnimationIteration?: import("react").AnimationEventHandler<HTMLDivElement> | undefined;
onAnimationIterationCapture?: import("react").AnimationEventHandler<HTMLDivElement> | undefined;
onTransitionEnd?: import("react").TransitionEventHandler<HTMLDivElement> | undefined;
onTransitionEndCapture?: import("react").TransitionEventHandler<HTMLDivElement> | undefined;
as: "symbol" | "object" | "g" | "clipPath" | "filter" | "mask" | "marker" | "button" | "meter" | "textarea" | "style" | "progress" | "text" | "ruby" | "table" | "small" | "sub" | "circle" | "embed" | "pre" | "caption" | "menu" | "menuitem" | "map" | "big" | "link" | "sup" | import("react").ComponentClass<any, any> | import("react").FunctionComponent<any> | "a" | "abbr" | "address" | "area" | "article" | "aside" | "audio" | "b" | "base" | "bdi" | "bdo" | "blockquote" | "body" | "br" | "canvas" | "cite" | "code" | "col" | "colgroup" | "data" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "div" | "dl" | "dt" | "em" | "fieldset" | "figcaption" | "figure" | "footer" | "form" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "input" | "ins" | "kbd" | "keygen" | "label" | "legend" | "li" | "main" | "mark" | "meta" | "nav" | "noindex" | "noscript" | "ol" | "optgroup" | "option" | "output" | "p" | "param" | "picture" | "q" | "rp" | "rt" | "s" | "samp" | "slot" | "script" | "section" | "select" | "source" | "span" | "strong" | "summary" | "template" | "tbody" | "td" | "tfoot" | "th" | "thead" | "time" | "title" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr" | "webview" | "svg" | "animate" | "animateMotion" | "animateTransform" | "defs" | "desc" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feDropShadow" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "foreignObject" | "image" | "line" | "linearGradient" | "metadata" | "mpath" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "stop" | "switch" | "textPath" | "tspan" | "use" | "view";
className: string;
onClick: import("react").MouseEventHandler<HTMLDivElement> | undefined;
wrapperClassName: string;
role: import("react").AriaRole;
};
//# sourceMappingURL=hook.d.ts.map