Interface PageToggleButtonProps

interface PageToggleButtonProps {
    about?: string;
    accept?: string;
    acceptCharset?: string;
    accessKey?: string;
    action?: string;
    allowFullScreen?: boolean;
    allowTransparency?: boolean;
    alt?: string;
    aria-activedescendant?: string;
    aria-atomic?: Booleanish;
    aria-autocomplete?:
        | "list"
        | "inline"
        | "none"
        | "both";
    aria-braillelabel?: string;
    aria-brailleroledescription?: string;
    aria-busy?: Booleanish;
    aria-checked?:
        | boolean
        | "true"
        | "false"
        | "mixed";
    aria-colcount?: number;
    aria-colindex?: number;
    aria-colindextext?: string;
    aria-colspan?: number;
    aria-controls?: string;
    aria-current?:
        | boolean
        | "step"
        | "time"
        | "location"
        | "true"
        | "false"
        | "page"
        | "date";
    aria-describedby?: string;
    aria-description?: string;
    aria-details?: string;
    aria-disabled?: Booleanish;
    aria-dropeffect?:
        | "link"
        | "copy"
        | "move"
        | "none"
        | "execute"
        | "popup";
    aria-errormessage?: string;
    aria-expanded?: Booleanish;
    aria-flowto?: string;
    aria-grabbed?: Booleanish;
    aria-haspopup?:
        | boolean
        | "dialog"
        | "menu"
        | "grid"
        | "true"
        | "false"
        | "listbox"
        | "tree";
    aria-hidden?: Booleanish;
    aria-invalid?:
        | boolean
        | "true"
        | "false"
        | "grammar"
        | "spelling";
    aria-keyshortcuts?: string;
    aria-label?: string;
    aria-labelledby?: string;
    aria-level?: number;
    aria-live?: "off" | "assertive" | "polite";
    aria-modal?: Booleanish;
    aria-multiline?: Booleanish;
    aria-multiselectable?: Booleanish;
    aria-orientation?: "horizontal" | "vertical";
    aria-owns?: string;
    aria-placeholder?: string;
    aria-posinset?: number;
    aria-pressed?:
        | boolean
        | "true"
        | "false"
        | "mixed";
    aria-readonly?: Booleanish;
    aria-relevant?:
        | "text"
        | "additions"
        | "additions removals"
        | "additions text"
        | "all"
        | "removals"
        | "removals additions"
        | "removals text"
        | "text additions"
        | "text removals";
    aria-required?: Booleanish;
    aria-roledescription?: string;
    aria-rowcount?: number;
    aria-rowindex?: number;
    aria-rowindextext?: string;
    aria-rowspan?: number;
    aria-selected?: Booleanish;
    aria-setsize?: number;
    aria-sort?:
        | "none"
        | "ascending"
        | "descending"
        | "other";
    aria-valuemax?: number;
    aria-valuemin?: number;
    aria-valuenow?: number;
    aria-valuetext?: string;
    as?: string;
    async?: boolean;
    autoCapitalize?:
        | string & {}
        | "none"
        | "off"
        | "on"
        | "sentences"
        | "words"
        | "characters";
    autoComplete?: string;
    autoCorrect?: string;
    autoFocus?: boolean;
    autoPlay?: boolean;
    autoSave?: string;
    capture?: boolean | "user" | "environment";
    cellPadding?: string | number;
    cellSpacing?: string | number;
    challenge?: string;
    charSet?: string;
    checked?: boolean;
    children?: ReactNode;
    cite?: string;
    classID?: string;
    className?: string;
    color?: string;
    cols?: number;
    colSpan?: number;
    component?:
        | "symbol"
        | "object"
        | ComponentClass<any, any>
        | FunctionComponent<any>
        | "search"
        | "big"
        | "link"
        | "small"
        | "sub"
        | "sup"
        | "div"
        | "ul"
        | "style"
        | "h1"
        | "li"
        | "cite"
        | "data"
        | "form"
        | "label"
        | "pattern"
        | "span"
        | "summary"
        | "slot"
        | "title"
        | "a"
        | "abbr"
        | "address"
        | "area"
        | "article"
        | "aside"
        | "audio"
        | "b"
        | "base"
        | "bdi"
        | "bdo"
        | "blockquote"
        | "body"
        | "br"
        | "button"
        | "canvas"
        | "caption"
        | "code"
        | "col"
        | "colgroup"
        | "datalist"
        | "dd"
        | "del"
        | "details"
        | "dfn"
        | "dialog"
        | "dl"
        | "dt"
        | "em"
        | "embed"
        | "fieldset"
        | "figcaption"
        | "figure"
        | "footer"
        | "h2"
        | "h3"
        | "h4"
        | "h5"
        | "h6"
        | "head"
        | "header"
        | "hgroup"
        | "hr"
        | "html"
        | "i"
        | "iframe"
        | "img"
        | "input"
        | "ins"
        | "kbd"
        | "legend"
        | "main"
        | "map"
        | "mark"
        | "menu"
        | "meta"
        | "meter"
        | "nav"
        | "noscript"
        | "ol"
        | "optgroup"
        | "option"
        | "output"
        | "p"
        | "picture"
        | "pre"
        | "progress"
        | "q"
        | "rp"
        | "rt"
        | "ruby"
        | "s"
        | "samp"
        | "script"
        | "section"
        | "select"
        | "source"
        | "strong"
        | "table"
        | "tbody"
        | "td"
        | "template"
        | "textarea"
        | "tfoot"
        | "th"
        | "thead"
        | "time"
        | "tr"
        | "track"
        | "u"
        | "var"
        | "video"
        | "wbr"
        | "filter"
        | "set"
        | "center"
        | "text"
        | "keygen"
        | "menuitem"
        | "param"
        | "webview"
        | "animate"
        | "circle"
        | "clipPath"
        | "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"
        | "g"
        | "image"
        | "line"
        | "linearGradient"
        | "marker"
        | "mask"
        | "metadata"
        | "path"
        | "polygon"
        | "polyline"
        | "radialGradient"
        | "rect"
        | "stop"
        | "svg"
        | "switch"
        | "textPath"
        | "tspan"
        | "use"
        | "view"
        | "noindex"
        | "animateMotion"
        | "animateTransform"
        | "mpath";
    content?: string;
    contentEditable?: "inherit" | Booleanish | "plaintext-only";
    contextMenu?: string;
    controls?: boolean;
    coords?: string;
    countOptions?: BadgeCountObject;
    crossOrigin?: CrossOrigin;
    dangerouslySetInnerHTML?: {
        __html: string | TrustedHTML;
    };
    data?: string;
    datatype?: string;
    dateTime?: string;
    default?: boolean;
    defaultChecked?: boolean;
    defaultValue?: string | number | readonly string[];
    defer?: boolean;
    dir?: string;
    disabled?: boolean;
    download?: any;
    draggable?: Booleanish;
    encType?: string;
    enterKeyHint?:
        | "search"
        | "enter"
        | "done"
        | "go"
        | "next"
        | "previous"
        | "send";
    form?: string;
    formAction?: string;
    formEncType?: string;
    formMethod?: string;
    formNoValidate?: boolean;
    formTarget?: string;
    frameBorder?: string | number;
    headers?: string;
    height?: string | number;
    hidden?: boolean;
    high?: number;
    href?: string;
    hrefLang?: string;
    htmlFor?: string;
    httpEquiv?: string;
    icon?: ReactNode;
    iconPosition?:
        | "start"
        | "right"
        | "end"
        | "left";
    id?: string;
    inlist?: any;
    innerRef?: Ref<any>;
    inoperableEvents?: string[];
    inputMode?:
        | "search"
        | "text"
        | "none"
        | "tel"
        | "url"
        | "email"
        | "numeric"
        | "decimal";
    integrity?: string;
    is?: string;
    isActive?: boolean;
    isAriaDisabled?: boolean;
    isBlock?: boolean;
    isDanger?: boolean;
    isDisabled?: boolean;
    isInline?: boolean;
    isLoading?: boolean;
    isSidebarOpen?: boolean;
    itemID?: string;
    itemProp?: string;
    itemRef?: string;
    itemScope?: boolean;
    itemType?: string;
    key?: Key;
    keyParams?: string;
    keyType?: string;
    kind?: string;
    label?: string;
    lang?: string;
    list?: string;
    loop?: boolean;
    low?: number;
    manifest?: string;
    marginHeight?: number;
    marginWidth?: number;
    max?: string | number;
    maxLength?: number;
    media?: string;
    mediaGroup?: string;
    method?: string;
    min?: string | number;
    minLength?: number;
    multiple?: boolean;
    muted?: boolean;
    name?: string;
    nonce?: string;
    noValidate?: boolean;
    onAbort?: ReactEventHandler<HTMLButtonElement>;
    onAbortCapture?: ReactEventHandler<HTMLButtonElement>;
    onAnimationEnd?: AnimationEventHandler<HTMLButtonElement>;
    onAnimationEndCapture?: AnimationEventHandler<HTMLButtonElement>;
    onAnimationIteration?: AnimationEventHandler<HTMLButtonElement>;
    onAnimationIterationCapture?: AnimationEventHandler<HTMLButtonElement>;
    onAnimationStart?: AnimationEventHandler<HTMLButtonElement>;
    onAnimationStartCapture?: AnimationEventHandler<HTMLButtonElement>;
    onAuxClick?: MouseEventHandler<HTMLButtonElement>;
    onAuxClickCapture?: MouseEventHandler<HTMLButtonElement>;
    onBeforeInput?: FormEventHandler<HTMLButtonElement>;
    onBeforeInputCapture?: FormEventHandler<HTMLButtonElement>;
    onBlur?: FocusEventHandler<HTMLButtonElement>;
    onBlurCapture?: FocusEventHandler<HTMLButtonElement>;
    onCanPlay?: ReactEventHandler<HTMLButtonElement>;
    onCanPlayCapture?: ReactEventHandler<HTMLButtonElement>;
    onCanPlayThrough?: ReactEventHandler<HTMLButtonElement>;
    onCanPlayThroughCapture?: ReactEventHandler<HTMLButtonElement>;
    onChange?: FormEventHandler<HTMLButtonElement>;
    onChangeCapture?: FormEventHandler<HTMLButtonElement>;
    onClick?: MouseEventHandler<HTMLButtonElement>;
    onClickCapture?: MouseEventHandler<HTMLButtonElement>;
    onCompositionEnd?: CompositionEventHandler<HTMLButtonElement>;
    onCompositionEndCapture?: CompositionEventHandler<HTMLButtonElement>;
    onCompositionStart?: CompositionEventHandler<HTMLButtonElement>;
    onCompositionStartCapture?: CompositionEventHandler<HTMLButtonElement>;
    onCompositionUpdate?: CompositionEventHandler<HTMLButtonElement>;
    onCompositionUpdateCapture?: CompositionEventHandler<HTMLButtonElement>;
    onContextMenu?: MouseEventHandler<HTMLButtonElement>;
    onContextMenuCapture?: MouseEventHandler<HTMLButtonElement>;
    onCopy?: ClipboardEventHandler<HTMLButtonElement>;
    onCopyCapture?: ClipboardEventHandler<HTMLButtonElement>;
    onCut?: ClipboardEventHandler<HTMLButtonElement>;
    onCutCapture?: ClipboardEventHandler<HTMLButtonElement>;
    onDoubleClick?: MouseEventHandler<HTMLButtonElement>;
    onDoubleClickCapture?: MouseEventHandler<HTMLButtonElement>;
    onDrag?: DragEventHandler<HTMLButtonElement>;
    onDragCapture?: DragEventHandler<HTMLButtonElement>;
    onDragEnd?: DragEventHandler<HTMLButtonElement>;
    onDragEndCapture?: DragEventHandler<HTMLButtonElement>;
    onDragEnter?: DragEventHandler<HTMLButtonElement>;
    onDragEnterCapture?: DragEventHandler<HTMLButtonElement>;
    onDragExit?: DragEventHandler<HTMLButtonElement>;
    onDragExitCapture?: DragEventHandler<HTMLButtonElement>;
    onDragLeave?: DragEventHandler<HTMLButtonElement>;
    onDragLeaveCapture?: DragEventHandler<HTMLButtonElement>;
    onDragOver?: DragEventHandler<HTMLButtonElement>;
    onDragOverCapture?: DragEventHandler<HTMLButtonElement>;
    onDragStart?: DragEventHandler<HTMLButtonElement>;
    onDragStartCapture?: DragEventHandler<HTMLButtonElement>;
    onDrop?: DragEventHandler<HTMLButtonElement>;
    onDropCapture?: DragEventHandler<HTMLButtonElement>;
    onDurationChange?: ReactEventHandler<HTMLButtonElement>;
    onDurationChangeCapture?: ReactEventHandler<HTMLButtonElement>;
    onEmptied?: ReactEventHandler<HTMLButtonElement>;
    onEmptiedCapture?: ReactEventHandler<HTMLButtonElement>;
    onEncrypted?: ReactEventHandler<HTMLButtonElement>;
    onEncryptedCapture?: ReactEventHandler<HTMLButtonElement>;
    onEnded?: ReactEventHandler<HTMLButtonElement>;
    onEndedCapture?: ReactEventHandler<HTMLButtonElement>;
    onError?: ReactEventHandler<HTMLButtonElement>;
    onErrorCapture?: ReactEventHandler<HTMLButtonElement>;
    onFocus?: FocusEventHandler<HTMLButtonElement>;
    onFocusCapture?: FocusEventHandler<HTMLButtonElement>;
    onGotPointerCapture?: PointerEventHandler<HTMLButtonElement>;
    onGotPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>;
    onInput?: FormEventHandler<HTMLButtonElement>;
    onInputCapture?: FormEventHandler<HTMLButtonElement>;
    onInvalid?: FormEventHandler<HTMLButtonElement>;
    onInvalidCapture?: FormEventHandler<HTMLButtonElement>;
    onKeyDown?: KeyboardEventHandler<HTMLButtonElement>;
    onKeyDownCapture?: KeyboardEventHandler<HTMLButtonElement>;
    onKeyPress?: KeyboardEventHandler<HTMLButtonElement>;
    onKeyPressCapture?: KeyboardEventHandler<HTMLButtonElement>;
    onKeyUp?: KeyboardEventHandler<HTMLButtonElement>;
    onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>;
    onLoad?: ReactEventHandler<HTMLButtonElement>;
    onLoadCapture?: ReactEventHandler<HTMLButtonElement>;
    onLoadedData?: ReactEventHandler<HTMLButtonElement>;
    onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>;
    onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>;
    onLoadedMetadataCapture?: ReactEventHandler<HTMLButtonElement>;
    onLoadStart?: ReactEventHandler<HTMLButtonElement>;
    onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>;
    onLostPointerCapture?: PointerEventHandler<HTMLButtonElement>;
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>;
    onMouseDown?: MouseEventHandler<HTMLButtonElement>;
    onMouseDownCapture?: MouseEventHandler<HTMLButtonElement>;
    onMouseEnter?: MouseEventHandler<HTMLButtonElement>;
    onMouseLeave?: MouseEventHandler<HTMLButtonElement>;
    onMouseMove?: MouseEventHandler<HTMLButtonElement>;
    onMouseMoveCapture?: MouseEventHandler<HTMLButtonElement>;
    onMouseOut?: MouseEventHandler<HTMLButtonElement>;
    onMouseOutCapture?: MouseEventHandler<HTMLButtonElement>;
    onMouseOver?: MouseEventHandler<HTMLButtonElement>;
    onMouseOverCapture?: MouseEventHandler<HTMLButtonElement>;
    onMouseUp?: MouseEventHandler<HTMLButtonElement>;
    onMouseUpCapture?: MouseEventHandler<HTMLButtonElement>;
    onPaste?: ClipboardEventHandler<HTMLButtonElement>;
    onPasteCapture?: ClipboardEventHandler<HTMLButtonElement>;
    onPause?: ReactEventHandler<HTMLButtonElement>;
    onPauseCapture?: ReactEventHandler<HTMLButtonElement>;
    onPlay?: ReactEventHandler<HTMLButtonElement>;
    onPlayCapture?: ReactEventHandler<HTMLButtonElement>;
    onPlaying?: ReactEventHandler<HTMLButtonElement>;
    onPlayingCapture?: ReactEventHandler<HTMLButtonElement>;
    onPointerCancel?: PointerEventHandler<HTMLButtonElement>;
    onPointerCancelCapture?: PointerEventHandler<HTMLButtonElement>;
    onPointerDown?: PointerEventHandler<HTMLButtonElement>;
    onPointerDownCapture?: PointerEventHandler<HTMLButtonElement>;
    onPointerEnter?: PointerEventHandler<HTMLButtonElement>;
    onPointerLeave?: PointerEventHandler<HTMLButtonElement>;
    onPointerMove?: PointerEventHandler<HTMLButtonElement>;
    onPointerMoveCapture?: PointerEventHandler<HTMLButtonElement>;
    onPointerOut?: PointerEventHandler<HTMLButtonElement>;
    onPointerOutCapture?: PointerEventHandler<HTMLButtonElement>;
    onPointerOver?: PointerEventHandler<HTMLButtonElement>;
    onPointerOverCapture?: PointerEventHandler<HTMLButtonElement>;
    onPointerUp?: PointerEventHandler<HTMLButtonElement>;
    onPointerUpCapture?: PointerEventHandler<HTMLButtonElement>;
    onProgress?: ReactEventHandler<HTMLButtonElement>;
    onProgressCapture?: ReactEventHandler<HTMLButtonElement>;
    onRateChange?: ReactEventHandler<HTMLButtonElement>;
    onRateChangeCapture?: ReactEventHandler<HTMLButtonElement>;
    onReset?: FormEventHandler<HTMLButtonElement>;
    onResetCapture?: FormEventHandler<HTMLButtonElement>;
    onResize?: ReactEventHandler<HTMLButtonElement>;
    onResizeCapture?: ReactEventHandler<HTMLButtonElement>;
    onScroll?: UIEventHandler<HTMLButtonElement>;
    onScrollCapture?: UIEventHandler<HTMLButtonElement>;
    onSeeked?: ReactEventHandler<HTMLButtonElement>;
    onSeekedCapture?: ReactEventHandler<HTMLButtonElement>;
    onSeeking?: ReactEventHandler<HTMLButtonElement>;
    onSeekingCapture?: ReactEventHandler<HTMLButtonElement>;
    onSelect?: ReactEventHandler<HTMLButtonElement>;
    onSelectCapture?: ReactEventHandler<HTMLButtonElement>;
    onSidebarToggle?: (() => void);
    onStalled?: ReactEventHandler<HTMLButtonElement>;
    onStalledCapture?: ReactEventHandler<HTMLButtonElement>;
    onSubmit?: FormEventHandler<HTMLButtonElement>;
    onSubmitCapture?: FormEventHandler<HTMLButtonElement>;
    onSuspend?: ReactEventHandler<HTMLButtonElement>;
    onSuspendCapture?: ReactEventHandler<HTMLButtonElement>;
    onTimeUpdate?: ReactEventHandler<HTMLButtonElement>;
    onTimeUpdateCapture?: ReactEventHandler<HTMLButtonElement>;
    onTouchCancel?: TouchEventHandler<HTMLButtonElement>;
    onTouchCancelCapture?: TouchEventHandler<HTMLButtonElement>;
    onTouchEnd?: TouchEventHandler<HTMLButtonElement>;
    onTouchEndCapture?: TouchEventHandler<HTMLButtonElement>;
    onTouchMove?: TouchEventHandler<HTMLButtonElement>;
    onTouchMoveCapture?: TouchEventHandler<HTMLButtonElement>;
    onTouchStart?: TouchEventHandler<HTMLButtonElement>;
    onTouchStartCapture?: TouchEventHandler<HTMLButtonElement>;
    onTransitionEnd?: TransitionEventHandler<HTMLButtonElement>;
    onTransitionEndCapture?: TransitionEventHandler<HTMLButtonElement>;
    onVolumeChange?: ReactEventHandler<HTMLButtonElement>;
    onVolumeChangeCapture?: ReactEventHandler<HTMLButtonElement>;
    onWaiting?: ReactEventHandler<HTMLButtonElement>;
    onWaitingCapture?: ReactEventHandler<HTMLButtonElement>;
    onWheel?: WheelEventHandler<HTMLButtonElement>;
    onWheelCapture?: WheelEventHandler<HTMLButtonElement>;
    open?: boolean;
    optimum?: number;
    ouiaId?: string | number;
    ouiaSafe?: boolean;
    pattern?: string;
    placeholder?: string;
    playsInline?: boolean;
    poster?: string;
    prefix?: string;
    preload?: string;
    property?: string;
    radioGroup?: string;
    readOnly?: boolean;
    rel?: string;
    required?: boolean;
    resource?: string;
    results?: number;
    rev?: string;
    reversed?: boolean;
    role?: AriaRole;
    rows?: number;
    rowSpan?: number;
    sandbox?: string;
    scope?: string;
    scoped?: boolean;
    scrolling?: string;
    seamless?: boolean;
    security?: string;
    selected?: boolean;
    shape?: string;
    size?: "default" | "lg" | "sm";
    sizes?: string;
    slot?: string;
    span?: number;
    spellCheck?: Booleanish;
    spinnerAriaLabel?: string;
    spinnerAriaLabelledBy?: string;
    spinnerAriaValueText?: string;
    src?: string;
    srcDoc?: string;
    srcLang?: string;
    srcSet?: string;
    start?: number;
    step?: string | number;
    style?: CSSProperties;
    summary?: string;
    suppressContentEditableWarning?: boolean;
    suppressHydrationWarning?: boolean;
    tabIndex?: number;
    target?: string;
    title?: string;
    translate?: "yes" | "no";
    type?: "button" | "reset" | "submit";
    typeof?: string;
    unselectable?: "off" | "on";
    useMap?: string;
    value?: string | number | readonly string[];
    variant?:
        | "link"
        | "danger"
        | "warning"
        | "primary"
        | "secondary"
        | "tertiary"
        | "plain"
        | "control";
    vocab?: string;
    width?: string | number;
    wmode?: string;
    wrap?: string;
}

