MicrophoneButtonProps interface

Whether to use a <xref:SplitButton> with a <xref:IContextualMenu> for device selection.

default: false

enableDeviceSelectionMenu?: boolean

Property Value

Available microphones for selection

microphones?: OptionsDevice[]

Property Value

Callback when a microphone is selected

onSelectMicrophone?: (device: OptionsDevice) => Promise<void>

Property Value

Speaker when a speaker is selected

onSelectSpeaker?: (device: OptionsDevice) => Promise<void>

Property Value

Utility property for using this component with communication react eventHandlers. Maps directly to the onClick property.

onToggleMicrophone?: () => Promise<void>

Property Value

Microphone that is shown as currently selected

selectedMicrophone?: OptionsDevice

Property Value

Speaker that is shown as currently selected

selectedSpeaker?: OptionsDevice

Property Value

Available speakers for selection

speakers?: OptionsDevice[]

Property Value

Optional strings to override in component

strings?: Partial<MicrophoneButtonStrings>

Property Value

Styles for MicrophoneButton and the device selection flyout.

styles?: Partial<MicrophoneButtonStyles>

Property Value

about?: string

Property Value

Inherited From ControlBarButtonProps.about

accept?: string

Property Value

Inherited From ControlBarButtonProps.accept

acceptCharset?: string

Property Value

Inherited From ControlBarButtonProps.acceptCharset

accessKey?: string

Property Value

Inherited From ControlBarButtonProps.accessKey

action?: string

Property Value

Inherited From ControlBarButtonProps.action

Whether the button can have focus in disabled mode

allowDisabledFocus?: boolean

Property Value

Inherited From ControlBarButtonProps.allowDisabledFocus

allowFullScreen?: boolean

Property Value

Inherited From ControlBarButtonProps.allowFullScreen

allowTransparency?: boolean

Property Value

Inherited From ControlBarButtonProps.allowTransparency

alt?: string

Property Value

Inherited From ControlBarButtonProps.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 ControlBarButtonProps.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 ControlBarButtonProps.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?: "list" | "none" | "inline" | "both"

Property Value

Inherited From ControlBarButtonProps.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 ControlBarButtonProps.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 ControlBarButtonProps.aria-checked

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

See aria-colindex.

aria-colcount?: number

Property Value

Inherited From ControlBarButtonProps.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 ControlBarButtonProps.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 ControlBarButtonProps.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 ControlBarButtonProps.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 ControlBarButtonProps.aria-current

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

See aria-labelledby

aria-describedby?: string

Property Value

Inherited From ControlBarButtonProps.aria-describedby

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

See aria-describedby.

aria-details?: string

Property Value

Inherited From ControlBarButtonProps.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 ControlBarButtonProps.aria-disabled

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

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

Property Value

Inherited From ControlBarButtonProps.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 ControlBarButtonProps.aria-errormessage

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

aria-expanded?: Booleanish

Property Value

Inherited From ControlBarButtonProps.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 ControlBarButtonProps.aria-flowto

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

aria-grabbed?: Booleanish

Property Value

Inherited From ControlBarButtonProps.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 ControlBarButtonProps.aria-haspopup

Indicates whether the element is exposed to an accessibility API.

See aria-disabled.

aria-hidden?: Booleanish

Property Value

Inherited From ControlBarButtonProps.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 ControlBarButtonProps.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 ControlBarButtonProps.aria-keyshortcuts

Defines a string value that labels the current element.

See aria-labelledby.

aria-label?: string

Property Value

Inherited From ControlBarButtonProps.aria-label

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

See aria-describedby.

aria-labelledby?: string

Property Value

Inherited From ControlBarButtonProps.aria-labelledby

Defines the hierarchical level of an element within a structure.

aria-level?: number

Property Value

Inherited From ControlBarButtonProps.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 ControlBarButtonProps.aria-live

Indicates whether an element is modal when displayed.

aria-modal?: Booleanish

Property Value

Inherited From ControlBarButtonProps.aria-modal

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

aria-multiline?: Booleanish

Property Value

Inherited From ControlBarButtonProps.aria-multiline

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

aria-multiselectable?: Booleanish

Property Value

Inherited From ControlBarButtonProps.aria-multiselectable

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

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

Property Value

Inherited From ControlBarButtonProps.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 ControlBarButtonProps.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 ControlBarButtonProps.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 ControlBarButtonProps.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 ControlBarButtonProps.aria-pressed

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

