ControlBarButtonProps interface

Key to use for the Label component

labelKey?: string

Property Value

Icon to render when the button is not checked.

onRenderOffIcon?: IRenderFunction<IButtonProps>

Property Value

Icon to render when the button is checked.

onRenderOnIcon?: IRenderFunction<IButtonProps>

Property Value

Whether the label is displayed or not.

showLabel?: boolean

Property Value

Optional strings to override in component.

strings?: ControlBarButtonStrings

Property Value

Fluent styles, including extensions common to all ControlBarButtons.

styles?: IButtonStyles

Property Value

Id to use for the tooltip host.

tooltipId?: string

Property Value

about?: string

Property Value

Inherited From IButtonProps.about

accept?: string

Property Value

Inherited From IButtonProps.accept

acceptCharset?: string

Property Value

Inherited From IButtonProps.acceptCharset

accessKey?: string

Property Value

Inherited From IButtonProps.accessKey

action?: string

Property Value

Inherited From IButtonProps.action

Whether the button can have focus in disabled mode

allowDisabledFocus?: boolean

Property Value

Inherited From IButtonProps.allowDisabledFocus

allowFullScreen?: boolean

Property Value

Inherited From IButtonProps.allowFullScreen

allowTransparency?: boolean

Property Value

Inherited From IButtonProps.allowTransparency

alt?: string

Property Value

Inherited From IButtonProps.alt

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

aria-activedescendant?: string

Property Value

Inherited From IButtonProps.aria-activedescendant

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.

aria-atomic?: Booleanish

Property Value

Inherited From IButtonProps.aria-atomic

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.

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

Property Value

Inherited From IButtonProps.aria-autocomplete

Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

aria-busy?: Booleanish

Property Value

Inherited From IButtonProps.aria-busy

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

See aria-pressed See aria-selected.

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

Property Value

Inherited From IButtonProps.aria-checked

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

See aria-colindex.

aria-colcount?: number

Property Value

Inherited From IButtonProps.aria-colcount

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 See aria-colspan.

aria-colindex?: number

Property Value

Inherited From IButtonProps.aria-colindex

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

See aria-colindex See aria-rowspan.

aria-colspan?: number

Property Value

Inherited From IButtonProps.aria-colspan

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

See aria-owns.

aria-controls?: string

Property Value

Inherited From IButtonProps.aria-controls

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

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

Property Value

Inherited From IButtonProps.aria-current

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

See aria-labelledby

aria-describedby?: string

Property Value

Inherited From IButtonProps.aria-describedby

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

See aria-describedby.

aria-details?: string

Property Value

Inherited From IButtonProps.aria-details

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

See aria-hidden See aria-readonly.

aria-disabled?: Booleanish

Property Value

Inherited From IButtonProps.aria-disabled

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

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

Property Value

Inherited From IButtonProps.aria-dropeffect

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

See aria-invalid See aria-describedby.

aria-errormessage?: string

Property Value

Inherited From IButtonProps.aria-errormessage

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

aria-expanded?: Booleanish

Property Value

Inherited From IButtonProps.aria-expanded

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.

aria-flowto?: string

Property Value

Inherited From IButtonProps.aria-flowto

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

aria-grabbed?: Booleanish

Property Value

Inherited From IButtonProps.aria-grabbed

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

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

Property Value

Inherited From IButtonProps.aria-haspopup

Indicates whether the element is exposed to an accessibility API.

See aria-disabled.

aria-hidden?: Booleanish

Property Value

Inherited From IButtonProps.aria-hidden

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

See aria-errormessage.

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

Property Value

Inherited From IButtonProps.aria-invalid

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

aria-keyshortcuts?: string

Property Value

Inherited From IButtonProps.aria-keyshortcuts

Defines a string value that labels the current element.

See aria-labelledby.

aria-label?: string

Property Value

Inherited From IButtonProps.aria-label

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

See aria-describedby.

aria-labelledby?: string

Property Value

Inherited From IButtonProps.aria-labelledby

Defines the hierarchical level of an element within a structure.