Hierarchy (view full)

Properties

about? accept? acceptCharset? accessKey? action? allowFullScreen? allowTransparency? alt? aria-activedescendant? aria-atomic? aria-autocomplete? aria-braillelabel? aria-brailleroledescription? aria-busy? aria-checked? aria-colcount? aria-colindex? aria-colindextext? aria-colspan? aria-controls? aria-current? aria-describedby? aria-description? aria-details? aria-disabled? aria-dropeffect? aria-errormessage? aria-expanded? aria-flowto? aria-grabbed? aria-haspopup? aria-hidden? aria-invalid? aria-keyshortcuts? aria-label? aria-labelledby? aria-level? aria-live? aria-modal? aria-multiline? aria-multiselectable? aria-orientation? aria-owns? aria-placeholder? aria-posinset? aria-pressed? aria-readonly? aria-relevant? aria-required? aria-roledescription? aria-rowcount? aria-rowindex? aria-rowindextext? aria-rowspan? aria-selected? aria-setsize? aria-sort? aria-valuemax? aria-valuemin? aria-valuenow? aria-valuetext? as? async? autoCapitalize? autoComplete? autoCorrect? autoFocus? autoPlay? autoSave? capture? cellPadding? cellSpacing? challenge? charSet? checked? children? cite? classID? className? color? cols? colSpan? component? content? contentEditable? contextMenu? controls? coords? countOptions? crossOrigin? dangerouslySetInnerHTML? data? datatype? dateTime? default? defaultChecked? defaultValue? defer? dir? disabled? download? draggable? encType? enterKeyHint? form? formAction? formEncType? formMethod? formNoValidate? formTarget? frameBorder? headers? height? hidden? high? href? hrefLang? htmlFor? httpEquiv? icon? iconPosition? id? inlist? innerRef? inoperableEvents? inputMode? integrity? is? isActive? isAriaDisabled? isBlock? isDanger? isDisabled? isInline? isLoading? isSidebarOpen? itemID? itemProp? itemRef? itemScope? itemType? key? keyParams? keyType? kind? label? lang? list? loop? low? manifest? marginHeight? marginWidth? max? maxLength? media? mediaGroup? method? min? minLength? multiple? muted? name? nonce? noValidate? onAbort? onAbortCapture? onAnimationEnd? onAnimationEndCapture? onAnimationIteration? onAnimationIterationCapture? onAnimationStart? onAnimationStartCapture? onAuxClick? onAuxClickCapture? onBeforeInput? onBeforeInputCapture? onBlur? onBlurCapture? onCanPlay? onCanPlayCapture? onCanPlayThrough? onCanPlayThroughCapture? onChange? onChangeCapture? onClick? onClickCapture? onCompositionEnd? onCompositionEndCapture? onCompositionStart? onCompositionStartCapture? onCompositionUpdate? onCompositionUpdateCapture? onContextMenu? onContextMenuCapture? onCopy? onCopyCapture? onCut? onCutCapture? onDoubleClick? onDoubleClickCapture? onDrag? onDragCapture? onDragEnd? onDragEndCapture? onDragEnter? onDragEnterCapture? onDragExit? onDragExitCapture? onDragLeave? onDragLeaveCapture? onDragOver? onDragOverCapture? onDragStart? onDragStartCapture? onDrop? onDropCapture? onDurationChange? onDurationChangeCapture? onEmptied? onEmptiedCapture? onEncrypted? onEncryptedCapture? onEnded? onEndedCapture? onError? onErrorCapture? onFocus? onFocusCapture? onGotPointerCapture? onGotPointerCaptureCapture? onInput? onInputCapture? onInvalid? onInvalidCapture? onKeyDown? onKeyDownCapture? onKeyPress? onKeyPressCapture? onKeyUp? onKeyUpCapture? onLoad? onLoadCapture? onLoadedData? onLoadedDataCapture? onLoadedMetadata? onLoadedMetadataCapture? onLoadStart? onLoadStartCapture? onLostPointerCapture? onLostPointerCaptureCapture? onMouseDown? onMouseDownCapture? onMouseEnter? onMouseLeave? onMouseMove? onMouseMoveCapture? onMouseOut? onMouseOutCapture? onMouseOver? onMouseOverCapture? onMouseUp? onMouseUpCapture? onPaste? onPasteCapture? onPause? onPauseCapture? onPlay? onPlayCapture? onPlaying? onPlayingCapture? onPointerCancel? onPointerCancelCapture? onPointerDown? onPointerDownCapture? onPointerEnter? onPointerLeave? onPointerMove? onPointerMoveCapture? onPointerOut? onPointerOutCapture? onPointerOver? onPointerOverCapture? onPointerUp? onPointerUpCapture? onProgress? onProgressCapture? onRateChange? onRateChangeCapture? onReset? onResetCapture? onResize? onResizeCapture? onScroll? onScrollCapture? onSeeked? onSeekedCapture? onSeeking? onSeekingCapture? onSelect? onSelectCapture? onSidebarToggle? onStalled? onStalledCapture? onSubmit? onSubmitCapture? onSuspend? onSuspendCapture? onTimeUpdate? onTimeUpdateCapture? onTouchCancel? onTouchCancelCapture? onTouchEnd? onTouchEndCapture? onTouchMove? onTouchMoveCapture? onTouchStart? onTouchStartCapture? onTransitionEnd? onTransitionEndCapture? onVolumeChange? onVolumeChangeCapture? onWaiting? onWaitingCapture? onWheel? onWheelCapture? open? optimum? ouiaId? ouiaSafe? pattern? placeholder? playsInline? poster? prefix? preload? property? radioGroup? readOnly? rel? required? resource? results? rev? reversed? role? rows? rowSpan? sandbox? scope? scoped? scrolling? seamless? security? selected? shape? size? sizes? slot? span? spellCheck? spinnerAriaLabel? spinnerAriaLabelledBy? spinnerAriaValueText? src? srcDoc? srcLang? srcSet? start? step? style? summary? suppressContentEditableWarning? suppressHydrationWarning? tabIndex? target? title? translate? type? typeof? unselectable? useMap? value? variant? vocab? width? wmode? wrap?