See aria-disabled.

aria-readonly?: Booleanish

Property Value

Inherited From ControlBarButtonProps.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 ControlBarButtonProps.aria-relevant

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

aria-required?: Booleanish

Property Value

Inherited From ControlBarButtonProps.aria-required

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

aria-roledescription?: string

Property Value

Inherited From ControlBarButtonProps.aria-roledescription

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

See aria-rowindex.

aria-rowcount?: number

Property Value

Inherited From ControlBarButtonProps.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 ControlBarButtonProps.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 ControlBarButtonProps.aria-rowspan

Indicates the current "selected" state of various widgets.

See aria-checked See aria-pressed.

aria-selected?: Booleanish

Property Value

Inherited From ControlBarButtonProps.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 ControlBarButtonProps.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 ControlBarButtonProps.aria-sort

Defines the maximum allowed value for a range widget.

aria-valuemax?: number

Property Value

Inherited From ControlBarButtonProps.aria-valuemax

Defines the minimum allowed value for a range widget.

aria-valuemin?: number

Property Value

Inherited From ControlBarButtonProps.aria-valuemin

Defines the current value for a range widget.

See aria-valuetext.

aria-valuenow?: number

Property Value

Inherited From ControlBarButtonProps.aria-valuenow

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

aria-valuetext?: string

Property Value

Inherited From ControlBarButtonProps.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 ControlBarButtonProps.ariaDescription

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

ariaHidden?: boolean

Property Value

Inherited From ControlBarButtonProps.ariaHidden

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

ariaLabel?: string

Property Value

Inherited From ControlBarButtonProps.ariaLabel

as?: string

Property Value

Inherited From ControlBarButtonProps.as

async?: boolean

Property Value

Inherited From ControlBarButtonProps.async

autoCapitalize?: string

Property Value

Inherited From ControlBarButtonProps.autoCapitalize

autoComplete?: string

Property Value

Inherited From ControlBarButtonProps.autoComplete

autoCorrect?: string

Property Value

Inherited From ControlBarButtonProps.autoCorrect

autoFocus?: boolean

Property Value

Inherited From ControlBarButtonProps.autoFocus

autoPlay?: boolean

Property Value

Inherited From ControlBarButtonProps.autoPlay

autoSave?: string

Property Value

Inherited From ControlBarButtonProps.autoSave

buttonType?: ButtonType

Property Value

Inherited From ControlBarButtonProps.buttonType

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

Property Value

Inherited From ControlBarButtonProps.capture

cellPadding?: string | number

Property Value

Inherited From ControlBarButtonProps.cellPadding

cellSpacing?: string | number

Property Value

Inherited From ControlBarButtonProps.cellSpacing

challenge?: string

Property Value

Inherited From ControlBarButtonProps.challenge

charSet?: string

Property Value

Inherited From ControlBarButtonProps.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 ControlBarButtonProps.checked

children?: ReactNode

Property Value

Inherited From ControlBarButtonProps.children

cite?: string

Property Value

Inherited From ControlBarButtonProps.cite

classID?: string

Property Value

Inherited From ControlBarButtonProps.classID

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

className?: string

Property Value

Inherited From ControlBarButtonProps.className

color?: string

Property Value

Inherited From ControlBarButtonProps.color

cols?: number

Property Value

Inherited From ControlBarButtonProps.cols

colSpan?: number

Property Value

Inherited From ControlBarButtonProps.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 ControlBarButtonProps.componentRef

content?: string

Property Value

Inherited From ControlBarButtonProps.content

contentEditable?: Booleanish | "inherit"

Property Value

Inherited From ControlBarButtonProps.contentEditable

contextMenu?: string

Property Value

Inherited From ControlBarButtonProps.contextMenu

controls?: boolean

Property Value

Inherited From ControlBarButtonProps.controls

coords?: string

Property Value

Inherited From ControlBarButtonProps.coords

crossOrigin?: CrossOrigin

Property Value

Inherited From ControlBarButtonProps.crossOrigin

dangerouslySetInnerHTML?: { __html: string | TrustedHTML }

Property Value

Inherited From ControlBarButtonProps.dangerouslySetInnerHTML

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

data?: any

Property Value

Inherited From ControlBarButtonProps.data

datatype?: string

Property Value