aria-level?: number

Property Value

Inherited From IButtonProps.aria-level

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.

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

Property Value

Inherited From IButtonProps.aria-live

Indicates whether an element is modal when displayed.

aria-modal?: Booleanish

Property Value

Inherited From IButtonProps.aria-modal

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

aria-multiline?: Booleanish

Property Value

Inherited From IButtonProps.aria-multiline

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

aria-multiselectable?: Booleanish

Property Value

Inherited From IButtonProps.aria-multiselectable

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

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

Property Value

Inherited From IButtonProps.aria-orientation

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.

aria-owns?: string

Property Value

Inherited From IButtonProps.aria-owns

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.

aria-placeholder?: string

Property Value

Inherited From IButtonProps.aria-placeholder

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.

aria-posinset?: number

Property Value

Inherited From IButtonProps.aria-posinset

Indicates the current "pressed" state of toggle buttons.

See aria-checked See aria-selected.

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

Property Value

Inherited From IButtonProps.aria-pressed

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

See aria-disabled.

aria-readonly?: Booleanish

Property Value

Inherited From IButtonProps.aria-readonly

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

See aria-atomic.

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

Property Value

Inherited From IButtonProps.aria-relevant

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

aria-required?: Booleanish

Property Value

Inherited From IButtonProps.aria-required

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

aria-roledescription?: string

Property Value

Inherited From IButtonProps.aria-roledescription

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

See aria-rowindex.

aria-rowcount?: number

Property Value

Inherited From IButtonProps.aria-rowcount

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 See aria-rowspan.

aria-rowindex?: number

Property Value

Inherited From IButtonProps.aria-rowindex

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

See aria-rowindex See aria-colspan.

aria-rowspan?: number

Property Value

Inherited From IButtonProps.aria-rowspan

Indicates the current "selected" state of various widgets.

See aria-checked See aria-pressed.

aria-selected?: Booleanish

Property Value

Inherited From IButtonProps.aria-selected

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.

aria-setsize?: number

Property Value

Inherited From IButtonProps.aria-setsize

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

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

Property Value

Inherited From IButtonProps.aria-sort

Defines the maximum allowed value for a range widget.

aria-valuemax?: number

Property Value

Inherited From IButtonProps.aria-valuemax

Defines the minimum allowed value for a range widget.

aria-valuemin?: number

Property Value

Inherited From IButtonProps.aria-valuemin

Defines the current value for a range widget.

See aria-valuetext.

aria-valuenow?: number

Property Value

Inherited From IButtonProps.aria-valuenow

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

aria-valuetext?: string

Property Value

Inherited From IButtonProps.aria-valuetext

Detailed description of the button for the benefit of screen readers.

Besides the compound button, other button types will need more information provided to screen reader.

ariaDescription?: string

Property Value

Inherited From IButtonProps.ariaDescription

If true, add an aria-hidden attribute instructing screen readers to ignore the element.

ariaHidden?: boolean

Property Value

Inherited From IButtonProps.ariaHidden

The aria label of the button for the benefit of screen readers.

ariaLabel?: string

Property Value

Inherited From IButtonProps.ariaLabel

as?: string

Property Value

Inherited From IButtonProps.as

async?: boolean

Property Value

Inherited From IButtonProps.async

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

Property Value

Inherited From IButtonProps.autoCapitalize

autoComplete?: string

Property Value

Inherited From IButtonProps.autoComplete

autoCorrect?: string

Property Value

Inherited From IButtonProps.autoCorrect

autoFocus?: boolean

Property Value

Inherited From IButtonProps.autoFocus

autoPlay?: boolean

Property Value

Inherited From IButtonProps.autoPlay

autoSave?: string

Property Value

Inherited From IButtonProps.autoSave

buttonType?: ButtonType

Property Value

Inherited From IButtonProps.buttonType

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

Property Value

Inherited From IButtonProps.capture

cellPadding?: string | number

Property Value

Inherited From IButtonProps.cellPadding

cellSpacing?: string | number

Property Value

Inherited From IButtonProps.cellSpacing