Properties

Optionalabout

about?: string

Optionalaccept

accept?: string

OptionalacceptCharset

acceptCharset?: string

OptionalaccessKey

accessKey?: string

Optionalaction

action?: string

OptionalallowFullScreen

allowFullScreen?: boolean

OptionalallowTransparency

allowTransparency?: boolean

Optionalalt

alt?: string

Optionalaria-activedescendant

aria-activedescendant?: string

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

Optionalaria-atomic

aria-atomic?: Booleanish

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.

Optionalaria-autocomplete

aria-autocomplete?:
    | "list"
    | "inline"
    | "none"
    | "both"

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.

Optionalaria-braillelabel

aria-braillelabel?: string

Defines a string value that labels the current element, which is intended to be converted into Braille.

See

aria-label.

Optionalaria-brailleroledescription

aria-brailleroledescription?: string

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

See

aria-roledescription.

Optionalaria-busy

aria-busy?: Booleanish

Optionalaria-checked

aria-checked?:
    | boolean
    | "true"
    | "false"
    | "mixed"

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

See

  • aria-pressed
  • aria-selected.

Optionalaria-colcount

aria-colcount?: number

Defines the total number of columns in a table, grid, or treegrid.

See

aria-colindex.

Optionalaria-colindex

aria-colindex?: number

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