Inherited From ControlBarButtonProps.datatype

dateTime?: string

Property Value

Inherited From ControlBarButtonProps.dateTime

default?: boolean

Property Value

Inherited From ControlBarButtonProps.default

defaultChecked?: boolean

Property Value

Inherited From ControlBarButtonProps.defaultChecked

yet unknown docs

defaultRender?: any

Property Value

Inherited From ControlBarButtonProps.defaultRender

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

Property Value

Inherited From ControlBarButtonProps.defaultValue

defer?: boolean

Property Value

Inherited From ControlBarButtonProps.defer

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

description?: string

Property Value

Inherited From ControlBarButtonProps.description

dir?: string

Property Value

Inherited From ControlBarButtonProps.dir

Whether the button is disabled

disabled?: boolean

Property Value

Inherited From ControlBarButtonProps.disabled

download?: any

Property Value

Inherited From ControlBarButtonProps.download

draggable?: Booleanish

Property Value

Inherited From ControlBarButtonProps.draggable

Optional callback to access the root DOM element.

elementRef?: Ref<HTMLElement>

Property Value

Inherited From ControlBarButtonProps.elementRef

encType?: string

Property Value

Inherited From ControlBarButtonProps.encType

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

Property Value

Inherited From ControlBarButtonProps.enterKeyHint

form?: string

Property Value

Inherited From ControlBarButtonProps.form

formAction?: string

Property Value

Inherited From ControlBarButtonProps.formAction

formEncType?: string

Property Value

Inherited From ControlBarButtonProps.formEncType

formMethod?: string

Property Value

Inherited From ControlBarButtonProps.formMethod

formNoValidate?: boolean

Property Value

Inherited From ControlBarButtonProps.formNoValidate

formTarget?: string

Property Value

Inherited From ControlBarButtonProps.formTarget

frameBorder?: string | number

Property Value

Inherited From ControlBarButtonProps.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 ControlBarButtonProps.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 ControlBarButtonProps.getSplitButtonClassNames

headers?: string

Property Value

Inherited From ControlBarButtonProps.headers

height?: string | number

Property Value

Inherited From ControlBarButtonProps.height

hidden?: boolean

Property Value

Inherited From ControlBarButtonProps.hidden

high?: number

Property Value

Inherited From ControlBarButtonProps.high

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

href?: string

Property Value

Inherited From ControlBarButtonProps.href

hrefLang?: string

Property Value

Inherited From ControlBarButtonProps.hrefLang

htmlFor?: string

Property Value

Inherited From ControlBarButtonProps.htmlFor

httpEquiv?: string

Property Value

Inherited From ControlBarButtonProps.httpEquiv

The props for the icon shown in the button.

iconProps?: IIconProps

Property Value

Inherited From ControlBarButtonProps.iconProps

id?: string

Property Value

Inherited From ControlBarButtonProps.id

inlist?: any

Property Value

Inherited From ControlBarButtonProps.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?: "search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"

Property Value

Inherited From ControlBarButtonProps.inputMode

integrity?: string

Property Value

Inherited From ControlBarButtonProps.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 ControlBarButtonProps.is

itemID?: string

Property Value

Inherited From ControlBarButtonProps.itemID

itemProp?: string

Property Value

Inherited From ControlBarButtonProps.itemProp

itemRef?: string

Property Value

Inherited From ControlBarButtonProps.itemRef

itemScope?: boolean

Property Value

Inherited From ControlBarButtonProps.itemScope

itemType?: string

Property Value

Inherited From ControlBarButtonProps.itemType

keyParams?: string

Property Value

Inherited From ControlBarButtonProps.keyParams

Optional keytip for this button

keytipProps?: IKeytipProps

Property Value

Inherited From ControlBarButtonProps.keytipProps

keyType?: string

Property Value

Inherited From ControlBarButtonProps.keyType

kind?: string

Property Value

Inherited From ControlBarButtonProps.kind

label?: string

Property Value

Inherited From ControlBarButtonProps.label

Key to use for the Label component

labelKey?: string

Property Value

Inherited From ControlBarButtonProps.labelKey

lang?: string

Property Value

Inherited From ControlBarButtonProps.lang

list?: string

Property Value

Inherited From ControlBarButtonProps.list

loop?: boolean

Property Value

Inherited From ControlBarButtonProps.loop

low?: number

Property Value

Inherited From ControlBarButtonProps.low