challenge?: string

Property Value

Inherited From IButtonProps.challenge

charSet?: string

Property Value

Inherited From IButtonProps.charSet

Whether the button is checked. Should be used with the toggle attribute when creating a standalone on/off button.

checked?: boolean

Property Value

Inherited From IButtonProps.checked

children?: ReactNode

Property Value

Inherited From IButtonProps.children

cite?: string

Property Value

Inherited From IButtonProps.cite

classID?: string

Property Value

Inherited From IButtonProps.classID

If provided, additional class name to provide on the root element.

className?: string

Property Value

Inherited From IButtonProps.className

color?: string

Property Value

Inherited From IButtonProps.color

cols?: number

Property Value

Inherited From IButtonProps.cols

colSpan?: number

Property Value

Inherited From IButtonProps.colSpan

Optional callback to access the IButton interface. Use this instead of ref for accessing the public methods and properties of the component.

componentRef?: IRefObject<IButton>

Property Value

Inherited From IButtonProps.componentRef

content?: string

Property Value

Inherited From IButtonProps.content

contentEditable?: Booleanish | "inherit"

Property Value

Inherited From IButtonProps.contentEditable

contextMenu?: string

Property Value

Inherited From IButtonProps.contextMenu

controls?: boolean

Property Value

Inherited From IButtonProps.controls

coords?: string

Property Value

Inherited From IButtonProps.coords

crossOrigin?: CrossOrigin

Property Value

Inherited From IButtonProps.crossOrigin

dangerouslySetInnerHTML?: { __html: string | TrustedHTML }

Property Value

Inherited From IButtonProps.dangerouslySetInnerHTML

Any custom data the developer wishes to associate with the button.

data?: any

Property Value

Inherited From IButtonProps.data

datatype?: string

Property Value

Inherited From IButtonProps.datatype

dateTime?: string

Property Value

Inherited From IButtonProps.dateTime

default?: boolean

Property Value

Inherited From IButtonProps.default

defaultChecked?: boolean

Property Value

Inherited From IButtonProps.defaultChecked

yet unknown docs

defaultRender?: any

Property Value

Inherited From IButtonProps.defaultRender

defaultValue?: string | number | (readonly string[])

Property Value

Inherited From IButtonProps.defaultValue

defer?: boolean

Property Value

Inherited From IButtonProps.defer

Style for the description text if applicable (for compound buttons).

description?: string

Property Value

Inherited From IButtonProps.description

dir?: string

Property Value

Inherited From IButtonProps.dir

Whether the button is disabled

disabled?: boolean

Property Value

Inherited From IButtonProps.disabled

download?: any

Property Value

Inherited From IButtonProps.download

draggable?: Booleanish

Property Value

Inherited From IButtonProps.draggable

Optional callback to access the root DOM element.

elementRef?: Ref<HTMLElement>

Property Value

Inherited From IButtonProps.elementRef

encType?: string

Property Value

Inherited From IButtonProps.encType

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

Property Value

Inherited From IButtonProps.enterKeyHint

form?: string

Property Value

Inherited From IButtonProps.form

formAction?: string

Property Value

Inherited From IButtonProps.formAction

formEncType?: string

Property Value

Inherited From IButtonProps.formEncType

formMethod?: string

Property Value

Inherited From IButtonProps.formMethod

formNoValidate?: boolean

Property Value

Inherited From IButtonProps.formNoValidate

formTarget?: string

Property Value

Inherited From IButtonProps.formTarget

frameBorder?: string | number

Property Value

Inherited From IButtonProps.frameBorder

Method to provide the classnames to style a button. The default value for this prop is the getClassnames func defined in BaseButton.classnames.ts.

getClassNames?: (theme: ITheme, className: string, variantClassName: string, iconClassName: undefined | string, menuIconClassName: undefined | string, disabled: boolean, checked: boolean, expanded: boolean, hasMenu: boolean, isSplit: undefined | boolean, allowDisabledFocus: boolean) => IButtonClassNames

Property Value

Inherited From IButtonProps.getClassNames

