react-accessible-headings/build/index.d.ts

Accessible dynamic H1, H2, that will adjust for accessibility reasons! WCAG ARIA

import { DetailedHTMLProps, HTMLAttributes, ReactNode } from 'react';
export declare const HeadingsContext: import("react").Context<{
    level: number;
    hClassName?: string;
}>;
declare type LevelProps = {
    value?: number;
    children: ReactNode;
    hClassName?: string;
};
export declare function Level({ children, value, hClassName }: LevelProps): JSX.Element;
declare type HeadingProps = {
    offset?: number;
} & DetailedHTMLProps<HTMLAttributes<HTMLHeadingElement>, HTMLHeadingElement>;
export declare function H({ children, offset, className, ...otherProps }: HeadingProps): import("react").DOMElement<{
    ref?: import("react").LegacyRef<HTMLHeadingElement>;
    key?: import("react").Key;
    defaultChecked?: boolean;
    defaultValue?: string | number | readonly string[];
    suppressContentEditableWarning?: boolean;
    suppressHydrationWarning?: boolean;
    accessKey?: string;
    contentEditable?: "inherit" | (boolean | "false" | "true");
    contextMenu?: string;
    dir?: string;
    draggable?: boolean | "false" | "true";
    hidden?: boolean;
    id?: string;
    lang?: string;
    placeholder?: string;
    slot?: string;
    spellCheck?: boolean | "false" | "true";
    style?: import("react").CSSProperties;
    tabIndex?: number;
    title?: string;
    translate?: "yes" | "no";
    radioGroup?: string;
    role?: import("react").AriaRole;
    about?: string;
    datatype?: string;
    inlist?: any;
    prefix?: string;
    property?: string;
    resource?: string;
    typeof?: string;
    vocab?: string;
    autoCapitalize?: string;
    autoCorrect?: string;
    autoSave?: string;
    color?: string;
    itemProp?: string;
    itemScope?: boolean;
    itemType?: string;
    itemID?: string;
    itemRef?: string;
    results?: number;
    security?: string;
    unselectable?: "on" | "off";
    inputMode?: "search" | "numeric" | "none" | "url" | "text" | "decimal" | "tel" | "email";
    is?: string;
    'aria-activedescendant'?: string;
    'aria-atomic'?: boolean | "false" | "true";
    'aria-autocomplete'?: "inline" | "both" | "none" | "list";
    'aria-busy'?: boolean | "false" | "true";
    'aria-checked'?: boolean | "mixed" | "false" | "true";
    'aria-colcount'?: number;
    'aria-colindex'?: number;
    'aria-colspan'?: number;
    'aria-controls'?: string;
    'aria-current'?: boolean | "location" | "time" | "false" | "page" | "true" | "step" | "date";
    'aria-describedby'?: string;
    'aria-details'?: string;
    'aria-disabled'?: boolean | "false" | "true";
    'aria-dropeffect'?: "link" | "none" | "copy" | "move" | "execute" | "popup";
    'aria-errormessage'?: string;
    'aria-expanded'?: boolean | "false" | "true";
    'aria-flowto'?: string;
    'aria-grabbed'?: boolean | "false" | "true";
    'aria-haspopup'?: boolean | "grid" | "dialog" | "menu" | "false" | "listbox" | "true" | "tree";
    'aria-hidden'?: boolean | "false" | "true";
    'aria-invalid'?: boolean | "false" | "true" | "grammar" | "spelling";
    'aria-keyshortcuts'?: string;
    'aria-label'?: string;
    'aria-labelledby'?: string;
    'aria-level'?: number;
    'aria-live'?: "off" | "assertive" | "polite";
    'aria-modal'?: boolean | "false" | "true";
    'aria-multiline'?: boolean | "false" | "true";
    'aria-multiselectable'?: boolean | "false" | "true";
    'aria-orientation'?: "horizontal" | "vertical";
    'aria-owns'?: string;
    'aria-placeholder'?: string;
    'aria-posinset'?: number;
    'aria-pressed'?: boolean | "mixed" | "false" | "true";
    'aria-readonly'?: boolean | "false" | "true";
    'aria-relevant'?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals";
    'aria-required'?: boolean | "false" | "true";
    'aria-roledescription'?: string;
    'aria-rowcount'?: number;
    'aria-rowindex'?: number;
    'aria-rowspan'?: number;
    'aria-selected'?: boolean | "false" | "true";
    'aria-setsize'?: number;
    'aria-sort'?: "none" | "other" | "ascending" | "descending";
    'aria-valuemax'?: number;
    'aria-valuemin'?: number;
    'aria-valuenow'?: number;
    'aria-valuetext'?: string;
    dangerouslySetInnerHTML?: {
        __html: string;
    };
    onCopy?: import("react").ClipboardEventHandler<HTMLHeadingElement>;
    onCopyCapture?: import("react").ClipboardEventHandler<HTMLHeadingElement>;
    onCut?: import("react").ClipboardEventHandler<HTMLHeadingElement>;
    onCutCapture?: import("react").ClipboardEventHandler<HTMLHeadingElement>;
    onPaste?: import("react").ClipboardEventHandler<HTMLHeadingElement>;
    onPasteCapture?: import("react").ClipboardEventHandler<HTMLHeadingElement>;
    onCompositionEnd?: import("react").CompositionEventHandler<HTMLHeadingElement>;
    onCompositionEndCapture?: import("react").CompositionEventHandler<HTMLHeadingElement>;
    onCompositionStart?: import("react").CompositionEventHandler<HTMLHeadingElement>;
    onCompositionStartCapture?: import("react").CompositionEventHandler<HTMLHeadingElement>;
    onCompositionUpdate?: import("react").CompositionEventHandler<HTMLHeadingElement>;
    onCompositionUpdateCapture?: import("react").CompositionEventHandler<HTMLHeadingElement>;
    onFocus?: import("react").FocusEventHandler<HTMLHeadingElement>;
    onFocusCapture?: import("react").FocusEventHandler<HTMLHeadingElement>;
    onBlur?: import("react").FocusEventHandler<HTMLHeadingElement>;
    onBlurCapture?: import("react").FocusEventHandler<HTMLHeadingElement>;
    onChange?: import("react").FormEventHandler<HTMLHeadingElement>;
    onChangeCapture?: import("react").FormEventHandler<HTMLHeadingElement>;
    onBeforeInput?: import("react").FormEventHandler<HTMLHeadingElement>;
    onBeforeInputCapture?: import("react").FormEventHandler<HTMLHeadingElement>;
    onInput?: import("react").FormEventHandler<HTMLHeadingElement>;
    onInputCapture?: import("react").FormEventHandler<HTMLHeadingElement>;
    onReset?: import("react").FormEventHandler<HTMLHeadingElement>;
    onResetCapture?: import("react").FormEventHandler<HTMLHeadingElement>;
    onSubmit?: import("react").FormEventHandler<HTMLHeadingElement>;
    onSubmitCapture?: import("react").FormEventHandler<HTMLHeadingElement>;
    onInvalid?: import("react").FormEventHandler<HTMLHeadingElement>;
    onInvalidCapture?: import("react").FormEventHandler<HTMLHeadingElement>;
    onLoad?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onLoadCapture?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onError?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onErrorCapture?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onKeyDown?: import("react").KeyboardEventHandler<HTMLHeadingElement>;
    onKeyDownCapture?: import("react").KeyboardEventHandler<HTMLHeadingElement>;
    onKeyPress?: import("react").KeyboardEventHandler<HTMLHeadingElement>;
    onKeyPressCapture?: import("react").KeyboardEventHandler<HTMLHeadingElement>;
    onKeyUp?: import("react").KeyboardEventHandler<HTMLHeadingElement>;
    onKeyUpCapture?: import("react").KeyboardEventHandler<HTMLHeadingElement>;
    onAbort?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onAbortCapture?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onCanPlay?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onCanPlayCapture?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onCanPlayThrough?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onCanPlayThroughCapture?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onDurationChange?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onDurationChangeCapture?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onEmptied?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onEmptiedCapture?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onEncrypted?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onEncryptedCapture?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onEnded?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onEndedCapture?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onLoadedData?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onLoadedDataCapture?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onLoadedMetadata?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onLoadedMetadataCapture?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onLoadStart?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onLoadStartCapture?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onPause?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onPauseCapture?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onPlay?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onPlayCapture?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onPlaying?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onPlayingCapture?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onProgress?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onProgressCapture?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onRateChange?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onRateChangeCapture?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onSeeked?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onSeekedCapture?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onSeeking?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onSeekingCapture?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onStalled?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onStalledCapture?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onSuspend?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onSuspendCapture?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onTimeUpdate?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onTimeUpdateCapture?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onVolumeChange?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onVolumeChangeCapture?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onWaiting?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onWaitingCapture?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onAuxClick?: import("react").MouseEventHandler<HTMLHeadingElement>;
    onAuxClickCapture?: import("react").MouseEventHandler<HTMLHeadingElement>;
    onClick?: import("react").MouseEventHandler<HTMLHeadingElement>;
    onClickCapture?: import("react").MouseEventHandler<HTMLHeadingElement>;
    onContextMenu?: import("react").MouseEventHandler<HTMLHeadingElement>;
    onContextMenuCapture?: import("react").MouseEventHandler<HTMLHeadingElement>;
    onDoubleClick?: import("react").MouseEventHandler<HTMLHeadingElement>;
    onDoubleClickCapture?: import("react").MouseEventHandler<HTMLHeadingElement>;
    onDrag?: import("react").DragEventHandler<HTMLHeadingElement>;
    onDragCapture?: import("react").DragEventHandler<HTMLHeadingElement>;
    onDragEnd?: import("react").DragEventHandler<HTMLHeadingElement>;
    onDragEndCapture?: import("react").DragEventHandler<HTMLHeadingElement>;
    onDragEnter?: import("react").DragEventHandler<HTMLHeadingElement>;
    onDragEnterCapture?: import("react").DragEventHandler<HTMLHeadingElement>;
    onDragExit?: import("react").DragEventHandler<HTMLHeadingElement>;
    onDragExitCapture?: import("react").DragEventHandler<HTMLHeadingElement>;
    onDragLeave?: import("react").DragEventHandler<HTMLHeadingElement>;
    onDragLeaveCapture?: import("react").DragEventHandler<HTMLHeadingElement>;
    onDragOver?: import("react").DragEventHandler<HTMLHeadingElement>;
    onDragOverCapture?: import("react").DragEventHandler<HTMLHeadingElement>;
    onDragStart?: import("react").DragEventHandler<HTMLHeadingElement>;
    onDragStartCapture?: import("react").DragEventHandler<HTMLHeadingElement>;
    onDrop?: import("react").DragEventHandler<HTMLHeadingElement>;
    onDropCapture?: import("react").DragEventHandler<HTMLHeadingElement>;
    onMouseDown?: import("react").MouseEventHandler<HTMLHeadingElement>;
    onMouseDownCapture?: import("react").MouseEventHandler<HTMLHeadingElement>;
    onMouseEnter?: import("react").MouseEventHandler<HTMLHeadingElement>;
    onMouseLeave?: import("react").MouseEventHandler<HTMLHeadingElement>;
    onMouseMove?: import("react").MouseEventHandler<HTMLHeadingElement>;
    onMouseMoveCapture?: import("react").MouseEventHandler<HTMLHeadingElement>;
    onMouseOut?: import("react").MouseEventHandler<HTMLHeadingElement>;
    onMouseOutCapture?: import("react").MouseEventHandler<HTMLHeadingElement>;
    onMouseOver?: import("react").MouseEventHandler<HTMLHeadingElement>;
    onMouseOverCapture?: import("react").MouseEventHandler<HTMLHeadingElement>;
    onMouseUp?: import("react").MouseEventHandler<HTMLHeadingElement>;
    onMouseUpCapture?: import("react").MouseEventHandler<HTMLHeadingElement>;
    onSelect?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onSelectCapture?: import("react").ReactEventHandler<HTMLHeadingElement>;
    onTouchCancel?: import("react").TouchEventHandler<HTMLHeadingElement>;
    onTouchCancelCapture?: import("react").TouchEventHandler<HTMLHeadingElement>;
    onTouchEnd?: import("react").TouchEventHandler<HTMLHeadingElement>;
    onTouchEndCapture?: import("react").TouchEventHandler<HTMLHeadingElement>;
    onTouchMove?: import("react").TouchEventHandler<HTMLHeadingElement>;
    onTouchMoveCapture?: import("react").TouchEventHandler<HTMLHeadingElement>;
    onTouchStart?: import("react").TouchEventHandler<HTMLHeadingElement>;
    onTouchStartCapture?: import("react").TouchEventHandler<HTMLHeadingElement>;
    onPointerDown?: import("react").PointerEventHandler<HTMLHeadingElement>;
    onPointerDownCapture?: import("react").PointerEventHandler<HTMLHeadingElement>;
    onPointerMove?: import("react").PointerEventHandler<HTMLHeadingElement>;
    onPointerMoveCapture?: import("react").PointerEventHandler<HTMLHeadingElement>;
    onPointerUp?: import("react").PointerEventHandler<HTMLHeadingElement>;
    onPointerUpCapture?: import("react").PointerEventHandler<HTMLHeadingElement>;
    onPointerCancel?: import("react").PointerEventHandler<HTMLHeadingElement>;
    onPointerCancelCapture?: import("react").PointerEventHandler<HTMLHeadingElement>;
    onPointerEnter?: import("react").PointerEventHandler<HTMLHeadingElement>;
    onPointerEnterCapture?: import("react").PointerEventHandler<HTMLHeadingElement>;
    onPointerLeave?: import("react").PointerEventHandler<HTMLHeadingElement>;
    onPointerLeaveCapture?: import("react").PointerEventHandler<HTMLHeadingElement>;
    onPointerOver?: import("react").PointerEventHandler<HTMLHeadingElement>;
    onPointerOverCapture?: import("react").PointerEventHandler<HTMLHeadingElement>;
    onPointerOut?: import("react").PointerEventHandler<HTMLHeadingElement>;
    onPointerOutCapture?: import("react").PointerEventHandler<HTMLHeadingElement>;
    onGotPointerCapture?: import("react").PointerEventHandler<HTMLHeadingElement>;
    onGotPointerCaptureCapture?: import("react").PointerEventHandler<HTMLHeadingElement>;
    onLostPointerCapture?: import("react").PointerEventHandler<HTMLHeadingElement>;
    onLostPointerCaptureCapture?: import("react").PointerEventHandler<HTMLHeadingElement>;
    onScroll?: import("react").UIEventHandler<HTMLHeadingElement>;
    onScrollCapture?: import("react").UIEventHandler<HTMLHeadingElement>;
    onWheel?: import("react").WheelEventHandler<HTMLHeadingElement>;
    onWheelCapture?: import("react").WheelEventHandler<HTMLHeadingElement>;
    onAnimationStart?: import("react").AnimationEventHandler<HTMLHeadingElement>;
    onAnimationStartCapture?: import("react").AnimationEventHandler<HTMLHeadingElement>;
    onAnimationEnd?: import("react").AnimationEventHandler<HTMLHeadingElement>;
    onAnimationEndCapture?: import("react").AnimationEventHandler<HTMLHeadingElement>;
    onAnimationIteration?: import("react").AnimationEventHandler<HTMLHeadingElement>;
    onAnimationIterationCapture?: import("react").AnimationEventHandler<HTMLHeadingElement>;
    onTransitionEnd?: import("react").TransitionEventHandler<HTMLHeadingElement>;
    onTransitionEndCapture?: import("react").TransitionEventHandler<HTMLHeadingElement>;
    className: string;
}, HTMLHeadingElement>;
export declare function useLevel(): number;
export declare function useHClassName(): string;
export declare function checkHeadingLevels(headings: number[]): number[];
export {};