@dnb/eufemia
Version:
DNB Eufemia Design System UI Library
286 lines (285 loc) • 17.6 kB
TypeScript
import type { ReactNode } from 'react';
import type { AriaLiveAllProps } from './types';
export default function useAriaLive(props: AriaLiveAllProps): {
element?: import("react").ElementType;
defaultChecked?: boolean | undefined;
defaultValue?: string | number | readonly string[] | undefined;
suppressContentEditableWarning?: boolean | undefined;
suppressHydrationWarning?: boolean | undefined;
accessKey?: string | undefined;
autoCapitalize?: "off" | "none" | "on" | "sentences" | "words" | "characters" | undefined | (string & {});
autoFocus?: boolean | undefined;
contentEditable?: (boolean | "true" | "false") | "inherit" | "plaintext-only" | undefined;
contextMenu?: string | undefined;
dir?: string | undefined;
draggable?: (boolean | "true" | "false") | undefined;
enterKeyHint?: "enter" | "done" | "go" | "next" | "previous" | "search" | "send" | undefined;
hidden?: boolean | undefined;
id?: string | undefined;
lang?: string | undefined;
nonce?: string | undefined;
slot?: string | undefined;
spellCheck?: (boolean | "true" | "false") | undefined;
style?: import("react").CSSProperties | undefined;
tabIndex?: number | undefined;
title?: string | undefined;
translate?: "yes" | "no" | undefined;
radioGroup?: string | undefined;
role?: import("react").AriaRole | undefined;
about?: string | undefined;
content?: string | undefined;
datatype?: string | undefined;
inlist?: any;
prefix?: string | undefined;
property?: string | undefined;
rel?: string | undefined;
resource?: string | undefined;
rev?: string | undefined;
typeof?: string | undefined;
vocab?: string | undefined;
autoCorrect?: string | undefined;
autoSave?: string | undefined;
color?: 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;
popover?: "" | "auto" | "manual" | "hint" | undefined;
popoverTargetAction?: "toggle" | "show" | "hide" | undefined;
popoverTarget?: string | undefined;
inert?: boolean | undefined;
inputMode?: "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search" | undefined;
is?: string | undefined;
exportparts?: string | undefined;
part?: string | undefined;
"aria-activedescendant"?: string | undefined;
"aria-atomic": (boolean | "true" | "false") | undefined;
"aria-autocomplete"?: "none" | "inline" | "list" | "both" | undefined;
"aria-braillelabel"?: string | undefined;
"aria-brailleroledescription"?: string | undefined;
"aria-busy"?: (boolean | "true" | "false") | undefined;
"aria-checked"?: boolean | "false" | "mixed" | "true" | undefined;
"aria-colcount"?: number | undefined;
"aria-colindex"?: number | undefined;
"aria-colindextext"?: string | undefined;
"aria-colspan"?: number | undefined;
"aria-controls"?: string | undefined;
"aria-current"?: boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time" | undefined;
"aria-describedby"?: string | undefined;
"aria-description"?: string | undefined;
"aria-details"?: string | undefined;
"aria-disabled"?: (boolean | "true" | "false") | undefined;
"aria-dropeffect"?: "none" | "copy" | "execute" | "link" | "move" | "popup" | undefined;
"aria-errormessage"?: string | undefined;
"aria-expanded"?: (boolean | "true" | "false") | undefined;
"aria-flowto"?: string | undefined;
"aria-grabbed"?: (boolean | "true" | "false") | undefined;
"aria-haspopup"?: boolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog" | undefined;
"aria-hidden"?: (boolean | "true" | "false") | 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 | "true" | "false") | undefined;
"aria-multiline"?: (boolean | "true" | "false") | undefined;
"aria-multiselectable"?: (boolean | "true" | "false") | undefined;
"aria-orientation"?: "horizontal" | "vertical" | undefined;
"aria-owns"?: string | undefined;
"aria-placeholder"?: string | undefined;
"aria-posinset"?: number | undefined;
"aria-pressed"?: boolean | "false" | "mixed" | "true" | undefined;
"aria-readonly"?: (boolean | "true" | "false") | undefined;
"aria-relevant": "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals" | undefined;
"aria-required"?: (boolean | "true" | "false") | undefined;
"aria-roledescription"?: string | undefined;
"aria-rowcount"?: number | undefined;
"aria-rowindex"?: number | undefined;
"aria-rowindextext"?: string | undefined;
"aria-rowspan"?: number | undefined;
"aria-selected"?: (boolean | "true" | "false") | 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 | TrustedHTML;
} | undefined;
onCopy?: import("react").ClipboardEventHandler<HTMLElement>;
onCopyCapture?: import("react").ClipboardEventHandler<HTMLElement>;
onCut?: import("react").ClipboardEventHandler<HTMLElement>;
onCutCapture?: import("react").ClipboardEventHandler<HTMLElement>;
onPaste?: import("react").ClipboardEventHandler<HTMLElement>;
onPasteCapture?: import("react").ClipboardEventHandler<HTMLElement>;
onCompositionEnd?: import("react").CompositionEventHandler<HTMLElement>;
onCompositionEndCapture?: import("react").CompositionEventHandler<HTMLElement>;
onCompositionStart?: import("react").CompositionEventHandler<HTMLElement>;
onCompositionStartCapture?: import("react").CompositionEventHandler<HTMLElement>;
onCompositionUpdate?: import("react").CompositionEventHandler<HTMLElement>;
onCompositionUpdateCapture?: import("react").CompositionEventHandler<HTMLElement>;
onFocus?: import("react").FocusEventHandler<HTMLElement>;
onFocusCapture?: import("react").FocusEventHandler<HTMLElement>;
onBlur?: import("react").FocusEventHandler<HTMLElement>;
onBlurCapture?: import("react").FocusEventHandler<HTMLElement>;
onChange?: import("react").ChangeEventHandler<HTMLElement, Element>;
onChangeCapture?: import("react").ChangeEventHandler<HTMLElement, Element>;
onBeforeInput?: import("react").InputEventHandler<HTMLElement>;
onBeforeInputCapture?: import("react").InputEventHandler<HTMLElement>;
onInput?: import("react").InputEventHandler<HTMLElement>;
onInputCapture?: import("react").InputEventHandler<HTMLElement>;
onReset?: import("react").ReactEventHandler<HTMLElement>;
onResetCapture?: import("react").ReactEventHandler<HTMLElement>;
onSubmit?: import("react").SubmitEventHandler<HTMLElement>;
onSubmitCapture?: import("react").SubmitEventHandler<HTMLElement>;
onInvalid?: import("react").ReactEventHandler<HTMLElement>;
onInvalidCapture?: import("react").ReactEventHandler<HTMLElement>;
onLoad?: import("react").ReactEventHandler<HTMLElement>;
onLoadCapture?: import("react").ReactEventHandler<HTMLElement>;
onError?: import("react").ReactEventHandler<HTMLElement>;
onErrorCapture?: import("react").ReactEventHandler<HTMLElement>;
onKeyDown?: import("react").KeyboardEventHandler<HTMLElement>;
onKeyDownCapture?: import("react").KeyboardEventHandler<HTMLElement>;
onKeyPress?: import("react").KeyboardEventHandler<HTMLElement>;
onKeyPressCapture?: import("react").KeyboardEventHandler<HTMLElement>;
onKeyUp?: import("react").KeyboardEventHandler<HTMLElement>;
onKeyUpCapture?: import("react").KeyboardEventHandler<HTMLElement>;
onAbort?: import("react").ReactEventHandler<HTMLElement>;
onAbortCapture?: import("react").ReactEventHandler<HTMLElement>;
onCanPlay?: import("react").ReactEventHandler<HTMLElement>;
onCanPlayCapture?: import("react").ReactEventHandler<HTMLElement>;
onCanPlayThrough?: import("react").ReactEventHandler<HTMLElement>;
onCanPlayThroughCapture?: import("react").ReactEventHandler<HTMLElement>;
onDurationChange?: import("react").ReactEventHandler<HTMLElement>;
onDurationChangeCapture?: import("react").ReactEventHandler<HTMLElement>;
onEmptied?: import("react").ReactEventHandler<HTMLElement>;
onEmptiedCapture?: import("react").ReactEventHandler<HTMLElement>;
onEncrypted?: import("react").ReactEventHandler<HTMLElement>;
onEncryptedCapture?: import("react").ReactEventHandler<HTMLElement>;
onEnded?: import("react").ReactEventHandler<HTMLElement>;
onEndedCapture?: import("react").ReactEventHandler<HTMLElement>;
onLoadedData?: import("react").ReactEventHandler<HTMLElement>;
onLoadedDataCapture?: import("react").ReactEventHandler<HTMLElement>;
onLoadedMetadata?: import("react").ReactEventHandler<HTMLElement>;
onLoadedMetadataCapture?: import("react").ReactEventHandler<HTMLElement>;
onLoadStart?: import("react").ReactEventHandler<HTMLElement>;
onLoadStartCapture?: import("react").ReactEventHandler<HTMLElement>;
onPause?: import("react").ReactEventHandler<HTMLElement>;
onPauseCapture?: import("react").ReactEventHandler<HTMLElement>;
onPlay?: import("react").ReactEventHandler<HTMLElement>;
onPlayCapture?: import("react").ReactEventHandler<HTMLElement>;
onPlaying?: import("react").ReactEventHandler<HTMLElement>;
onPlayingCapture?: import("react").ReactEventHandler<HTMLElement>;
onProgress?: import("react").ReactEventHandler<HTMLElement>;
onProgressCapture?: import("react").ReactEventHandler<HTMLElement>;
onRateChange?: import("react").ReactEventHandler<HTMLElement>;
onRateChangeCapture?: import("react").ReactEventHandler<HTMLElement>;
onSeeked?: import("react").ReactEventHandler<HTMLElement>;
onSeekedCapture?: import("react").ReactEventHandler<HTMLElement>;
onSeeking?: import("react").ReactEventHandler<HTMLElement>;
onSeekingCapture?: import("react").ReactEventHandler<HTMLElement>;
onStalled?: import("react").ReactEventHandler<HTMLElement>;
onStalledCapture?: import("react").ReactEventHandler<HTMLElement>;
onSuspend?: import("react").ReactEventHandler<HTMLElement>;
onSuspendCapture?: import("react").ReactEventHandler<HTMLElement>;
onTimeUpdate?: import("react").ReactEventHandler<HTMLElement>;
onTimeUpdateCapture?: import("react").ReactEventHandler<HTMLElement>;
onVolumeChange?: import("react").ReactEventHandler<HTMLElement>;
onVolumeChangeCapture?: import("react").ReactEventHandler<HTMLElement>;
onWaiting?: import("react").ReactEventHandler<HTMLElement>;
onWaitingCapture?: import("react").ReactEventHandler<HTMLElement>;
onAuxClick?: import("react").MouseEventHandler<HTMLElement>;
onAuxClickCapture?: import("react").MouseEventHandler<HTMLElement>;
onClick?: import("react").MouseEventHandler<HTMLElement>;
onClickCapture?: import("react").MouseEventHandler<HTMLElement>;
onContextMenu?: import("react").MouseEventHandler<HTMLElement>;
onContextMenuCapture?: import("react").MouseEventHandler<HTMLElement>;
onDoubleClick?: import("react").MouseEventHandler<HTMLElement>;
onDoubleClickCapture?: import("react").MouseEventHandler<HTMLElement>;
onDrag?: import("react").DragEventHandler<HTMLElement>;
onDragCapture?: import("react").DragEventHandler<HTMLElement>;
onDragEnd?: import("react").DragEventHandler<HTMLElement>;
onDragEndCapture?: import("react").DragEventHandler<HTMLElement>;
onDragEnter?: import("react").DragEventHandler<HTMLElement>;
onDragEnterCapture?: import("react").DragEventHandler<HTMLElement>;
onDragExit?: import("react").DragEventHandler<HTMLElement>;
onDragExitCapture?: import("react").DragEventHandler<HTMLElement>;
onDragLeave?: import("react").DragEventHandler<HTMLElement>;
onDragLeaveCapture?: import("react").DragEventHandler<HTMLElement>;
onDragOver?: import("react").DragEventHandler<HTMLElement>;
onDragOverCapture?: import("react").DragEventHandler<HTMLElement>;
onDragStart?: import("react").DragEventHandler<HTMLElement>;
onDragStartCapture?: import("react").DragEventHandler<HTMLElement>;
onDrop?: import("react").DragEventHandler<HTMLElement>;
onDropCapture?: import("react").DragEventHandler<HTMLElement>;
onMouseDown?: import("react").MouseEventHandler<HTMLElement>;
onMouseDownCapture?: import("react").MouseEventHandler<HTMLElement>;
onMouseEnter?: import("react").MouseEventHandler<HTMLElement>;
onMouseLeave?: import("react").MouseEventHandler<HTMLElement>;
onMouseMove?: import("react").MouseEventHandler<HTMLElement>;
onMouseMoveCapture?: import("react").MouseEventHandler<HTMLElement>;
onMouseOut?: import("react").MouseEventHandler<HTMLElement>;
onMouseOutCapture?: import("react").MouseEventHandler<HTMLElement>;
onMouseOver?: import("react").MouseEventHandler<HTMLElement>;
onMouseOverCapture?: import("react").MouseEventHandler<HTMLElement>;
onMouseUp?: import("react").MouseEventHandler<HTMLElement>;
onMouseUpCapture?: import("react").MouseEventHandler<HTMLElement>;
onSelect?: import("react").ReactEventHandler<HTMLElement>;
onSelectCapture?: import("react").ReactEventHandler<HTMLElement>;
onTouchCancel?: import("react").TouchEventHandler<HTMLElement>;
onTouchCancelCapture?: import("react").TouchEventHandler<HTMLElement>;
onTouchEnd?: import("react").TouchEventHandler<HTMLElement>;
onTouchEndCapture?: import("react").TouchEventHandler<HTMLElement>;
onTouchMove?: import("react").TouchEventHandler<HTMLElement>;
onTouchMoveCapture?: import("react").TouchEventHandler<HTMLElement>;
onTouchStart?: import("react").TouchEventHandler<HTMLElement>;
onTouchStartCapture?: import("react").TouchEventHandler<HTMLElement>;
onPointerDown?: import("react").PointerEventHandler<HTMLElement>;
onPointerDownCapture?: import("react").PointerEventHandler<HTMLElement>;
onPointerMove?: import("react").PointerEventHandler<HTMLElement>;
onPointerMoveCapture?: import("react").PointerEventHandler<HTMLElement>;
onPointerUp?: import("react").PointerEventHandler<HTMLElement>;
onPointerUpCapture?: import("react").PointerEventHandler<HTMLElement>;
onPointerCancel?: import("react").PointerEventHandler<HTMLElement>;
onPointerCancelCapture?: import("react").PointerEventHandler<HTMLElement>;
onPointerEnter?: import("react").PointerEventHandler<HTMLElement>;
onPointerLeave?: import("react").PointerEventHandler<HTMLElement>;
onPointerOver?: import("react").PointerEventHandler<HTMLElement>;
onPointerOverCapture?: import("react").PointerEventHandler<HTMLElement>;
onPointerOut?: import("react").PointerEventHandler<HTMLElement>;
onPointerOutCapture?: import("react").PointerEventHandler<HTMLElement>;
onGotPointerCapture?: import("react").PointerEventHandler<HTMLElement>;
onGotPointerCaptureCapture?: import("react").PointerEventHandler<HTMLElement>;
onLostPointerCapture?: import("react").PointerEventHandler<HTMLElement>;
onLostPointerCaptureCapture?: import("react").PointerEventHandler<HTMLElement>;
onScroll?: import("react").UIEventHandler<HTMLElement>;
onScrollCapture?: import("react").UIEventHandler<HTMLElement>;
onScrollEnd?: import("react").UIEventHandler<HTMLElement>;
onScrollEndCapture?: import("react").UIEventHandler<HTMLElement>;
onWheel?: import("react").WheelEventHandler<HTMLElement>;
onWheelCapture?: import("react").WheelEventHandler<HTMLElement>;
onAnimationStart?: import("react").AnimationEventHandler<HTMLElement>;
onAnimationStartCapture?: import("react").AnimationEventHandler<HTMLElement>;
onAnimationEnd?: import("react").AnimationEventHandler<HTMLElement>;
onAnimationEndCapture?: import("react").AnimationEventHandler<HTMLElement>;
onAnimationIteration?: import("react").AnimationEventHandler<HTMLElement>;
onAnimationIterationCapture?: import("react").AnimationEventHandler<HTMLElement>;
onToggle?: import("react").ToggleEventHandler<HTMLElement>;
onBeforeToggle?: import("react").ToggleEventHandler<HTMLElement>;
onTransitionCancel?: import("react").TransitionEventHandler<HTMLElement>;
onTransitionCancelCapture?: import("react").TransitionEventHandler<HTMLElement>;
onTransitionEnd?: import("react").TransitionEventHandler<HTMLElement>;
onTransitionEndCapture?: import("react").TransitionEventHandler<HTMLElement>;
onTransitionRun?: import("react").TransitionEventHandler<HTMLElement>;
onTransitionRunCapture?: import("react").TransitionEventHandler<HTMLElement>;
onTransitionStart?: import("react").TransitionEventHandler<HTMLElement>;
onTransitionStartCapture?: import("react").TransitionEventHandler<HTMLElement>;
className: string;
children: ReactNode;
};