manifest?: string

Property Value

Inherited From ControlBarButtonProps.manifest

marginHeight?: number

Property Value

Inherited From ControlBarButtonProps.marginHeight

marginWidth?: number

Property Value

Inherited From ControlBarButtonProps.marginWidth

max?: string | number

Property Value

Inherited From ControlBarButtonProps.max

maxLength?: number

Property Value

Inherited From ControlBarButtonProps.maxLength

media?: string

Property Value

Inherited From ControlBarButtonProps.media

mediaGroup?: string

Property Value

Inherited From ControlBarButtonProps.mediaGroup

Render a custom menu in place of the normal one.

menuAs?: IComponentAs<IContextualMenuProps>

Property Value

Inherited From ControlBarButtonProps.menuAs

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

menuIconProps?: IIconProps

Property Value

Inherited From ControlBarButtonProps.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 ControlBarButtonProps.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 ControlBarButtonProps.menuTriggerKeyCode

method?: string

Property Value

Inherited From ControlBarButtonProps.method

min?: string | number

Property Value

Inherited From ControlBarButtonProps.min

minLength?: number

Property Value

Inherited From ControlBarButtonProps.minLength

multiple?: boolean

Property Value

Inherited From ControlBarButtonProps.multiple

muted?: boolean

Property Value

Inherited From ControlBarButtonProps.muted

name?: string

Property Value

Inherited From ControlBarButtonProps.name

nonce?: string

Property Value

Inherited From ControlBarButtonProps.nonce

noValidate?: boolean

Property Value

Inherited From ControlBarButtonProps.noValidate

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

Property Value

Inherited From ControlBarButtonProps.onAbort

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

Property Value

Inherited From ControlBarButtonProps.onAbortCapture

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

onAfterMenuDismiss?: () => void

Property Value

Inherited From ControlBarButtonProps.onAfterMenuDismiss

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

Property Value

Inherited From ControlBarButtonProps.onAnimationEnd

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

Property Value

Inherited From ControlBarButtonProps.onAnimationEndCapture

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

Property Value

Inherited From ControlBarButtonProps.onAnimationIteration

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

Property Value

Inherited From ControlBarButtonProps.onAnimationIterationCapture

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

Property Value

Inherited From ControlBarButtonProps.onAnimationStart

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

Property Value

Inherited From ControlBarButtonProps.onAnimationStartCapture

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

Property Value

Inherited From ControlBarButtonProps.onAuxClick

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

Property Value

Inherited From ControlBarButtonProps.onAuxClickCapture

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

Property Value

Inherited From ControlBarButtonProps.onBeforeInput

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

Property Value

Inherited From ControlBarButtonProps.onBeforeInputCapture

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

Property Value

Inherited From ControlBarButtonProps.onBlur

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

Property Value

Inherited From ControlBarButtonProps.onBlurCapture

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

Property Value

Inherited From ControlBarButtonProps.onCanPlay

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

Property Value

Inherited From ControlBarButtonProps.onCanPlayCapture

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

Property Value

Inherited From ControlBarButtonProps.onCanPlayThrough

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

Property Value

Inherited From ControlBarButtonProps.onCanPlayThroughCapture

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

Property Value

Inherited From ControlBarButtonProps.onChange

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

Property Value

Inherited From ControlBarButtonProps.onChangeCapture

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

Property Value

Inherited From ControlBarButtonProps.onClick

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

Property Value

Inherited From ControlBarButtonProps.onClickCapture

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

Property Value

Inherited From ControlBarButtonProps.onCompositionEnd

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

Property Value

Inherited From ControlBarButtonProps.onCompositionEndCapture

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

Property Value

Inherited From ControlBarButtonProps.onCompositionStart

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

Property Value

Inherited From ControlBarButtonProps.onCompositionStartCapture

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

Property Value

Inherited From ControlBarButtonProps.onCompositionUpdate

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

Property Value

Inherited From ControlBarButtonProps.onCompositionUpdateCapture

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

Property Value

Inherited From ControlBarButtonProps.onContextMenu

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

Property Value

Inherited From ControlBarButtonProps.onContextMenuCapture

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

Property Value

Inherited From ControlBarButtonProps.onCopy

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

Property Value

Inherited From ControlBarButtonProps.onCopyCapture

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

Property Value

Inherited From ControlBarButtonProps.onCut

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

Property Value