Method to provide the classnames to style a button. The default value for this prop is the getClassnames func defined in BaseButton.classnames.ts.

getSplitButtonClassNames?: (disabled: boolean, expanded: boolean, checked: boolean, allowDisabledFocus: boolean) => ISplitButtonClassNames

Property Value

Inherited From IButtonProps.getSplitButtonClassNames

headers?: string

Property Value

Inherited From IButtonProps.headers

height?: string | number

Property Value

Inherited From IButtonProps.height

hidden?: boolean

Property Value

Inherited From IButtonProps.hidden

high?: number

Property Value

Inherited From IButtonProps.high

If provided, this component will be rendered as an anchor.

href?: string

Property Value

Inherited From IButtonProps.href

hrefLang?: string

Property Value

Inherited From IButtonProps.hrefLang

htmlFor?: string

Property Value

Inherited From IButtonProps.htmlFor

httpEquiv?: string

Property Value

Inherited From IButtonProps.httpEquiv

The props for the icon shown in the button.

iconProps?: IIconProps

Property Value

Inherited From IButtonProps.iconProps

id?: string

Property Value

Inherited From IButtonProps.id

inlist?: any

Property Value

Inherited From IButtonProps.inlist

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

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

Property Value

Inherited From IButtonProps.inputMode

integrity?: string

Property Value

Inherited From IButtonProps.integrity

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

is?: string

Property Value

Inherited From IButtonProps.is

itemID?: string

Property Value

Inherited From IButtonProps.itemID

itemProp?: string

Property Value

Inherited From IButtonProps.itemProp

itemRef?: string

Property Value

Inherited From IButtonProps.itemRef

itemScope?: boolean

Property Value

Inherited From IButtonProps.itemScope

itemType?: string

Property Value

Inherited From IButtonProps.itemType

keyParams?: string

Property Value

Inherited From IButtonProps.keyParams

Optional keytip for this button

keytipProps?: IKeytipProps

Property Value

Inherited From IButtonProps.keytipProps

keyType?: string

Property Value

Inherited From IButtonProps.keyType

kind?: string

Property Value

Inherited From IButtonProps.kind

label?: string

Property Value

Inherited From IButtonProps.label

lang?: string

Property Value

Inherited From IButtonProps.lang

list?: string

Property Value

Inherited From IButtonProps.list

loop?: boolean

Property Value

Inherited From IButtonProps.loop

low?: number

Property Value

Inherited From IButtonProps.low

manifest?: string

Property Value

Inherited From IButtonProps.manifest

marginHeight?: number

Property Value

Inherited From IButtonProps.marginHeight

marginWidth?: number

Property Value

Inherited From IButtonProps.marginWidth

max?: string | number

Property Value

Inherited From IButtonProps.max

maxLength?: number

Property Value

Inherited From IButtonProps.maxLength

media?: string

Property Value

Inherited From IButtonProps.media

mediaGroup?: string

Property Value

Inherited From IButtonProps.mediaGroup

Render a custom menu in place of the normal one.

menuAs?: IComponentAs<IContextualMenuProps>

Property Value

Inherited From IButtonProps.menuAs

The props for the icon shown when providing a menu dropdown.

menuIconProps?: IIconProps

Property Value

Inherited From IButtonProps.menuIconProps

Props for button menu. Providing this will default to showing the menu icon. See menuIconProps for overriding how the default icon looks. Providing this in addition to onClick and setting the split property to true will render a SplitButton.

menuProps?: IContextualMenuProps

Property Value

Inherited From IButtonProps.menuProps

Provides a custom KeyCode that can be used to open the button menu. A value of null can be provided to disable opening the button menu with a key press.

menuTriggerKeyCode?: null | number

Property Value

Inherited From IButtonProps.menuTriggerKeyCode

method?: string

Property Value

Inherited From IButtonProps.method

min?: string | number

Property Value

Inherited From IButtonProps.min

minLength?: number

Property Value

Inherited From IButtonProps.minLength

multiple?: boolean

Property Value

Inherited From IButtonProps.multiple