See

  • aria-colcount
  • aria-colspan.

Optionalaria-colindextext

aria-colindextext?: string

Defines a human readable text alternative of aria-colindex.

See

aria-rowindextext.

Optionalaria-colspan

aria-colspan?: number

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

See

  • aria-colindex
  • aria-rowspan.

Optionalaria-controls

aria-controls?: string

Identifies the element (or elements) whose contents or presence are controlled by the current element.

See

aria-owns.

Optionalaria-current

aria-current?:
    | boolean
    | "step"
    | "time"
    | "location"
    | "true"
    | "false"
    | "page"
    | "date"

Indicates the element that represents the current item within a container or set of related elements.

Optionalaria-describedby

aria-describedby?: string

Identifies the element (or elements) that describes the object.

See

aria-labelledby

Optionalaria-description

aria-description?: string

Defines a string value that describes or annotates the current element.

See

related aria-describedby.

Optionalaria-details

aria-details?: string

Identifies the element that provides a detailed, extended description for the object.

See

aria-describedby.

Optionalaria-disabled

aria-disabled?: Booleanish

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

See

  • aria-hidden
  • aria-readonly.

Optionalaria-dropeffect

aria-dropeffect?:
    | "link"
    | "copy"
    | "move"
    | "none"
    | "execute"
    | "popup"

Indicates what functions can be performed when a dragged object is released on the drop target.

Deprecated

in ARIA 1.1

Optionalaria-errormessage

aria-errormessage?: string

Identifies the element that provides an error message for the object.

See

  • aria-invalid
  • aria-describedby.

Optionalaria-expanded

aria-expanded?: Booleanish

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

Optionalaria-flowto

aria-flowto?: string

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.

Optionalaria-grabbed

aria-grabbed?: Booleanish

Indicates an element's "grabbed" state in a drag-and-drop operation.

Deprecated

in ARIA 1.1

Optionalaria-haspopup

aria-haspopup?:
    | boolean
    | "dialog"
    | "menu"
    | "grid"
    | "true"
    | "false"
    | "listbox"
    | "tree"

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

Optionalaria-hidden

aria-hidden?: Booleanish

Indicates whether the element is exposed to an accessibility API.

See

aria-disabled.

Optionalaria-invalid

aria-invalid?:
    | boolean
    | "true"
    | "false"
    | "grammar"
    | "spelling"

Indicates the entered value does not conform to the format expected by the application.

See

aria-errormessage.

Optionalaria-keyshortcuts

aria-keyshortcuts?: string

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

Optionalaria-label

aria-label?: string

Adds accessible text to the button.

Optionalaria-labelledby

aria-labelledby?: string

Identifies the element (or elements) that labels the current element.

See

aria-describedby.

Optionalaria-level

aria-level?: number

Defines the hierarchical level of an element within a structure.

Optionalaria-live

aria-live?: "off" | "assertive" | "polite"

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.

Optionalaria-modal

aria-modal?: Booleanish

Indicates whether an element is modal when displayed.

Optionalaria-multiline

aria-multiline?: Booleanish

Indicates whether a text box accepts multiple lines of input or only a single line.

Optionalaria-multiselectable

aria-multiselectable?: Booleanish

Indicates that the user may select more than one item from the current selectable descendants.

Optionalaria-orientation

aria-orientation?: "horizontal" | "vertical"

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

Optionalaria-owns

aria-owns?: string

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.

See

aria-controls.

Optionalaria-placeholder

aria-placeholder?: string

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.

Optionalaria-posinset

aria-posinset?: number

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.

See

aria-setsize.

Optionalaria-pressed

aria-pressed?:
    | boolean
    | "true"
    | "false"
    | "mixed"

Indicates the current "pressed" state of toggle buttons.

See

  • aria-checked
  • aria-selected.

Optionalaria-readonly

aria-readonly?: Booleanish

Indicates that the element is not editable, but is otherwise operable.

See

aria-disabled.

Optionalaria-relevant

aria-relevant?:
    | "text"
    | "additions"
    | "additions removals"
    | "additions text"
    | "all"
    | "removals"
    | "removals additions"
    | "removals text"
    | "text additions"
    | "text removals"

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

See

aria-atomic.

Optionalaria-required

aria-required?: Booleanish

Indicates that user input is required on the element before a form may be submitted.

Optionalaria-roledescription

aria-roledescription?: string

Defines a human-readable, author-localized description for the role of an element.

Optionalaria-rowcount

aria-rowcount?: number

Defines the total number of rows in a table, grid, or treegrid.

See

aria-rowindex.

Optionalaria-rowindex

aria-rowindex?: number

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

See

  • aria-rowcount
  • aria-rowspan.

Optionalaria-rowindextext

aria-rowindextext?: string

Defines a human readable text alternative of aria-rowindex.