Inherited From ControlBarButtonProps.onCutCapture

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

Property Value

Inherited From ControlBarButtonProps.onDoubleClick

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

Property Value

Inherited From ControlBarButtonProps.onDoubleClickCapture

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

Property Value

Inherited From ControlBarButtonProps.onDrag

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

Property Value

Inherited From ControlBarButtonProps.onDragCapture

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

Property Value

Inherited From ControlBarButtonProps.onDragEnd

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

Property Value

Inherited From ControlBarButtonProps.onDragEndCapture

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

Property Value

Inherited From ControlBarButtonProps.onDragEnter

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

Property Value

Inherited From ControlBarButtonProps.onDragEnterCapture

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

Property Value

Inherited From ControlBarButtonProps.onDragExit

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

Property Value

Inherited From ControlBarButtonProps.onDragExitCapture

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

Property Value

Inherited From ControlBarButtonProps.onDragLeave

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

Property Value

Inherited From ControlBarButtonProps.onDragLeaveCapture

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

Property Value

Inherited From ControlBarButtonProps.onDragOver

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

Property Value

Inherited From ControlBarButtonProps.onDragOverCapture

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

Property Value

Inherited From ControlBarButtonProps.onDragStart

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

Property Value

Inherited From ControlBarButtonProps.onDragStartCapture

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

Property Value

Inherited From ControlBarButtonProps.onDrop

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

Property Value

Inherited From ControlBarButtonProps.onDropCapture

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

Property Value

Inherited From ControlBarButtonProps.onDurationChange

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

Property Value

Inherited From ControlBarButtonProps.onDurationChangeCapture

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

Property Value

Inherited From ControlBarButtonProps.onEmptied

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

Property Value

Inherited From ControlBarButtonProps.onEmptiedCapture

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

Property Value

Inherited From ControlBarButtonProps.onEncrypted

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

Property Value

Inherited From ControlBarButtonProps.onEncryptedCapture

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

Property Value

Inherited From ControlBarButtonProps.onEnded

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

Property Value

Inherited From ControlBarButtonProps.onEndedCapture

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

Property Value

Inherited From ControlBarButtonProps.onError

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

Property Value

Inherited From ControlBarButtonProps.onErrorCapture

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

Property Value

Inherited From ControlBarButtonProps.onFocus

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

Property Value

Inherited From ControlBarButtonProps.onFocusCapture

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

Property Value

Inherited From ControlBarButtonProps.onGotPointerCapture

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

Property Value

Inherited From ControlBarButtonProps.onGotPointerCaptureCapture

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

Property Value

Inherited From ControlBarButtonProps.onInput

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

Property Value

Inherited From ControlBarButtonProps.onInputCapture

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

Property Value

Inherited From ControlBarButtonProps.onInvalid

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

Property Value

Inherited From ControlBarButtonProps.onInvalidCapture

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

Property Value

Inherited From ControlBarButtonProps.onKeyDown

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

Property Value

Inherited From ControlBarButtonProps.onKeyDownCapture

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

Property Value

Inherited From ControlBarButtonProps.onKeyPress

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

Property Value

Inherited From ControlBarButtonProps.onKeyPressCapture

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

Property Value

Inherited From ControlBarButtonProps.onKeyUp

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

Property Value

Inherited From ControlBarButtonProps.onKeyUpCapture

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

Property Value

Inherited From ControlBarButtonProps.onLoad

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

Property Value

Inherited From ControlBarButtonProps.onLoadCapture

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

Property Value

Inherited From ControlBarButtonProps.onLoadedData

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

Property Value

Inherited From ControlBarButtonProps.onLoadedDataCapture

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

Property Value

Inherited From ControlBarButtonProps.onLoadedMetadata

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

Property Value

Inherited From ControlBarButtonProps.onLoadedMetadataCapture

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

Property Value

Inherited From ControlBarButtonProps.onLoadStart

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

Property Value

Inherited From ControlBarButtonProps.onLoadStartCapture

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

Property Value

Inherited From ControlBarButtonProps.onLostPointerCapture

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

Property Value

Inherited From ControlBarButtonProps.onLostPointerCaptureCapture

Optional callback when menu is clicked.

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

Property Value

Inherited From ControlBarButtonProps.onMenuClick

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

Property Value

Inherited From ControlBarButtonProps.onMouseDown

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

Property Value