muted?: boolean

Property Value

Inherited From IButtonProps.muted

name?: string

Property Value

Inherited From IButtonProps.name

nonce?: string

Property Value

Inherited From IButtonProps.nonce

noValidate?: boolean

Property Value

Inherited From IButtonProps.noValidate

onAbort?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onAbort

onAbortCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onAbortCapture

Callback that runs after Button's contextual menu was closed (removed from the DOM)

onAfterMenuDismiss?: () => void

Property Value

Inherited From IButtonProps.onAfterMenuDismiss

onAnimationEnd?: AnimationEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onAnimationEnd

onAnimationEndCapture?: AnimationEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onAnimationEndCapture

onAnimationIteration?: AnimationEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onAnimationIteration

onAnimationIterationCapture?: AnimationEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onAnimationIterationCapture

onAnimationStart?: AnimationEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onAnimationStart

onAnimationStartCapture?: AnimationEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onAnimationStartCapture

onAuxClick?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onAuxClick

onAuxClickCapture?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onAuxClickCapture

onBeforeInput?: FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onBeforeInput

onBeforeInputCapture?: FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onBeforeInputCapture

onBlur?: FocusEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onBlur

onBlurCapture?: FocusEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onBlurCapture

onCanPlay?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onCanPlay

onCanPlayCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onCanPlayCapture

onCanPlayThrough?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onCanPlayThrough

onCanPlayThroughCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onCanPlayThroughCapture

onChange?: FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onChange

onChangeCapture?: FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onChangeCapture

onClick?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onClick

onClickCapture?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onClickCapture

onCompositionEnd?: CompositionEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onCompositionEnd

onCompositionEndCapture?: CompositionEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onCompositionEndCapture

onCompositionStart?: CompositionEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onCompositionStart

onCompositionStartCapture?: CompositionEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onCompositionStartCapture

onCompositionUpdate?: CompositionEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onCompositionUpdate

onCompositionUpdateCapture?: CompositionEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onCompositionUpdateCapture

onContextMenu?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onContextMenu

onContextMenuCapture?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onContextMenuCapture

onCopy?: ClipboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onCopy

onCopyCapture?: ClipboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onCopyCapture

onCut?: ClipboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onCut

onCutCapture?: ClipboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onCutCapture

onDoubleClick?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onDoubleClick

onDoubleClickCapture?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onDoubleClickCapture

onDrag?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onDrag

onDragCapture?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onDragCapture

onDragEnd?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onDragEnd

onDragEndCapture?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onDragEndCapture

onDragEnter?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onDragEnter

onDragEnterCapture?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onDragEnterCapture

onDragExit?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onDragExit

onDragExitCapture?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onDragExitCapture

onDragLeave?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onDragLeave

onDragLeaveCapture?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onDragLeaveCapture

onDragOver?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onDragOver

onDragOverCapture?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onDragOverCapture

onDragStart?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onDragStart

onDragStartCapture?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onDragStartCapture

onDrop?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onDrop

onDropCapture?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onDropCapture

onDurationChange?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onDurationChange

onDurationChangeCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onDurationChangeCapture

onEmptied?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onEmptied

onEmptiedCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onEmptiedCapture

onEncrypted?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onEncrypted

onEncryptedCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onEncryptedCapture

onEnded?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onEnded

onEndedCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onEndedCapture

onError?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onError

onErrorCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onErrorCapture

onFocus?: FocusEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onFocus

onFocusCapture?: FocusEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onFocusCapture

onGotPointerCapture?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onGotPointerCapture

onGotPointerCaptureCapture?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onGotPointerCaptureCapture

onInput?: FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onInput

onInputCapture?: FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onInputCapture

onInvalid?: FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onInvalid

onInvalidCapture?: FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onInvalidCapture

onKeyDown?: KeyboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onKeyDown

onKeyDownCapture?: KeyboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onKeyDownCapture

onKeyPress?: KeyboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onKeyPress

onKeyPressCapture?: KeyboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onKeyPressCapture