See

aria-colindextext.

Optionalaria-rowspan

aria-rowspan?: number

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

See

  • aria-rowindex
  • aria-colspan.

Optionalaria-selected

aria-selected?: Booleanish

Indicates the current "selected" state of various widgets.

See

  • aria-checked
  • aria-pressed.

Optionalaria-setsize

aria-setsize?: number

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.

See

aria-posinset.

Optionalaria-sort

aria-sort?:
    | "none"
    | "ascending"
    | "descending"
    | "other"

Indicates if items in a table or grid are sorted in ascending or descending order.

Optionalaria-valuemax

aria-valuemax?: number

Defines the maximum allowed value for a range widget.

Optionalaria-valuemin

aria-valuemin?: number

Defines the minimum allowed value for a range widget.

Optionalaria-valuenow

aria-valuenow?: number

Defines the current value for a range widget.

See

aria-valuetext.

Optionalaria-valuetext

aria-valuetext?: string

Defines the human readable text alternative of aria-valuenow for a range widget.

Optionalas

as?: string

Optionalasync

async?: boolean

OptionalautoCapitalize

autoCapitalize?:
    | string & {}
    | "none"
    | "off"
    | "on"
    | "sentences"
    | "words"
    | "characters"

OptionalautoComplete

autoComplete?: string

OptionalautoCorrect

autoCorrect?: string

OptionalautoFocus

autoFocus?: boolean

OptionalautoPlay

autoPlay?: boolean

OptionalautoSave

autoSave?: string

Optionalcapture

capture?: boolean | "user" | "environment"

OptionalcellPadding

cellPadding?: string | number

OptionalcellSpacing

cellSpacing?: string | number

Optionalchallenge

challenge?: string

OptionalcharSet

charSet?: string

Optionalchecked

checked?: boolean

Optionalchildren

children?: ReactNode

Content of the page toggle button

Optionalcite

cite?: string

OptionalclassID

classID?: string

OptionalclassName

className?: string

Additional classes added to the button

Optionalcolor

color?: string

Optionalcols

cols?: number

OptionalcolSpan

colSpan?: number

Optionalcomponent

component?:
    | "symbol"
    | "object"
    | ComponentClass<any, any>
    | FunctionComponent<any>
    | "search"
    | "big"
    | "link"
    | "small"
    | "sub"
    | "sup"
    | "div"
    | "ul"
    | "style"
    | "h1"
    | "li"
    | "cite"
    | "data"
    | "form"
    | "label"
    | "pattern"
    | "span"
    | "summary"
    | "slot"
    | "title"
    | "a"
    | "abbr"
    | "address"
    | "area"
    | "article"
    | "aside"
    | "audio"
    | "b"
    | "base"
    | "bdi"
    | "bdo"
    | "blockquote"
    | "body"
    | "br"
    | "button"
    | "canvas"
    | "caption"
    | "code"
    | "col"
    | "colgroup"
    | "datalist"
    | "dd"
    | "del"
    | "details"
    | "dfn"
    | "dialog"
    | "dl"
    | "dt"
    | "em"
    | "embed"
    | "fieldset"
    | "figcaption"
    | "figure"
    | "footer"
    | "h2"
    | "h3"
    | "h4"
    | "h5"
    | "h6"
    | "head"
    | "header"
    | "hgroup"
    | "hr"
    | "html"
    | "i"
    | "iframe"
    | "img"
    | "input"
    | "ins"
    | "kbd"
    | "legend"
    | "main"
    | "map"
    | "mark"
    | "menu"
    | "meta"
    | "meter"
    | "nav"
    | "noscript"
    | "ol"
    | "optgroup"
    | "option"
    | "output"
    | "p"
    | "picture"
    | "pre"
    | "progress"
    | "q"
    | "rp"
    | "rt"
    | "ruby"
    | "s"
    | "samp"
    | "script"
    | "section"
    | "select"
    | "source"
    | "strong"
    | "table"
    | "tbody"
    | "td"
    | "template"
    | "textarea"
    | "tfoot"
    | "th"
    | "thead"
    | "time"
    | "tr"
    | "track"
    | "u"
    | "var"
    | "video"
    | "wbr"
    | "filter"
    | "set"
    | "center"
    | "text"
    | "keygen"
    | "menuitem"
    | "param"
    | "webview"
    | "animate"
    | "circle"
    | "clipPath"
    | "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"
    | "g"
    | "image"
    | "line"
    | "linearGradient"
    | "marker"
    | "mask"
    | "metadata"
    | "path"
    | "polygon"
    | "polyline"
    | "radialGradient"
    | "rect"
    | "stop"
    | "svg"
    | "switch"
    | "textPath"
    | "tspan"
    | "use"
    | "view"
    | "noindex"
    | "animateMotion"
    | "animateTransform"
    | "mpath"

Sets the base component to render. defaults to button

Optionalcontent

content?: string

OptionalcontentEditable

contentEditable?: "inherit" | Booleanish | "plaintext-only"

OptionalcontextMenu

contextMenu?: string

Optionalcontrols

controls?: boolean

Optionalcoords

coords?: string

OptionalcountOptions

countOptions?: BadgeCountObject

Adds count number to button

OptionalcrossOrigin

crossOrigin?: CrossOrigin

OptionaldangerouslySetInnerHTML

dangerouslySetInnerHTML?: {
    __html: string | TrustedHTML;
}

Optionaldata

data?: string

Optionaldatatype

datatype?: string

OptionaldateTime

dateTime?: string

Optionaldefault

default?: boolean

OptionaldefaultChecked

defaultChecked?: boolean

OptionaldefaultValue

defaultValue?: string | number | readonly string[]

Optionaldefer

defer?: boolean

Optionaldir

dir?: string

Optionaldisabled

disabled?: boolean

Optionaldownload

download?: any

Optionaldraggable

draggable?: Booleanish

OptionalencType

encType?: string

OptionalenterKeyHint

enterKeyHint?:
    | "search"
    | "enter"
    | "done"
    | "go"
    | "next"
    | "previous"
    | "send"

Optionalform

form?: string

OptionalformAction

formAction?: string

OptionalformEncType

formEncType?: string

OptionalformMethod

formMethod?: string

OptionalformNoValidate

formNoValidate?: boolean

OptionalformTarget

formTarget?: string

OptionalframeBorder

frameBorder?: string | number

Optionalheaders

headers?: string

Optionalheight

height?: string | number

Optionalhidden

hidden?: boolean

Optionalhigh

high?: number

Optionalhref

href?: string

OptionalhrefLang

hrefLang?: string

OptionalhtmlFor

htmlFor?: string

OptionalhttpEquiv

httpEquiv?: string

Optionalicon

icon?: ReactNode

Icon for the button. Usable by all variants except for plain.

OptionaliconPosition

iconPosition?:
    | "start"
    | "right"
    | "end"
    | "left"

Sets position of the icon. Note: "left" and "right" are deprecated. Use "start" and "end" instead

Optionalid

id?: string

Button id

Optionalinlist

inlist?: any

OptionalinnerRef

innerRef?: Ref<any>

Hide

Forwarded ref

OptionalinoperableEvents

inoperableEvents?: string[]

Events to prevent when the button is in an aria-disabled state

OptionalinputMode

inputMode?:
    | "search"
    | "text"
    | "none"
    | "tel"
    | "url"
    | "email"
    | "numeric"
    | "decimal"

Hints at the type of data that might be entered by the user while editing the element or its contents

See

https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

Optionalintegrity

integrity?: string

Optionalis

is?: string

Specify that a standard HTML element should behave like a defined custom built-in element

See

https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

OptionalisActive

isActive?: boolean

Adds active styling to button.

OptionalisAriaDisabled

isAriaDisabled?: boolean

Adds disabled styling and communicates that the button is disabled using the aria-disabled html attribute

OptionalisBlock

isBlock?: boolean

Adds block styling to button

OptionalisDanger

isDanger?: boolean

Adds danger styling to secondary or link button variants

OptionalisDisabled

isDisabled?: boolean

Adds disabled styling and disables the button using the disabled html attribute

OptionalisInline

isInline?: boolean

Adds inline styling to a link button

OptionalisLoading

isLoading?: boolean

Adds progress styling to button

OptionalisSidebarOpen

isSidebarOpen?: boolean

True if the sidebar is shown

OptionalitemID

itemID?: string

OptionalitemProp

itemProp?: string

OptionalitemRef

itemRef?: string

OptionalitemScope

itemScope?: boolean

OptionalitemType

itemType?: string

Optionalkey

key?: Key

OptionalkeyParams

keyParams?: string

OptionalkeyType

keyType?: string

Optionalkind

kind?: string