Inherited From ControlBarButtonProps.onMouseDownCapture

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

Property Value

Inherited From ControlBarButtonProps.onMouseEnter

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

Property Value

Inherited From ControlBarButtonProps.onMouseLeave

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

Property Value

Inherited From ControlBarButtonProps.onMouseMove

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

Property Value

Inherited From ControlBarButtonProps.onMouseMoveCapture

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

Property Value

Inherited From ControlBarButtonProps.onMouseOut

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

Property Value

Inherited From ControlBarButtonProps.onMouseOutCapture

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

Property Value

Inherited From ControlBarButtonProps.onMouseOver

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

Property Value

Inherited From ControlBarButtonProps.onMouseOverCapture

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

Property Value

Inherited From ControlBarButtonProps.onMouseUp

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

Property Value

Inherited From ControlBarButtonProps.onMouseUpCapture

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

Property Value

Inherited From ControlBarButtonProps.onPaste

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

Property Value

Inherited From ControlBarButtonProps.onPasteCapture

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

Property Value

Inherited From ControlBarButtonProps.onPause

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

Property Value

Inherited From ControlBarButtonProps.onPauseCapture

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

Property Value

Inherited From ControlBarButtonProps.onPlay

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

Property Value

Inherited From ControlBarButtonProps.onPlayCapture

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

Property Value

Inherited From ControlBarButtonProps.onPlaying

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

Property Value

Inherited From ControlBarButtonProps.onPlayingCapture

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

Property Value

Inherited From ControlBarButtonProps.onPointerCancel

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

Property Value

Inherited From ControlBarButtonProps.onPointerCancelCapture

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

Property Value

Inherited From ControlBarButtonProps.onPointerDown

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

Property Value

Inherited From ControlBarButtonProps.onPointerDownCapture

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

Property Value

Inherited From ControlBarButtonProps.onPointerEnter

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

Property Value

Inherited From ControlBarButtonProps.onPointerEnterCapture

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

Property Value

Inherited From ControlBarButtonProps.onPointerLeave

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

Property Value

Inherited From ControlBarButtonProps.onPointerLeaveCapture

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

Property Value

Inherited From ControlBarButtonProps.onPointerMove

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

Property Value

Inherited From ControlBarButtonProps.onPointerMoveCapture

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

Property Value

Inherited From ControlBarButtonProps.onPointerOut

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

Property Value

Inherited From ControlBarButtonProps.onPointerOutCapture

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

Property Value

Inherited From ControlBarButtonProps.onPointerOver

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

Property Value

Inherited From ControlBarButtonProps.onPointerOverCapture

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

Property Value

Inherited From ControlBarButtonProps.onPointerUp

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

Property Value

Inherited From ControlBarButtonProps.onPointerUpCapture

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

Property Value

Inherited From ControlBarButtonProps.onProgress

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

Property Value

Inherited From ControlBarButtonProps.onProgressCapture

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

Property Value

Inherited From ControlBarButtonProps.onRateChange

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

Property Value

Inherited From ControlBarButtonProps.onRateChangeCapture

Custom render function for the aria description element.

onRenderAriaDescription?: IRenderFunction<IButtonProps>

Property Value

Inherited From ControlBarButtonProps.onRenderAriaDescription

Custom render function for rendering the button children.

onRenderChildren?: IRenderFunction<IButtonProps>

Property Value

Inherited From ControlBarButtonProps.onRenderChildren

Custom render function for the description text.

onRenderDescription?: IRenderFunction<IButtonProps>

Property Value

Inherited From ControlBarButtonProps.onRenderDescription

Custom render function for the icon

onRenderIcon?: IRenderFunction<IButtonProps>

Property Value

Inherited From ControlBarButtonProps.onRenderIcon

onRenderMenu?: IRenderFunction<IContextualMenuProps>

Property Value

Inherited From ControlBarButtonProps.onRenderMenu

Custom render function for button menu icon

onRenderMenuIcon?: IRenderFunction<IButtonProps>

Property Value

Inherited From ControlBarButtonProps.onRenderMenuIcon

Icon to render when the button is not checked.

onRenderOffIcon?: IRenderFunction<IButtonProps>

Property Value

Inherited From ControlBarButtonProps.onRenderOffIcon

Icon to render when the button is checked.

onRenderOnIcon?: IRenderFunction<IButtonProps>

Property Value