onKeyUp?: KeyboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onKeyUp

onKeyUpCapture?: KeyboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onKeyUpCapture

onLoad?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onLoad

onLoadCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onLoadCapture

onLoadedData?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onLoadedData

onLoadedDataCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onLoadedDataCapture

onLoadedMetadata?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onLoadedMetadata

onLoadedMetadataCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onLoadedMetadataCapture

onLoadStart?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onLoadStart

onLoadStartCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onLoadStartCapture

onLostPointerCapture?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onLostPointerCapture

onLostPointerCaptureCapture?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onLostPointerCaptureCapture

Optional callback when menu is clicked.

onMenuClick?: (ev?: MouseEvent<HTMLElement, MouseEvent> | KeyboardEvent<HTMLElement>, button?: IButtonProps) => void

Property Value

Inherited From IButtonProps.onMenuClick

onMouseDown?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onMouseDown

onMouseDownCapture?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onMouseDownCapture

onMouseEnter?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onMouseEnter

onMouseLeave?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onMouseLeave

onMouseMove?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onMouseMove

onMouseMoveCapture?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onMouseMoveCapture

onMouseOut?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onMouseOut

onMouseOutCapture?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onMouseOutCapture

onMouseOver?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onMouseOver

onMouseOverCapture?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onMouseOverCapture

onMouseUp?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onMouseUp

onMouseUpCapture?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onMouseUpCapture

onPaste?: ClipboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onPaste

onPasteCapture?: ClipboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onPasteCapture

onPause?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onPause

onPauseCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onPauseCapture

onPlay?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onPlay

onPlayCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onPlayCapture

onPlaying?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onPlaying

onPlayingCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onPlayingCapture

onPointerCancel?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onPointerCancel

onPointerCancelCapture?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onPointerCancelCapture

onPointerDown?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onPointerDown

onPointerDownCapture?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onPointerDownCapture

onPointerEnter?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onPointerEnter

onPointerEnterCapture?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onPointerEnterCapture

onPointerLeave?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onPointerLeave

onPointerLeaveCapture?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onPointerLeaveCapture

onPointerMove?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onPointerMove

onPointerMoveCapture?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onPointerMoveCapture

onPointerOut?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onPointerOut

onPointerOutCapture?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onPointerOutCapture

onPointerOver?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onPointerOver

onPointerOverCapture?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onPointerOverCapture

onPointerUp?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onPointerUp

onPointerUpCapture?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onPointerUpCapture

onProgress?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onProgress

onProgressCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onProgressCapture

onRateChange?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onRateChange

onRateChangeCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onRateChangeCapture

Custom render function for the aria description element.

onRenderAriaDescription?: IRenderFunction<IButtonProps>

Property Value

Inherited From IButtonProps.onRenderAriaDescription

Custom render function for rendering the button children.

onRenderChildren?: IRenderFunction<IButtonProps>

Property Value

Inherited From IButtonProps.onRenderChildren

Custom render function for the description text.

onRenderDescription?: IRenderFunction<IButtonProps>

Property Value

Inherited From IButtonProps.onRenderDescription

Custom render function for the icon

onRenderIcon?: IRenderFunction<IButtonProps>

Property Value

Inherited From IButtonProps.onRenderIcon

onRenderMenu?: IRenderFunction<IContextualMenuProps>

Property Value

Inherited From IButtonProps.onRenderMenu

Custom render function for button menu icon

onRenderMenuIcon?: IRenderFunction<IButtonProps>

Property Value

Inherited From IButtonProps.onRenderMenuIcon

Custom render function for the label text.

onRenderText?: IRenderFunction<IButtonProps>

Property Value

Inherited From IButtonProps.onRenderText

onReset?: FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onReset

onResetCapture?: FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onResetCapture

onScroll?: UIEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onScroll

onScrollCapture?: UIEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onScrollCapture

onSeeked?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onSeeked

onSeekedCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onSeekedCapture

onSeeking?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onSeeking

onSeekingCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onSeekingCapture

onSelect?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onSelect

onSelectCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onSelectCapture