Optionallabel

label?: string

Optionallang

lang?: string

Optionallist

list?: string

Optionalloop

loop?: boolean

Optionallow

low?: number

Optionalmanifest

manifest?: string

OptionalmarginHeight

marginHeight?: number

OptionalmarginWidth

marginWidth?: number

Optionalmax

max?: string | number

OptionalmaxLength

maxLength?: number

Optionalmedia

media?: string

OptionalmediaGroup

mediaGroup?: string

Optionalmethod

method?: string

Optionalmin

min?: string | number

OptionalminLength

minLength?: number

Optionalmultiple

multiple?: boolean

Optionalmuted

muted?: boolean

Optionalname

name?: string

Optionalnonce

nonce?: string

OptionalnoValidate

noValidate?: boolean

OptionalonAbort

onAbort?: ReactEventHandler<HTMLButtonElement>

OptionalonAbortCapture

onAbortCapture?: ReactEventHandler<HTMLButtonElement>

OptionalonAnimationEnd

onAnimationEnd?: AnimationEventHandler<HTMLButtonElement>

OptionalonAnimationEndCapture

onAnimationEndCapture?: AnimationEventHandler<HTMLButtonElement>

OptionalonAnimationIteration

onAnimationIteration?: AnimationEventHandler<HTMLButtonElement>

OptionalonAnimationIterationCapture

onAnimationIterationCapture?: AnimationEventHandler<HTMLButtonElement>

OptionalonAnimationStart

onAnimationStart?: AnimationEventHandler<HTMLButtonElement>

OptionalonAnimationStartCapture

onAnimationStartCapture?: AnimationEventHandler<HTMLButtonElement>

OptionalonAuxClick

onAuxClick?: MouseEventHandler<HTMLButtonElement>

OptionalonAuxClickCapture

onAuxClickCapture?: MouseEventHandler<HTMLButtonElement>

OptionalonBeforeInput

onBeforeInput?: FormEventHandler<HTMLButtonElement>

OptionalonBeforeInputCapture

onBeforeInputCapture?: FormEventHandler<HTMLButtonElement>

OptionalonBlur

onBlur?: FocusEventHandler<HTMLButtonElement>

OptionalonBlurCapture

onBlurCapture?: FocusEventHandler<HTMLButtonElement>

OptionalonCanPlay

onCanPlay?: ReactEventHandler<HTMLButtonElement>

OptionalonCanPlayCapture

onCanPlayCapture?: ReactEventHandler<HTMLButtonElement>

OptionalonCanPlayThrough

onCanPlayThrough?: ReactEventHandler<HTMLButtonElement>

OptionalonCanPlayThroughCapture

onCanPlayThroughCapture?: ReactEventHandler<HTMLButtonElement>

OptionalonChange

onChange?: FormEventHandler<HTMLButtonElement>

OptionalonChangeCapture

onChangeCapture?: FormEventHandler<HTMLButtonElement>

OptionalonClick

onClick?: MouseEventHandler<HTMLButtonElement>

OptionalonClickCapture

onClickCapture?: MouseEventHandler<HTMLButtonElement>

OptionalonCompositionEnd

onCompositionEnd?: CompositionEventHandler<HTMLButtonElement>

OptionalonCompositionEndCapture

onCompositionEndCapture?: CompositionEventHandler<HTMLButtonElement>

OptionalonCompositionStart

onCompositionStart?: CompositionEventHandler<HTMLButtonElement>

OptionalonCompositionStartCapture

onCompositionStartCapture?: CompositionEventHandler<HTMLButtonElement>

OptionalonCompositionUpdate

onCompositionUpdate?: CompositionEventHandler<HTMLButtonElement>

OptionalonCompositionUpdateCapture

onCompositionUpdateCapture?: CompositionEventHandler<HTMLButtonElement>

OptionalonContextMenu

onContextMenu?: MouseEventHandler<HTMLButtonElement>

OptionalonContextMenuCapture

onContextMenuCapture?: MouseEventHandler<HTMLButtonElement>

OptionalonCopy

onCopy?: ClipboardEventHandler<HTMLButtonElement>

OptionalonCopyCapture

onCopyCapture?: ClipboardEventHandler<HTMLButtonElement>

OptionalonCut

onCut?: ClipboardEventHandler<HTMLButtonElement>

OptionalonCutCapture

onCutCapture?: ClipboardEventHandler<HTMLButtonElement>

OptionalonDoubleClick

onDoubleClick?: MouseEventHandler<HTMLButtonElement>

OptionalonDoubleClickCapture

onDoubleClickCapture?: MouseEventHandler<HTMLButtonElement>

OptionalonDrag

onDrag?: DragEventHandler<HTMLButtonElement>

OptionalonDragCapture

onDragCapture?: DragEventHandler<HTMLButtonElement>

OptionalonDragEnd

onDragEnd?: DragEventHandler<HTMLButtonElement>

OptionalonDragEndCapture

onDragEndCapture?: DragEventHandler<HTMLButtonElement>

OptionalonDragEnter

onDragEnter?: DragEventHandler<HTMLButtonElement>

OptionalonDragEnterCapture

onDragEnterCapture?: DragEventHandler<HTMLButtonElement>

OptionalonDragExit

onDragExit?: DragEventHandler<HTMLButtonElement>

OptionalonDragExitCapture

onDragExitCapture?: DragEventHandler<HTMLButtonElement>

OptionalonDragLeave

onDragLeave?: DragEventHandler<HTMLButtonElement>

OptionalonDragLeaveCapture

onDragLeaveCapture?: DragEventHandler<HTMLButtonElement>

OptionalonDragOver

onDragOver?: DragEventHandler<HTMLButtonElement>

OptionalonDragOverCapture

onDragOverCapture?: DragEventHandler<HTMLButtonElement>

OptionalonDragStart

onDragStart?: DragEventHandler<HTMLButtonElement>

OptionalonDragStartCapture

onDragStartCapture?: DragEventHandler<HTMLButtonElement>

OptionalonDrop

onDrop?: DragEventHandler<HTMLButtonElement>

OptionalonDropCapture

onDropCapture?: DragEventHandler<HTMLButtonElement>

OptionalonDurationChange

onDurationChange?: ReactEventHandler<HTMLButtonElement>

OptionalonDurationChangeCapture

onDurationChangeCapture?: ReactEventHandler<HTMLButtonElement>

OptionalonEmptied

onEmptied?: ReactEventHandler<HTMLButtonElement>

OptionalonEmptiedCapture

onEmptiedCapture?: ReactEventHandler<HTMLButtonElement>

OptionalonEncrypted

onEncrypted?: ReactEventHandler<HTMLButtonElement>

OptionalonEncryptedCapture

onEncryptedCapture?: ReactEventHandler<HTMLButtonElement>

OptionalonEnded

onEnded?: ReactEventHandler<HTMLButtonElement>

OptionalonEndedCapture

onEndedCapture?: ReactEventHandler<HTMLButtonElement>

OptionalonError

onError?: ReactEventHandler<HTMLButtonElement>

OptionalonErrorCapture

onErrorCapture?: ReactEventHandler<HTMLButtonElement>

OptionalonFocus

onFocus?: FocusEventHandler<HTMLButtonElement>

OptionalonFocusCapture

onFocusCapture?: FocusEventHandler<HTMLButtonElement>

OptionalonGotPointerCapture

onGotPointerCapture?: PointerEventHandler<HTMLButtonElement>

OptionalonGotPointerCaptureCapture

onGotPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>

OptionalonInput

onInput?: FormEventHandler<HTMLButtonElement>

OptionalonInputCapture

onInputCapture?: FormEventHandler<HTMLButtonElement>

OptionalonInvalid

onInvalid?: FormEventHandler<HTMLButtonElement>

OptionalonInvalidCapture

onInvalidCapture?: FormEventHandler<HTMLButtonElement>

OptionalonKeyDown

onKeyDown?: KeyboardEventHandler<HTMLButtonElement>

OptionalonKeyDownCapture

onKeyDownCapture?: KeyboardEventHandler<HTMLButtonElement>

OptionalonKeyPress

onKeyPress?: KeyboardEventHandler<HTMLButtonElement>

Deprecated

Use onKeyUp or onKeyDown instead

OptionalonKeyPressCapture

onKeyPressCapture?: KeyboardEventHandler<HTMLButtonElement>

Deprecated

Use onKeyUpCapture or onKeyDownCapture instead

OptionalonKeyUp

onKeyUp?: KeyboardEventHandler<HTMLButtonElement>

OptionalonKeyUpCapture

onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>

OptionalonLoad

onLoad?: ReactEventHandler<HTMLButtonElement>