Inherited From ControlBarButtonProps.onRenderOnIcon

Custom render function for the label text.

onRenderText?: IRenderFunction<IButtonProps>

Property Value

Inherited From ControlBarButtonProps.onRenderText

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

Property Value

Inherited From ControlBarButtonProps.onReset

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

Property Value

Inherited From ControlBarButtonProps.onResetCapture

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

Property Value

Inherited From ControlBarButtonProps.onScroll

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

Property Value

Inherited From ControlBarButtonProps.onScrollCapture

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

Property Value

Inherited From ControlBarButtonProps.onSeeked

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

Property Value

Inherited From ControlBarButtonProps.onSeekedCapture

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

Property Value

Inherited From ControlBarButtonProps.onSeeking

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

Property Value

Inherited From ControlBarButtonProps.onSeekingCapture

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

Property Value

Inherited From ControlBarButtonProps.onSelect

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

Property Value

Inherited From ControlBarButtonProps.onSelectCapture

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

Property Value

Inherited From ControlBarButtonProps.onStalled

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

Property Value

Inherited From ControlBarButtonProps.onStalledCapture

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

Property Value

Inherited From ControlBarButtonProps.onSubmit

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

Property Value

Inherited From ControlBarButtonProps.onSubmitCapture

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

Property Value

Inherited From ControlBarButtonProps.onSuspend

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

Property Value

Inherited From ControlBarButtonProps.onSuspendCapture

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

Property Value

Inherited From ControlBarButtonProps.onTimeUpdate

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

Property Value

Inherited From ControlBarButtonProps.onTimeUpdateCapture

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

Property Value

Inherited From ControlBarButtonProps.onTouchCancel

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

Property Value

Inherited From ControlBarButtonProps.onTouchCancelCapture

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

Property Value

Inherited From ControlBarButtonProps.onTouchEnd

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

Property Value

Inherited From ControlBarButtonProps.onTouchEndCapture

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

Property Value

Inherited From ControlBarButtonProps.onTouchMove

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

Property Value

Inherited From ControlBarButtonProps.onTouchMoveCapture

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

Property Value

Inherited From ControlBarButtonProps.onTouchStart

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

Property Value

Inherited From ControlBarButtonProps.onTouchStartCapture

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

Property Value

Inherited From ControlBarButtonProps.onTransitionEnd

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

Property Value

Inherited From ControlBarButtonProps.onTransitionEndCapture

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

Property Value

Inherited From ControlBarButtonProps.onVolumeChange

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

Property Value

Inherited From ControlBarButtonProps.onVolumeChangeCapture

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

Property Value

Inherited From ControlBarButtonProps.onWaiting

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

Property Value

Inherited From ControlBarButtonProps.onWaitingCapture

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

Property Value

Inherited From ControlBarButtonProps.onWheel

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

Property Value

Inherited From ControlBarButtonProps.onWheelCapture

open?: boolean

Property Value

Inherited From ControlBarButtonProps.open

optimum?: number

Property Value

Inherited From ControlBarButtonProps.optimum

pattern?: string

Property Value

Inherited From ControlBarButtonProps.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 ControlBarButtonProps.persistMenu

placeholder?: string

Property Value

Inherited From ControlBarButtonProps.placeholder

playsInline?: boolean

Property Value

Inherited From ControlBarButtonProps.playsInline

poster?: string

Property Value

Inherited From ControlBarButtonProps.poster

prefix?: string

Property Value

Inherited From ControlBarButtonProps.prefix

preload?: string

Property Value

Inherited From ControlBarButtonProps.preload

Changes the visual presentation of the button to be emphasized.

primary?: boolean

Property Value

Inherited From ControlBarButtonProps.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 ControlBarButtonProps.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 ControlBarButtonProps.primaryDisabled

property?: string

Property Value

Inherited From ControlBarButtonProps.property

radioGroup?: string

Property Value

Inherited From ControlBarButtonProps.radioGroup

readOnly?: boolean

Property Value

Inherited From ControlBarButtonProps.readOnly

rel?: string

Property Value

Inherited From ControlBarButtonProps.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 ControlBarButtonProps.renderPersistedMenuHiddenOnMount

required?: boolean

Property Value

Inherited From ControlBarButtonProps.required

resource?: string

Property Value

Inherited From ControlBarButtonProps.resource

results?: number

Property Value

Inherited From ControlBarButtonProps.results