onStalled?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onStalled

onStalledCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onStalledCapture

onSubmit?: FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onSubmit

onSubmitCapture?: FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onSubmitCapture

onSuspend?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onSuspend

onSuspendCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onSuspendCapture

onTimeUpdate?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onTimeUpdate

onTimeUpdateCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onTimeUpdateCapture

onTouchCancel?: TouchEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onTouchCancel

onTouchCancelCapture?: TouchEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onTouchCancelCapture

onTouchEnd?: TouchEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onTouchEnd

onTouchEndCapture?: TouchEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onTouchEndCapture

onTouchMove?: TouchEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onTouchMove

onTouchMoveCapture?: TouchEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onTouchMoveCapture

onTouchStart?: TouchEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onTouchStart

onTouchStartCapture?: TouchEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onTouchStartCapture

onTransitionEnd?: TransitionEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onTransitionEnd

onTransitionEndCapture?: TransitionEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onTransitionEndCapture

onVolumeChange?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onVolumeChange

onVolumeChangeCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onVolumeChangeCapture

onWaiting?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onWaiting

onWaitingCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onWaitingCapture

onWheel?: WheelEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onWheel

onWheelCapture?: WheelEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>

Property Value

Inherited From IButtonProps.onWheelCapture

open?: boolean

Property Value

Inherited From IButtonProps.open

optimum?: number

Property Value

Inherited From IButtonProps.optimum

pattern?: string

Property Value

Inherited From IButtonProps.pattern

Menu will not be created or destroyed when opened or closed, instead it will be hidden. This will improve perf of the menu opening but could potentially impact overall perf by having more elements in the dom. Should only be used when menu perf is important.

Note: This may increase the amount of time it takes for the button itself to mount.

persistMenu?: boolean

Property Value

Inherited From IButtonProps.persistMenu

placeholder?: string

Property Value

Inherited From IButtonProps.placeholder

playsInline?: boolean

Property Value

Inherited From IButtonProps.playsInline

poster?: string

Property Value

Inherited From IButtonProps.poster

prefix?: string

Property Value

Inherited From IButtonProps.prefix

preload?: string

Property Value

Inherited From IButtonProps.preload

Changes the visual presentation of the button to be emphasized.

primary?: boolean

Property Value

Inherited From IButtonProps.primary

Optional props to be applied only to the primary action button of SplitButton and not to the overall SplitButton container

primaryActionButtonProps?: IButtonProps

Property Value

Inherited From IButtonProps.primaryActionButtonProps

If set to true and this is a split button (split is true), the split button's primary action is disabled.

primaryDisabled?: boolean

Property Value

Inherited From IButtonProps.primaryDisabled

property?: string

Property Value

Inherited From IButtonProps.property

radioGroup?: string

Property Value

Inherited From IButtonProps.radioGroup

readOnly?: boolean

Property Value

Inherited From IButtonProps.readOnly

rel?: string

Property Value

Inherited From IButtonProps.rel

If true, the persisted menu is rendered hidden when the button initially mounts. Non-persisted menus will not be in the component tree unless they are being shown.

Note: This increases the time the button will take to mount, but can improve perceived menu open perf. when the user opens the menu.

renderPersistedMenuHiddenOnMount?: boolean

Property Value

Inherited From IButtonProps.renderPersistedMenuHiddenOnMount

required?: boolean

Property Value

Inherited From IButtonProps.required

resource?: string

Property Value

Inherited From IButtonProps.resource

results?: number

Property Value

Inherited From IButtonProps.results

rev?: string

Property Value

Inherited From IButtonProps.rev

reversed?: boolean

Property Value

Inherited From IButtonProps.reversed

role?: AriaRole

Property Value

Inherited From IButtonProps.role

rootProps?: ButtonHTMLAttributes<HTMLButtonElement> | AnchorHTMLAttributes<HTMLAnchorElement>

Property Value

Inherited From IButtonProps.rootProps

rows?: number

Property Value

Inherited From IButtonProps.rows

rowSpan?: number

Property Value