OptionalonLoadCapture

onLoadCapture?: ReactEventHandler<HTMLButtonElement>

OptionalonLoadedData

onLoadedData?: ReactEventHandler<HTMLButtonElement>

OptionalonLoadedDataCapture

onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>

OptionalonLoadedMetadata

onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>

OptionalonLoadedMetadataCapture

onLoadedMetadataCapture?: ReactEventHandler<HTMLButtonElement>

OptionalonLoadStart

onLoadStart?: ReactEventHandler<HTMLButtonElement>

OptionalonLoadStartCapture

onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>

OptionalonLostPointerCapture

onLostPointerCapture?: PointerEventHandler<HTMLButtonElement>

OptionalonLostPointerCaptureCapture

onLostPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>

OptionalonMouseDown

onMouseDown?: MouseEventHandler<HTMLButtonElement>

OptionalonMouseDownCapture

onMouseDownCapture?: MouseEventHandler<HTMLButtonElement>

OptionalonMouseEnter

onMouseEnter?: MouseEventHandler<HTMLButtonElement>

OptionalonMouseLeave

onMouseLeave?: MouseEventHandler<HTMLButtonElement>

OptionalonMouseMove

onMouseMove?: MouseEventHandler<HTMLButtonElement>

OptionalonMouseMoveCapture

onMouseMoveCapture?: MouseEventHandler<HTMLButtonElement>

OptionalonMouseOut

onMouseOut?: MouseEventHandler<HTMLButtonElement>

OptionalonMouseOutCapture

onMouseOutCapture?: MouseEventHandler<HTMLButtonElement>

OptionalonMouseOver

onMouseOver?: MouseEventHandler<HTMLButtonElement>

OptionalonMouseOverCapture

onMouseOverCapture?: MouseEventHandler<HTMLButtonElement>

OptionalonMouseUp

onMouseUp?: MouseEventHandler<HTMLButtonElement>

OptionalonMouseUpCapture

onMouseUpCapture?: MouseEventHandler<HTMLButtonElement>

OptionalonPaste

onPaste?: ClipboardEventHandler<HTMLButtonElement>

OptionalonPasteCapture

onPasteCapture?: ClipboardEventHandler<HTMLButtonElement>

OptionalonPause

onPause?: ReactEventHandler<HTMLButtonElement>

OptionalonPauseCapture

onPauseCapture?: ReactEventHandler<HTMLButtonElement>

OptionalonPlay

onPlay?: ReactEventHandler<HTMLButtonElement>

OptionalonPlayCapture

onPlayCapture?: ReactEventHandler<HTMLButtonElement>

OptionalonPlaying

onPlaying?: ReactEventHandler<HTMLButtonElement>

OptionalonPlayingCapture

onPlayingCapture?: ReactEventHandler<HTMLButtonElement>

OptionalonPointerCancel

onPointerCancel?: PointerEventHandler<HTMLButtonElement>

OptionalonPointerCancelCapture

onPointerCancelCapture?: PointerEventHandler<HTMLButtonElement>

OptionalonPointerDown

onPointerDown?: PointerEventHandler<HTMLButtonElement>

OptionalonPointerDownCapture

onPointerDownCapture?: PointerEventHandler<HTMLButtonElement>

OptionalonPointerEnter

onPointerEnter?: PointerEventHandler<HTMLButtonElement>

OptionalonPointerLeave

onPointerLeave?: PointerEventHandler<HTMLButtonElement>

OptionalonPointerMove

onPointerMove?: PointerEventHandler<HTMLButtonElement>

OptionalonPointerMoveCapture

onPointerMoveCapture?: PointerEventHandler<HTMLButtonElement>

OptionalonPointerOut

onPointerOut?: PointerEventHandler<HTMLButtonElement>

OptionalonPointerOutCapture

onPointerOutCapture?: PointerEventHandler<HTMLButtonElement>

OptionalonPointerOver

onPointerOver?: PointerEventHandler<HTMLButtonElement>

OptionalonPointerOverCapture

onPointerOverCapture?: PointerEventHandler<HTMLButtonElement>

OptionalonPointerUp

onPointerUp?: PointerEventHandler<HTMLButtonElement>

OptionalonPointerUpCapture

onPointerUpCapture?: PointerEventHandler<HTMLButtonElement>

OptionalonProgress

onProgress?: ReactEventHandler<HTMLButtonElement>

OptionalonProgressCapture

onProgressCapture?: ReactEventHandler<HTMLButtonElement>

OptionalonRateChange

onRateChange?: ReactEventHandler<HTMLButtonElement>

OptionalonRateChangeCapture

onRateChangeCapture?: ReactEventHandler<HTMLButtonElement>

OptionalonReset

onReset?: FormEventHandler<HTMLButtonElement>

OptionalonResetCapture

onResetCapture?: FormEventHandler<HTMLButtonElement>

OptionalonResize

onResize?: ReactEventHandler<HTMLButtonElement>

OptionalonResizeCapture

onResizeCapture?: ReactEventHandler<HTMLButtonElement>

OptionalonScroll

onScroll?: UIEventHandler<HTMLButtonElement>

OptionalonScrollCapture

onScrollCapture?: UIEventHandler<HTMLButtonElement>

OptionalonSeeked

onSeeked?: ReactEventHandler<HTMLButtonElement>

OptionalonSeekedCapture

onSeekedCapture?: ReactEventHandler<HTMLButtonElement>

OptionalonSeeking

onSeeking?: ReactEventHandler<HTMLButtonElement>

OptionalonSeekingCapture

onSeekingCapture?: ReactEventHandler<HTMLButtonElement>

OptionalonSelect

onSelect?: ReactEventHandler<HTMLButtonElement>

OptionalonSelectCapture

onSelectCapture?: ReactEventHandler<HTMLButtonElement>

OptionalonSidebarToggle

onSidebarToggle?: (() => void)

Callback function to handle the sidebar toggle button, managed by the Page component if the Page isManagedSidebar prop is set to true

OptionalonStalled

onStalled?: ReactEventHandler<HTMLButtonElement>

OptionalonStalledCapture

onStalledCapture?: ReactEventHandler<HTMLButtonElement>

OptionalonSubmit

onSubmit?: FormEventHandler<HTMLButtonElement>

OptionalonSubmitCapture

onSubmitCapture?: FormEventHandler<HTMLButtonElement>

OptionalonSuspend

onSuspend?: ReactEventHandler<HTMLButtonElement>

OptionalonSuspendCapture

onSuspendCapture?: ReactEventHandler<HTMLButtonElement>

OptionalonTimeUpdate

onTimeUpdate?: ReactEventHandler<HTMLButtonElement>

OptionalonTimeUpdateCapture

onTimeUpdateCapture?: ReactEventHandler<HTMLButtonElement>

OptionalonTouchCancel

onTouchCancel?: TouchEventHandler<HTMLButtonElement>

OptionalonTouchCancelCapture

onTouchCancelCapture?: TouchEventHandler<HTMLButtonElement>

OptionalonTouchEnd

onTouchEnd?: TouchEventHandler<HTMLButtonElement>

OptionalonTouchEndCapture

onTouchEndCapture?: TouchEventHandler<HTMLButtonElement>

OptionalonTouchMove

onTouchMove?: TouchEventHandler<HTMLButtonElement>

OptionalonTouchMoveCapture

onTouchMoveCapture?: TouchEventHandler<HTMLButtonElement>

OptionalonTouchStart

onTouchStart?: TouchEventHandler<HTMLButtonElement>

OptionalonTouchStartCapture

onTouchStartCapture?: TouchEventHandler<HTMLButtonElement>

OptionalonTransitionEnd

onTransitionEnd?: TransitionEventHandler<HTMLButtonElement>

OptionalonTransitionEndCapture

onTransitionEndCapture?: TransitionEventHandler<HTMLButtonElement>

OptionalonVolumeChange

onVolumeChange?: ReactEventHandler<HTMLButtonElement>

OptionalonVolumeChangeCapture

onVolumeChangeCapture?: ReactEventHandler<HTMLButtonElement>

OptionalonWaiting

onWaiting?: ReactEventHandler<HTMLButtonElement>

OptionalonWaitingCapture

onWaitingCapture?: ReactEventHandler<HTMLButtonElement>

OptionalonWheel

onWheel?: WheelEventHandler<HTMLButtonElement>

OptionalonWheelCapture

onWheelCapture?: WheelEventHandler<HTMLButtonElement>

Optionalopen

open?: boolean

Optionaloptimum

optimum?: number

OptionalouiaId

ouiaId?: string | number

Value to overwrite the randomly generated data-ouia-component-id.

OptionalouiaSafe