rev?: string

Property Value

Inherited From ControlBarButtonProps.rev

reversed?: boolean

Property Value

Inherited From ControlBarButtonProps.reversed

role?: AriaRole

Property Value

Inherited From ControlBarButtonProps.role

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

Property Value

Inherited From ControlBarButtonProps.rootProps

rows?: number

Property Value

Inherited From ControlBarButtonProps.rows

rowSpan?: number

Property Value

Inherited From ControlBarButtonProps.rowSpan

sandbox?: string

Property Value

Inherited From ControlBarButtonProps.sandbox

scope?: string

Property Value

Inherited From ControlBarButtonProps.scope

scoped?: boolean

Property Value

Inherited From ControlBarButtonProps.scoped

scrolling?: string

Property Value

Inherited From ControlBarButtonProps.scrolling

seamless?: boolean

Property Value

Inherited From ControlBarButtonProps.seamless

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

secondaryText?: string

Property Value

Inherited From ControlBarButtonProps.secondaryText

security?: string

Property Value

Inherited From ControlBarButtonProps.security

selected?: boolean

Property Value

Inherited From ControlBarButtonProps.selected

shape?: string

Property Value

Inherited From ControlBarButtonProps.shape

Whether the label is displayed or not.

showLabel?: boolean

Property Value

Inherited From ControlBarButtonProps.showLabel

size?: number

Property Value

Inherited From ControlBarButtonProps.size

sizes?: string

Property Value

Inherited From ControlBarButtonProps.sizes

slot?: string

Property Value

Inherited From ControlBarButtonProps.slot

span?: number

Property Value

Inherited From ControlBarButtonProps.span

spellCheck?: Booleanish

Property Value

Inherited From ControlBarButtonProps.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 ControlBarButtonProps.split

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

splitButtonAriaLabel?: string

Property Value

Inherited From ControlBarButtonProps.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 ControlBarButtonProps.splitButtonMenuProps

src?: string

Property Value

Inherited From ControlBarButtonProps.src

srcDoc?: string

Property Value

Inherited From ControlBarButtonProps.srcDoc

srcLang?: string

Property Value

Inherited From ControlBarButtonProps.srcLang

srcSet?: string

Property Value

Inherited From ControlBarButtonProps.srcSet

start?: number

Property Value

Inherited From ControlBarButtonProps.start

step?: string | number

Property Value

Inherited From ControlBarButtonProps.step

style?: CSSProperties

Property Value

Inherited From ControlBarButtonProps.style

summary?: string

Property Value

Inherited From ControlBarButtonProps.summary

suppressContentEditableWarning?: boolean

Property Value

Inherited From ControlBarButtonProps.suppressContentEditableWarning

suppressHydrationWarning?: boolean

Property Value

Inherited From ControlBarButtonProps.suppressHydrationWarning

tabIndex?: number

Property Value

Inherited From ControlBarButtonProps.tabIndex

target?: string

Property Value

Inherited From ControlBarButtonProps.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 ControlBarButtonProps.text

Theme provided by HOC.

theme?: ITheme

Property Value

Inherited From ControlBarButtonProps.theme

title?: string

Property Value

Inherited From ControlBarButtonProps.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 ControlBarButtonProps.toggle

toggled?: boolean

Property Value

Inherited From ControlBarButtonProps.toggled

Id to use for the tooltip host.

tooltipId?: string

Property Value

Inherited From ControlBarButtonProps.tooltipId

translate?: "yes" | "no"

Property Value

Inherited From ControlBarButtonProps.translate

type?: string

Property Value

Inherited From ControlBarButtonProps.type

typeof?: string

Property Value

Inherited From ControlBarButtonProps.typeof

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

uniqueId?: string | number

Property Value

Inherited From ControlBarButtonProps.uniqueId

unselectable?: "on" | "off"

Property Value

Inherited From ControlBarButtonProps.unselectable

useMap?: string

Property Value

Inherited From ControlBarButtonProps.useMap

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

Property Value

Inherited From ControlBarButtonProps.value

vocab?: string

Property Value

Inherited From ControlBarButtonProps.vocab

width?: string | number

Property Value

Inherited From ControlBarButtonProps.width

wmode?: string

Property Value

Inherited From ControlBarButtonProps.wmode

wrap?: string

Property Value

Inherited From ControlBarButtonProps.wrap