Inherited From IButtonProps.rowSpan

sandbox?: string

Property Value

Inherited From IButtonProps.sandbox

scope?: string

Property Value

Inherited From IButtonProps.scope

scoped?: boolean

Property Value

Inherited From IButtonProps.scoped

scrolling?: string

Property Value

Inherited From IButtonProps.scrolling

seamless?: boolean

Property Value

Inherited From IButtonProps.seamless

Description of the action this button takes. Only used for compound buttons.

secondaryText?: string

Property Value

Inherited From IButtonProps.secondaryText

security?: string

Property Value

Inherited From IButtonProps.security

selected?: boolean

Property Value

Inherited From IButtonProps.selected

shape?: string

Property Value

Inherited From IButtonProps.shape

size?: number

Property Value

Inherited From IButtonProps.size

sizes?: string

Property Value

Inherited From IButtonProps.sizes

slot?: string

Property Value

Inherited From IButtonProps.slot

span?: number

Property Value

Inherited From IButtonProps.span

spellCheck?: Booleanish

Property Value

Inherited From IButtonProps.spellCheck

If set to true, and if menuProps and onClick are provided, the button will render as a SplitButton.

split?: boolean

Property Value

Inherited From IButtonProps.split

Accessible label for the dropdown chevron button if this button is split.

splitButtonAriaLabel?: string

Property Value

Inherited From IButtonProps.splitButtonAriaLabel

Experimental prop that get passed into the menuButton that's rendered as part of split button. Anything passed in will likely need to have accompanying style changes.

splitButtonMenuProps?: IButtonProps

Property Value

Inherited From IButtonProps.splitButtonMenuProps

src?: string

Property Value

Inherited From IButtonProps.src

srcDoc?: string

Property Value

Inherited From IButtonProps.srcDoc

srcLang?: string

Property Value

Inherited From IButtonProps.srcLang

srcSet?: string

Property Value

Inherited From IButtonProps.srcSet

start?: number

Property Value

Inherited From IButtonProps.start

step?: string | number

Property Value

Inherited From IButtonProps.step

style?: CSSProperties

Property Value

Inherited From IButtonProps.style

summary?: string

Property Value

Inherited From IButtonProps.summary

suppressContentEditableWarning?: boolean

Property Value

Inherited From IButtonProps.suppressContentEditableWarning

suppressHydrationWarning?: boolean

Property Value

Inherited From IButtonProps.suppressHydrationWarning

tabIndex?: number

Property Value

Inherited From IButtonProps.tabIndex

target?: string

Property Value

Inherited From IButtonProps.target

Text to render button label. If text is supplied, it will override any string in button children. Other children components will be passed through after the text.

text?: string

Property Value

Inherited From IButtonProps.text

Theme provided by HOC.

theme?: ITheme

Property Value

Inherited From IButtonProps.theme

title?: string

Property Value

Inherited From IButtonProps.title

Whether button is a toggle button with distinct on and off states. This should be true for buttons that permanently change state when a press event finishes, such as a volume mute button.

toggle?: boolean

Property Value

Inherited From IButtonProps.toggle

toggled?: boolean

Property Value

Inherited From IButtonProps.toggled

translate?: "yes" | "no"

Property Value

Inherited From IButtonProps.translate

type?: string

Property Value

Inherited From IButtonProps.type

typeof?: string

Property Value

Inherited From IButtonProps.typeof

Unique ID to identify the item. Typically a duplicate of key value.

uniqueId?: string | number

Property Value

Inherited From IButtonProps.uniqueId

unselectable?: "off" | "on"

Property Value

Inherited From IButtonProps.unselectable

useMap?: string

Property Value

Inherited From IButtonProps.useMap

value?: string | number | (readonly string[])

Property Value

Inherited From IButtonProps.value

vocab?: string

Property Value

Inherited From IButtonProps.vocab

width?: string | number

Property Value

Inherited From IButtonProps.width

wmode?: string

Property Value

Inherited From IButtonProps.wmode

wrap?: string

Property Value

Inherited From IButtonProps.wrap