ouiaSafe?: boolean

Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false.

Optionalpattern

pattern?: string

Optionalplaceholder

placeholder?: string

OptionalplaysInline

playsInline?: boolean

Optionalposter

poster?: string

Optionalprefix

prefix?: string

Optionalpreload

preload?: string

Optionalproperty

property?: string

OptionalradioGroup

radioGroup?: string

OptionalreadOnly

readOnly?: boolean

Optionalrel

rel?: string

Optionalrequired

required?: boolean

Optionalresource

resource?: string

Optionalresults

results?: number

Optionalrev

rev?: string

Optionalreversed

reversed?: boolean

Optionalrole

role?: AriaRole

Optionalrows

rows?: number

OptionalrowSpan

rowSpan?: number

Optionalsandbox

sandbox?: string

Optionalscope

scope?: string

Optionalscoped

scoped?: boolean

Optionalscrolling

scrolling?: string

Optionalseamless

seamless?: boolean

Optionalsecurity

security?: string

Optionalselected

selected?: boolean

Optionalshape

shape?: string

Optionalsize

size?: "default" | "lg" | "sm"

Adds styling which affects the size of the button

Optionalsizes

sizes?: string

Optionalslot

slot?: string

Optionalspan

span?: number

OptionalspellCheck

spellCheck?: Booleanish

OptionalspinnerAriaLabel

spinnerAriaLabel?: string

Accessible label for the spinner to describe what is loading

OptionalspinnerAriaLabelledBy

spinnerAriaLabelledBy?: string

Id of element which describes what is being loaded

OptionalspinnerAriaValueText

spinnerAriaValueText?: string

Text describing that current loading status or progress

Optionalsrc

src?: string

OptionalsrcDoc

srcDoc?: string

OptionalsrcLang

srcLang?: string

OptionalsrcSet

srcSet?: string

Optionalstart

start?: number

Optionalstep

step?: string | number

Optionalstyle

style?: CSSProperties

Optionalsummary

summary?: string

OptionalsuppressContentEditableWarning

suppressContentEditableWarning?: boolean

OptionalsuppressHydrationWarning

suppressHydrationWarning?: boolean

OptionaltabIndex

tabIndex?: number

Sets the button tabindex.

Optionaltarget

target?: string

Optionaltitle

title?: string

Optionaltranslate

translate?: "yes" | "no"

Optionaltype

type?: "button" | "reset" | "submit"

Sets button type

Optionaltypeof

typeof?: string

Optionalunselectable

unselectable?: "off" | "on"

OptionaluseMap

useMap?: string

Optionalvalue

value?: string | number | readonly string[]

Optionalvariant

variant?:
    | "link"
    | "danger"
    | "warning"
    | "primary"
    | "secondary"
    | "tertiary"
    | "plain"
    | "control"

Adds button variant styles

Optionalvocab

vocab?: string

Optionalwidth

width?: string | number

Optionalwmode

wmode?: string

Optionalwrap

wrap?: string

Settings

Member Visibility

On This Page

Properties
aboutacceptacceptCharsetaccessKeyactionallowFullScreenallowTransparencyaltaria-activedescendantaria-atomicaria-autocompletearia-braillelabelaria-brailleroledescriptionaria-busyaria-checkedaria-colcountaria-colindexaria-colindextextaria-colspanaria-controlsaria-currentaria-describedbyaria-descriptionaria-detailsaria-disabledaria-dropeffectaria-errormessagearia-expandedaria-flowtoaria-grabbedaria-haspopuparia-hiddenaria-invalidaria-keyshortcutsaria-labelaria-labelledbyaria-levelaria-livearia-modalaria-multilinearia-multiselectablearia-orientationaria-ownsaria-placeholderaria-posinsetaria-pressedaria-readonlyaria-relevantaria-requiredaria-roledescriptionaria-rowcountaria-rowindexaria-rowindextextaria-rowspanaria-selectedaria-setsizearia-sortaria-valuemaxaria-valueminaria-valuenowaria-valuetextasasyncautoCapitalizeautoCompleteautoCorrectautoFocusautoPlayautoSavecapturecellPaddingcellSpacingchallengecharSetcheckedchildrenciteclassIDclassNamecolorcolscolSpancomponentcontentcontentEditablecontextMenucontrolscoordscountOptionscrossOrigindangerouslySetInnerHTMLdatadatatypedateTimedefaultdefaultCheckeddefaultValuedeferdirdisableddownloaddraggableencTypeenterKeyHintformformActionformEncTypeformMethodformNoValidateformTargetframeBorderheadersheighthiddenhighhrefhrefLanghtmlForhttpEquiviconiconPositionidinlistinnerRefinoperableEventsinputModeintegrityisisActiveisAriaDisabledisBlockisDangerisDisabledisInlineisLoadingisSidebarOpenitemIDitemPropitemRefitemScopeitemTypekeykeyParamskeyTypekindlabellanglistlooplowmanifestmarginHeightmarginWidthmaxmaxLengthmediamediaGroupmethodminminLengthmultiplemutednamenoncenoValidateonAbortonAbortCaptureonAnimationEndonAnimationEndCaptureonAnimationIterationonAnimationIterationCaptureonAnimationStartonAnimationStartCaptureonAuxClickonAuxClickCaptureonBeforeInputonBeforeInputCaptureonBluronBlurCaptureonCanPlayonCanPlayCaptureonCanPlayThroughonCanPlayThroughCaptureonChangeonChangeCaptureonClickonClickCaptureonCompositionEndonCompositionEndCaptureonCompositionStartonCompositionStartCaptureonCompositionUpdateonCompositionUpdateCaptureonContextMenuonContextMenuCaptureonCopyonCopyCaptureonCutonCutCaptureonDoubleClickonDoubleClickCaptureonDragonDragCaptureonDragEndonDragEndCaptureonDragEnteronDragEnterCaptureonDragExitonDragExitCaptureonDragLeaveonDragLeaveCaptureonDragOveronDragOverCaptureonDragStartonDragStartCaptureonDroponDropCaptureonDurationChangeonDurationChangeCaptureonEmptiedonEmptiedCaptureonEncryptedonEncryptedCaptureonEndedonEndedCaptureonErroronErrorCaptureonFocusonFocusCaptureonGotPointerCaptureonGotPointerCaptureCaptureonInputonInputCaptureonInvalidonInvalidCaptureonKeyDownonKeyDownCaptureonKeyPressonKeyPressCaptureonKeyUponKeyUpCaptureonLoadonLoadCaptureonLoadedDataonLoadedDataCaptureonLoadedMetadataonLoadedMetadataCaptureonLoadStartonLoadStartCaptureonLostPointerCaptureonLostPointerCaptureCaptureonMouseDownonMouseDownCaptureonMouseEnteronMouseLeaveonMouseMoveonMouseMoveCaptureonMouseOutonMouseOutCaptureonMouseOveronMouseOverCaptureonMouseUponMouseUpCaptureonPasteonPasteCaptureonPauseonPauseCaptureonPlayonPlayCaptureonPlayingonPlayingCaptureonPointerCancelonPointerCancelCaptureonPointerDownonPointerDownCaptureonPointerEnteronPointerLeaveonPointerMoveonPointerMoveCaptureonPointerOutonPointerOutCaptureonPointerOveronPointerOverCaptureonPointerUponPointerUpCaptureonProgressonProgressCaptureonRateChangeonRateChangeCaptureonResetonResetCaptureonResizeonResizeCaptureonScrollonScrollCaptureonSeekedonSeekedCaptureonSeekingonSeekingCaptureonSelectonSelectCaptureonSidebarToggleonStalledonStalledCaptureonSubmitonSubmitCaptureonSuspendonSuspendCaptureonTimeUpdateonTimeUpdateCaptureonTouchCancelonTouchCancelCaptureonTouchEndonTouchEndCaptureonTouchMoveonTouchMoveCaptureonTouchStartonTouchStartCaptureonTransitionEndonTransitionEndCaptureonVolumeChangeonVolumeChangeCaptureonWaitingonWaitingCaptureonWheelonWheelCaptureopenoptimumouiaIdouiaSafepatternplaceholderplaysInlineposterprefixpreloadpropertyradioGroupreadOnlyrelrequiredresourceresultsrevreversedrolerowsrowSpansandboxscopescopedscrollingseamlesssecurityselectedshapesizesizesslotspanspellCheckspinnerAriaLabelspinnerAriaLabelledByspinnerAriaValueTextsrcsrcDocsrcLangsrcSetstartstepstylesummarysuppressContentEditableWarningsuppressHydrationWarningtabIndextargettitletranslatetypetypeofunselectableuseMapvaluevariantvocabwidthwmodewrap