CameraButtonProps interface
Props for CameraButton component.
- Extends
Properties
cameras | Available cameras for selection |
enable |
Whether to use a <xref:SplitButton> with a <xref:IContextualMenu> for device selection. default: false |
local |
Options for rendering local video view. |
on |
Callback when a camera is selected |
on |
Utility property for using this component with |
selected |
Camera that is shown as currently selected |
strings | Optional strings to override in component |
styles | Styles for CameraButton and the device selection flyout. |
Inherited Properties
about | |
accept | |
accept |
|
access |
|
action | |
allow |
Whether the button can have focus in disabled mode |
allow |
|
allow |
|
alt | |
aria-activedescendant | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
aria-atomic | 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-autocomplete | 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-busy | 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-checked | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. See aria-pressed See aria-selected. |
aria-colcount | Defines the total number of columns in a table, grid, or treegrid. See aria-colindex. |
aria-colindex | 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-colspan | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. See aria-colindex See aria-rowspan. |
aria-controls | Identifies the element (or elements) whose contents or presence are controlled by the current element. See aria-owns. |
aria-current | Indicates the element that represents the current item within a container or set of related elements. |
aria-describedby | Identifies the element (or elements) that describes the object. See aria-labelledby |
aria-details | Identifies the element that provides a detailed, extended description for the object. See aria-describedby. |
aria-disabled | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. See aria-hidden See aria-readonly. |
aria-dropeffect | Indicates what functions can be performed when a dragged object is released on the drop target. |
aria-errormessage | Identifies the element that provides an error message for the object. See aria-invalid See aria-describedby. |
aria-expanded | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
aria-flowto | 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-grabbed | Indicates an element's "grabbed" state in a drag-and-drop operation. |
aria-haspopup | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. |
aria-hidden | Indicates whether the element is exposed to an accessibility API. See aria-disabled. |
aria-invalid | Indicates the entered value does not conform to the format expected by the application. See aria-errormessage. |
aria-keyshortcuts | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
aria-label | Defines a string value that labels the current element. See aria-labelledby. |
aria-labelledby | Identifies the element (or elements) that labels the current element. See aria-describedby. |
aria-level | Defines the hierarchical level of an element within a structure. |
aria-live | 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-modal | Indicates whether an element is modal when displayed. |
aria-multiline | Indicates whether a text box accepts multiple lines of input or only a single line. |
aria-multiselectable | Indicates that the user may select more than one item from the current selectable descendants. |
aria-orientation | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. |
aria-owns | 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-placeholder | 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-posinset | 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-pressed | Indicates the current "pressed" state of toggle buttons. See aria-checked See aria-selected. |
aria-readonly | Indicates that the element is not editable, but is otherwise operable. See aria-disabled. |
aria-relevant | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. See aria-atomic. |
aria-required | Indicates that user input is required on the element before a form may be submitted. |
aria-roledescription | Defines a human-readable, author-localized description for the role of an element. |
aria-rowcount | Defines the total number of rows in a table, grid, or treegrid. See aria-rowindex. |
aria-rowindex | 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-rowspan | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. See aria-rowindex See aria-colspan. |
aria-selected | Indicates the current "selected" state of various widgets. See aria-checked See aria-pressed. |
aria-setsize | 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-sort | Indicates if items in a table or grid are sorted in ascending or descending order. |
aria-valuemax | Defines the maximum allowed value for a range widget. |
aria-valuemin | Defines the minimum allowed value for a range widget. |
aria-valuenow | Defines the current value for a range widget. See aria-valuetext. |
aria-valuetext | Defines the human readable text alternative of aria-valuenow for a range widget. |
aria |
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. |
aria |
If true, add an |
aria |
The aria label of the button for the benefit of screen readers. |
as | |
async | |
auto |
|
auto |
|
auto |
|
auto |
|
auto |
|
auto |
|
button |
|
capture | |
cell |
|
cell |
|
challenge | |
char |
|
checked | Whether the button is checked. Should be used with the |
children | |
cite | |
classID | |
class |
If provided, additional class name to provide on the root element. |
color | |
cols | |
col |
|
component |
Optional callback to access the |
content | |
content |
|
context |
|
controls | |
coords | |
cross |
|
dangerously |
|
data | Any custom data the developer wishes to associate with the button. |
datatype | |
date |
|
default | |
default |
|
default |
yet unknown docs |
default |
|
defer | |
description | Style for the description text if applicable (for compound buttons). |
dir | |
disabled | Whether the button is disabled |
download | |
draggable | |
element |
Optional callback to access the root DOM element. |
enc |
|
enter |
|
form | |
form |
|
form |
|
form |
|
form |
|
form |
|
frame |
|
get |
Method to provide the classnames to style a button.
The default value for this prop is the |
get |
Method to provide the classnames to style a button.
The default value for this prop is the |
headers | |
height | |
hidden | |
high | |
href | If provided, this component will be rendered as an anchor. |
href |
|
html |
|
http |
|
icon |
The props for the icon shown in the button. |
id | |
inlist | |
input |
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 |
integrity | |
is | 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 |
itemID | |
item |
|
item |
|
item |
|
item |
|
key |
|
keytip |
Optional keytip for this button |
key |
|
kind | |
label | |
label |
Key to use for the Label component |
lang | |
list | |
loop | |
low | |
manifest | |
margin |
|
margin |
|
max | |
max |
|
media | |
media |
|
menu |
Render a custom menu in place of the normal one. |
menu |
The props for the icon shown when providing a menu dropdown. |
menu |
Props for button menu. Providing this will default to showing the menu icon. See |
menu |
Provides a custom KeyCode that can be used to open the button menu.
A value of |
method | |
min | |
min |
|
multiple | |
muted | |
name | |
nonce | |
no |
|
on |
|
on |
|
on |
Callback that runs after Button's contextual menu was closed (removed from the DOM) |
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
Optional callback when menu is clicked. |
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
Custom render function for the aria description element. |
on |
Custom render function for rendering the button children. |
on |
Custom render function for the description text. |
on |
Custom render function for the icon |
on |
|
on |
Custom render function for button menu icon |
on |
Icon to render when the button is not checked. |
on |
Icon to render when the button is checked. |
on |
Custom render function for the label text. |
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
on |
|
open | |
optimum | |
pattern | |
persist |
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. |
placeholder | |
plays |
|
poster | |
prefix | |
preload | |
primary | Changes the visual presentation of the button to be emphasized. |
primary |
Optional props to be applied only to the primary action button of SplitButton and not to the overall SplitButton container |
primary |
If set to true and this is a split button ( |
property | |
radio |
|
read |
|
rel | |
render |
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. |
required | |
resource | |
results | |
rev | |
reversed | |
role | |
root |
|
rows | |
row |
|
sandbox | |
scope | |
scoped | |
scrolling | |
seamless | |
secondary |
Description of the action this button takes. Only used for compound buttons. |
security | |
selected | |
shape | |
show |
Whether the label is displayed or not. |
size | |
sizes | |
slot | |
span | |
spell |
|
split | If set to true, and if |
split |
Accessible label for the dropdown chevron button if this button is split. |
split |
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. |
src | |
src |
|
src |
|
src |
|
start | |
step | |
style | |
summary | |
suppress |
|
suppress |
|
tab |
|
target | |
text | 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. |
theme | Theme provided by HOC. |
title | |
toggle | 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. |
toggled | |
tooltip |
Id to use for the tooltip host. |
translate | |
type | |
typeof | |
unique |
Unique ID to identify the item. Typically a duplicate of key value. |
unselectable | |
use |
|
value | |
vocab | |
width | |
wmode | |
wrap |
Property Details
cameras
enableDeviceSelectionMenu
Whether to use a <xref:SplitButton> with a <xref:IContextualMenu> for device selection.
default: false
enableDeviceSelectionMenu?: boolean
Property Value
boolean
localVideoViewOptions
Options for rendering local video view.
localVideoViewOptions?: VideoStreamOptions
Property Value
onSelectCamera
Callback when a camera is selected
onSelectCamera?: (device: OptionsDevice) => Promise<void>
Property Value
(device: OptionsDevice) => Promise<void>
onToggleCamera
Utility property for using this component with communication react eventHandlers
.
Maps directly to the onClick
property.
onToggleCamera?: (options?: VideoStreamOptions) => Promise<void>
Property Value
(options?: VideoStreamOptions) => Promise<void>
selectedCamera
Camera that is shown as currently selected
selectedCamera?: OptionsDevice
Property Value
strings
Optional strings to override in component
strings?: Partial<CameraButtonStrings>
Property Value
Partial<CameraButtonStrings>
styles
Styles for CameraButton and the device selection flyout.
styles?: Partial<CameraButtonStyles>
Property Value
Partial<CameraButtonStyles>
Inherited Property Details
about
accept
acceptCharset
accessKey
action
allowDisabledFocus
Whether the button can have focus in disabled mode
allowDisabledFocus?: boolean
Property Value
boolean
Inherited From ControlBarButtonProps.allowDisabledFocus
allowFullScreen
allowFullScreen?: boolean
Property Value
boolean
Inherited From ControlBarButtonProps.allowFullScreen
allowTransparency
allowTransparency?: boolean
Property Value
boolean
Inherited From ControlBarButtonProps.allowTransparency
alt
aria-activedescendant
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-activedescendant?: string
Property Value
string
Inherited From ControlBarButtonProps.aria-activedescendant
aria-atomic
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
Booleanish
Inherited From ControlBarButtonProps.aria-atomic
aria-autocomplete
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
"none" | "list" | "inline" | "both"
Inherited From ControlBarButtonProps.aria-autocomplete
aria-busy
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
Booleanish
Inherited From ControlBarButtonProps.aria-busy
aria-checked
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
boolean | "true" | "false" | "mixed"
Inherited From ControlBarButtonProps.aria-checked
aria-colcount
Defines the total number of columns in a table, grid, or treegrid.
See aria-colindex.
aria-colcount?: number
Property Value
number
Inherited From ControlBarButtonProps.aria-colcount
aria-colindex
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
number
Inherited From ControlBarButtonProps.aria-colindex
aria-colspan
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
number
Inherited From ControlBarButtonProps.aria-colspan
aria-controls
Identifies the element (or elements) whose contents or presence are controlled by the current element.
See aria-owns.
aria-controls?: string
Property Value
string
Inherited From ControlBarButtonProps.aria-controls
aria-current
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
boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"
Inherited From ControlBarButtonProps.aria-current
aria-describedby
Identifies the element (or elements) that describes the object.
See aria-labelledby
aria-describedby?: string
Property Value
string
Inherited From ControlBarButtonProps.aria-describedby
aria-details
Identifies the element that provides a detailed, extended description for the object.
See aria-describedby.
aria-details?: string
Property Value
string
Inherited From ControlBarButtonProps.aria-details
aria-disabled
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
Booleanish
Inherited From ControlBarButtonProps.aria-disabled
aria-dropeffect
Warning
This API is now deprecated.
in ARIA 1.1
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
"none" | "link" | "copy" | "execute" | "move" | "popup"
Inherited From ControlBarButtonProps.aria-dropeffect
aria-errormessage
Identifies the element that provides an error message for the object.
See aria-invalid See aria-describedby.
aria-errormessage?: string
Property Value
string
Inherited From ControlBarButtonProps.aria-errormessage
aria-expanded
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-expanded?: Booleanish
Property Value
Booleanish
Inherited From ControlBarButtonProps.aria-expanded
aria-flowto
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
string
Inherited From ControlBarButtonProps.aria-flowto
aria-grabbed
Warning
This API is now deprecated.
in ARIA 1.1
Indicates an element's "grabbed" state in a drag-and-drop operation.
aria-grabbed?: Booleanish
Property Value
Booleanish
Inherited From ControlBarButtonProps.aria-grabbed
aria-haspopup
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
boolean | "true" | "false" | "dialog" | "grid" | "listbox" | "menu" | "tree"
Inherited From ControlBarButtonProps.aria-haspopup
aria-hidden
Indicates whether the element is exposed to an accessibility API.
See aria-disabled.
aria-hidden?: Booleanish
Property Value
Booleanish
Inherited From ControlBarButtonProps.aria-hidden
aria-invalid
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
boolean | "true" | "false" | "grammar" | "spelling"
Inherited From ControlBarButtonProps.aria-invalid
aria-keyshortcuts
Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-keyshortcuts?: string
Property Value
string
Inherited From ControlBarButtonProps.aria-keyshortcuts
aria-label
Defines a string value that labels the current element.
See aria-labelledby.
aria-label?: string
Property Value
string
Inherited From ControlBarButtonProps.aria-label
aria-labelledby
Identifies the element (or elements) that labels the current element.
See aria-describedby.
aria-labelledby?: string
Property Value
string
Inherited From ControlBarButtonProps.aria-labelledby
aria-level
Defines the hierarchical level of an element within a structure.
aria-level?: number
Property Value
number
Inherited From ControlBarButtonProps.aria-level
aria-live
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
"off" | "assertive" | "polite"
Inherited From ControlBarButtonProps.aria-live
aria-modal
Indicates whether an element is modal when displayed.
aria-modal?: Booleanish
Property Value
Booleanish
Inherited From ControlBarButtonProps.aria-modal
aria-multiline
Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiline?: Booleanish
Property Value
Booleanish
Inherited From ControlBarButtonProps.aria-multiline
aria-multiselectable
Indicates that the user may select more than one item from the current selectable descendants.
aria-multiselectable?: Booleanish
Property Value
Booleanish
Inherited From ControlBarButtonProps.aria-multiselectable
aria-orientation
Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-orientation?: "horizontal" | "vertical"
Property Value
"horizontal" | "vertical"
Inherited From ControlBarButtonProps.aria-orientation
aria-owns
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
string
Inherited From ControlBarButtonProps.aria-owns
aria-placeholder
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
string
Inherited From ControlBarButtonProps.aria-placeholder
aria-posinset
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
number
Inherited From ControlBarButtonProps.aria-posinset
aria-pressed
Indicates the current "pressed" state of toggle buttons.
See aria-checked See aria-selected.
aria-pressed?: boolean | "true" | "false" | "mixed"
Property Value
boolean | "true" | "false" | "mixed"
Inherited From ControlBarButtonProps.aria-pressed
aria-readonly
Indicates that the element is not editable, but is otherwise operable.
See aria-disabled.
aria-readonly?: Booleanish
Property Value
Booleanish
Inherited From ControlBarButtonProps.aria-readonly
aria-relevant
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
"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"
Inherited From ControlBarButtonProps.aria-relevant
aria-required
Indicates that user input is required on the element before a form may be submitted.
aria-required?: Booleanish
Property Value
Booleanish
Inherited From ControlBarButtonProps.aria-required
aria-roledescription
Defines a human-readable, author-localized description for the role of an element.
aria-roledescription?: string
Property Value
string
Inherited From ControlBarButtonProps.aria-roledescription
aria-rowcount
Defines the total number of rows in a table, grid, or treegrid.
See aria-rowindex.
aria-rowcount?: number
Property Value
number
Inherited From ControlBarButtonProps.aria-rowcount
aria-rowindex
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
number
Inherited From ControlBarButtonProps.aria-rowindex
aria-rowspan
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
number
Inherited From ControlBarButtonProps.aria-rowspan
aria-selected
Indicates the current "selected" state of various widgets.
See aria-checked See aria-pressed.
aria-selected?: Booleanish
Property Value
Booleanish
Inherited From ControlBarButtonProps.aria-selected
aria-setsize
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
number
Inherited From ControlBarButtonProps.aria-setsize
aria-sort
Indicates if items in a table or grid are sorted in ascending or descending order.
aria-sort?: "none" | "ascending" | "descending" | "other"
Property Value
"none" | "ascending" | "descending" | "other"
Inherited From ControlBarButtonProps.aria-sort
aria-valuemax
Defines the maximum allowed value for a range widget.
aria-valuemax?: number
Property Value
number
Inherited From ControlBarButtonProps.aria-valuemax
aria-valuemin
Defines the minimum allowed value for a range widget.
aria-valuemin?: number
Property Value
number
Inherited From ControlBarButtonProps.aria-valuemin
aria-valuenow
Defines the current value for a range widget.
See aria-valuetext.
aria-valuenow?: number
Property Value
number
Inherited From ControlBarButtonProps.aria-valuenow
aria-valuetext
Defines the human readable text alternative of aria-valuenow for a range widget.
aria-valuetext?: string
Property Value
string
Inherited From ControlBarButtonProps.aria-valuetext
ariaDescription
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
string
Inherited From ControlBarButtonProps.ariaDescription
ariaHidden
If true, add an aria-hidden
attribute instructing screen readers to ignore the element.
ariaHidden?: boolean
Property Value
boolean
Inherited From ControlBarButtonProps.ariaHidden
ariaLabel
The aria label of the button for the benefit of screen readers.
ariaLabel?: string
Property Value
string
Inherited From ControlBarButtonProps.ariaLabel
as
async
autoCapitalize
autoCapitalize?: "off" | "none" | "on" | "sentences" | "words" | "characters" | (string & {})
Property Value
"off" | "none" | "on" | "sentences" | "words" | "characters" | (string & {})
Inherited From ControlBarButtonProps.autoCapitalize
autoComplete
autoCorrect
autoFocus
autoPlay
autoSave
buttonType
Warning
This API is now deprecated.
Deprecated at v1.2.3, to be removed at >= v2.0.0. Use specific button component instead.
buttonType?: ButtonType
Property Value
ButtonType
Inherited From ControlBarButtonProps.buttonType
capture
capture?: boolean | "user" | "environment"
Property Value
boolean | "user" | "environment"
Inherited From ControlBarButtonProps.capture
cellPadding
cellPadding?: string | number
Property Value
string | number
Inherited From ControlBarButtonProps.cellPadding
cellSpacing
cellSpacing?: string | number
Property Value
string | number
Inherited From ControlBarButtonProps.cellSpacing
challenge
charSet
checked
Whether the button is checked. Should be used with the toggle
attribute when creating a standalone on/off button.
checked?: boolean
Property Value
boolean
Inherited From ControlBarButtonProps.checked
children
cite
classID
className
If provided, additional class name to provide on the root element.
className?: string
Property Value
string
Inherited From ControlBarButtonProps.className
color
cols
colSpan
componentRef
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
IRefObject<IButton>
Inherited From ControlBarButtonProps.componentRef
content
contentEditable
contentEditable?: Booleanish | "inherit"
Property Value
Booleanish | "inherit"
Inherited From ControlBarButtonProps.contentEditable
contextMenu
controls
coords
crossOrigin
crossOrigin?: CrossOrigin
Property Value
CrossOrigin
Inherited From ControlBarButtonProps.crossOrigin
dangerouslySetInnerHTML
dangerouslySetInnerHTML?: { __html: string | TrustedHTML }
Property Value
{ __html: string | TrustedHTML }
Inherited From ControlBarButtonProps.dangerouslySetInnerHTML
data
Any custom data the developer wishes to associate with the button.
data?: any
Property Value
any
Inherited From ControlBarButtonProps.data
datatype
dateTime
default
defaultChecked
defaultRender
yet unknown docs
defaultRender?: any
Property Value
any
Inherited From ControlBarButtonProps.defaultRender
defaultValue
defaultValue?: string | number | (readonly string[])
Property Value
string | number | (readonly string[])
Inherited From ControlBarButtonProps.defaultValue
defer
description
Warning
This API is now deprecated.
Use secondaryText
instead.
Style for the description text if applicable (for compound buttons).
description?: string
Property Value
string
Inherited From ControlBarButtonProps.description
dir
disabled
Whether the button is disabled
disabled?: boolean
Property Value
boolean
Inherited From ControlBarButtonProps.disabled
download
draggable
elementRef
Warning
This API is now deprecated.
Temporary solution which will be replaced with ref in the V8 release.
Optional callback to access the root DOM element.
elementRef?: Ref<HTMLElement>
Property Value
Ref<HTMLElement>
Inherited From ControlBarButtonProps.elementRef
encType
enterKeyHint
enterKeyHint?: "enter" | "done" | "go" | "next" | "previous" | "search" | "send"
Property Value
"enter" | "done" | "go" | "next" | "previous" | "search" | "send"
Inherited From ControlBarButtonProps.enterKeyHint
form
formAction
formEncType
formMethod
formNoValidate
formTarget
frameBorder
frameBorder?: string | number
Property Value
string | number
Inherited From ControlBarButtonProps.frameBorder
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
.
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
(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
Inherited From ControlBarButtonProps.getClassNames
getSplitButtonClassNames
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
(disabled: boolean, expanded: boolean, checked: boolean, allowDisabledFocus: boolean) => ISplitButtonClassNames
Inherited From ControlBarButtonProps.getSplitButtonClassNames
headers
height
hidden
high
href
If provided, this component will be rendered as an anchor.
href?: string
Property Value
string
Inherited From ControlBarButtonProps.href
hrefLang
htmlFor
httpEquiv
iconProps
The props for the icon shown in the button.
iconProps?: IIconProps
Property Value
IIconProps
Inherited From ControlBarButtonProps.iconProps
id
inlist
inputMode
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
"none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"
Inherited From ControlBarButtonProps.inputMode
integrity
is
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
string
Inherited From ControlBarButtonProps.is
itemID
itemProp
itemRef
itemScope
itemType
keyParams
keytipProps
Optional keytip for this button
keytipProps?: IKeytipProps
Property Value
IKeytipProps
Inherited From ControlBarButtonProps.keytipProps
keyType
kind
label
labelKey
Key to use for the Label component
labelKey?: string
Property Value
string
Inherited From ControlBarButtonProps.labelKey
lang
list
loop
low
manifest
marginHeight
marginWidth
max
maxLength
media
mediaGroup
menuAs
Render a custom menu in place of the normal one.
menuAs?: IComponentAs<IContextualMenuProps>
Property Value
IComponentAs<IContextualMenuProps>
Inherited From ControlBarButtonProps.menuAs
menuIconProps
The props for the icon shown when providing a menu dropdown.
menuIconProps?: IIconProps
Property Value
IIconProps
Inherited From ControlBarButtonProps.menuIconProps
menuProps
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
IContextualMenuProps
Inherited From ControlBarButtonProps.menuProps
menuTriggerKeyCode
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
null | number
Inherited From ControlBarButtonProps.menuTriggerKeyCode
method
min
minLength
multiple
muted
name
nonce
noValidate
onAbort
onAbort?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onAbort
onAbortCapture
onAbortCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onAbortCapture
onAfterMenuDismiss
Callback that runs after Button's contextual menu was closed (removed from the DOM)
onAfterMenuDismiss?: () => void
Property Value
() => void
Inherited From ControlBarButtonProps.onAfterMenuDismiss
onAnimationEnd
onAnimationEnd?: AnimationEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
AnimationEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onAnimationEnd
onAnimationEndCapture
onAnimationEndCapture?: AnimationEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
AnimationEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onAnimationEndCapture
onAnimationIteration
onAnimationIteration?: AnimationEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
AnimationEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onAnimationIteration
onAnimationIterationCapture
onAnimationIterationCapture?: AnimationEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
AnimationEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onAnimationIterationCapture
onAnimationStart
onAnimationStart?: AnimationEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
AnimationEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onAnimationStart
onAnimationStartCapture
onAnimationStartCapture?: AnimationEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
AnimationEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onAnimationStartCapture
onAuxClick
onAuxClick?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onAuxClick
onAuxClickCapture
onAuxClickCapture?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onAuxClickCapture
onBeforeInput
onBeforeInput?: FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onBeforeInput
onBeforeInputCapture
onBeforeInputCapture?: FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onBeforeInputCapture
onBlur
onBlur?: FocusEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
FocusEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onBlur
onBlurCapture
onBlurCapture?: FocusEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
FocusEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onBlurCapture
onCanPlay
onCanPlay?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onCanPlay
onCanPlayCapture
onCanPlayCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onCanPlayCapture
onCanPlayThrough
onCanPlayThrough?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onCanPlayThrough
onCanPlayThroughCapture
onCanPlayThroughCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onCanPlayThroughCapture
onChange
onChange?: FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onChange
onChangeCapture
onChangeCapture?: FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onChangeCapture
onClick
onClick?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onClick
onClickCapture
onClickCapture?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onClickCapture
onCompositionEnd
onCompositionEnd?: CompositionEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
CompositionEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onCompositionEnd
onCompositionEndCapture
onCompositionEndCapture?: CompositionEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
CompositionEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onCompositionEndCapture
onCompositionStart
onCompositionStart?: CompositionEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
CompositionEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onCompositionStart
onCompositionStartCapture
onCompositionStartCapture?: CompositionEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
CompositionEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onCompositionStartCapture
onCompositionUpdate
onCompositionUpdate?: CompositionEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
CompositionEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onCompositionUpdate
onCompositionUpdateCapture
onCompositionUpdateCapture?: CompositionEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
CompositionEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onCompositionUpdateCapture
onContextMenu
onContextMenu?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onContextMenu
onContextMenuCapture
onContextMenuCapture?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onContextMenuCapture
onCopy
onCopy?: ClipboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ClipboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onCopy
onCopyCapture
onCopyCapture?: ClipboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ClipboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onCopyCapture
onCut
onCut?: ClipboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ClipboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onCut
onCutCapture
onCutCapture?: ClipboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ClipboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onCutCapture
onDoubleClick
onDoubleClick?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onDoubleClick
onDoubleClickCapture
onDoubleClickCapture?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onDoubleClickCapture
onDrag
onDrag?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onDrag
onDragCapture
onDragCapture?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onDragCapture
onDragEnd
onDragEnd?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onDragEnd
onDragEndCapture
onDragEndCapture?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onDragEndCapture
onDragEnter
onDragEnter?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onDragEnter
onDragEnterCapture
onDragEnterCapture?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onDragEnterCapture
onDragExit
onDragExit?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onDragExit
onDragExitCapture
onDragExitCapture?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onDragExitCapture
onDragLeave
onDragLeave?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onDragLeave
onDragLeaveCapture
onDragLeaveCapture?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onDragLeaveCapture
onDragOver
onDragOver?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onDragOver
onDragOverCapture
onDragOverCapture?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onDragOverCapture
onDragStart
onDragStart?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onDragStart
onDragStartCapture
onDragStartCapture?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onDragStartCapture
onDrop
onDrop?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onDrop
onDropCapture
onDropCapture?: DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
DragEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onDropCapture
onDurationChange
onDurationChange?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onDurationChange
onDurationChangeCapture
onDurationChangeCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onDurationChangeCapture
onEmptied
onEmptied?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onEmptied
onEmptiedCapture
onEmptiedCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onEmptiedCapture
onEncrypted
onEncrypted?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onEncrypted
onEncryptedCapture
onEncryptedCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onEncryptedCapture
onEnded
onEnded?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onEnded
onEndedCapture
onEndedCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onEndedCapture
onError
onError?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onError
onErrorCapture
onErrorCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onErrorCapture
onFocus
onFocus?: FocusEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
FocusEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onFocus
onFocusCapture
onFocusCapture?: FocusEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
FocusEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onFocusCapture
onGotPointerCapture
onGotPointerCapture?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onGotPointerCapture
onGotPointerCaptureCapture
onGotPointerCaptureCapture?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onGotPointerCaptureCapture
onInput
onInput?: FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onInput
onInputCapture
onInputCapture?: FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onInputCapture
onInvalid
onInvalid?: FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onInvalid
onInvalidCapture
onInvalidCapture?: FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onInvalidCapture
onKeyDown
onKeyDown?: KeyboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
KeyboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onKeyDown
onKeyDownCapture
onKeyDownCapture?: KeyboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
KeyboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onKeyDownCapture
onKeyPress
Warning
This API is now deprecated.
onKeyPress?: KeyboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
KeyboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onKeyPress
onKeyPressCapture
Warning
This API is now deprecated.
onKeyPressCapture?: KeyboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
KeyboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onKeyPressCapture
onKeyUp
onKeyUp?: KeyboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
KeyboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onKeyUp
onKeyUpCapture
onKeyUpCapture?: KeyboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
KeyboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onKeyUpCapture
onLoad
onLoad?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onLoad
onLoadCapture
onLoadCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onLoadCapture
onLoadedData
onLoadedData?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onLoadedData
onLoadedDataCapture
onLoadedDataCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onLoadedDataCapture
onLoadedMetadata
onLoadedMetadata?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onLoadedMetadata
onLoadedMetadataCapture
onLoadedMetadataCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onLoadedMetadataCapture
onLoadStart
onLoadStart?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onLoadStart
onLoadStartCapture
onLoadStartCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onLoadStartCapture
onLostPointerCapture
onLostPointerCapture?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onLostPointerCapture
onLostPointerCaptureCapture
onLostPointerCaptureCapture?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onLostPointerCaptureCapture
onMenuClick
Optional callback when menu is clicked.
onMenuClick?: (ev?: MouseEvent<HTMLElement, MouseEvent> | KeyboardEvent<HTMLElement>, button?: IButtonProps) => void
Property Value
(ev?: MouseEvent<HTMLElement, MouseEvent> | KeyboardEvent<HTMLElement>, button?: IButtonProps) => void
Inherited From ControlBarButtonProps.onMenuClick
onMouseDown
onMouseDown?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onMouseDown
onMouseDownCapture
onMouseDownCapture?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onMouseDownCapture
onMouseEnter
onMouseEnter?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onMouseEnter
onMouseLeave
onMouseLeave?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onMouseLeave
onMouseMove
onMouseMove?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onMouseMove
onMouseMoveCapture
onMouseMoveCapture?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onMouseMoveCapture
onMouseOut
onMouseOut?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onMouseOut
onMouseOutCapture
onMouseOutCapture?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onMouseOutCapture
onMouseOver
onMouseOver?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onMouseOver
onMouseOverCapture
onMouseOverCapture?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onMouseOverCapture
onMouseUp
onMouseUp?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onMouseUp
onMouseUpCapture
onMouseUpCapture?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
MouseEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onMouseUpCapture
onPaste
onPaste?: ClipboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ClipboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onPaste
onPasteCapture
onPasteCapture?: ClipboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ClipboardEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onPasteCapture
onPause
onPause?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onPause
onPauseCapture
onPauseCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onPauseCapture
onPlay
onPlay?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onPlay
onPlayCapture
onPlayCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onPlayCapture
onPlaying
onPlaying?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onPlaying
onPlayingCapture
onPlayingCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onPlayingCapture
onPointerCancel
onPointerCancel?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onPointerCancel
onPointerCancelCapture
onPointerCancelCapture?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onPointerCancelCapture
onPointerDown
onPointerDown?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onPointerDown
onPointerDownCapture
onPointerDownCapture?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onPointerDownCapture
onPointerEnter
onPointerEnter?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onPointerEnter
onPointerEnterCapture
Warning
This API is now deprecated.
This event handler was always ignored by React. It was added by mistake to the types.
onPointerEnterCapture?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onPointerEnterCapture
onPointerLeave
onPointerLeave?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onPointerLeave
onPointerLeaveCapture
Warning
This API is now deprecated.
This event handler was always ignored by React. It was added by mistake to the types.
onPointerLeaveCapture?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onPointerLeaveCapture
onPointerMove
onPointerMove?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onPointerMove
onPointerMoveCapture
onPointerMoveCapture?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onPointerMoveCapture
onPointerOut
onPointerOut?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onPointerOut
onPointerOutCapture
onPointerOutCapture?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onPointerOutCapture
onPointerOver
onPointerOver?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onPointerOver
onPointerOverCapture
onPointerOverCapture?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onPointerOverCapture
onPointerUp
onPointerUp?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onPointerUp
onPointerUpCapture
onPointerUpCapture?: PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
PointerEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onPointerUpCapture
onProgress
onProgress?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onProgress
onProgressCapture
onProgressCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onProgressCapture
onRateChange
onRateChange?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onRateChange
onRateChangeCapture
onRateChangeCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onRateChangeCapture
onRenderAriaDescription
Custom render function for the aria description element.
onRenderAriaDescription?: IRenderFunction<IButtonProps>
Property Value
IRenderFunction<IButtonProps>
Inherited From ControlBarButtonProps.onRenderAriaDescription
onRenderChildren
Custom render function for rendering the button children.
onRenderChildren?: IRenderFunction<IButtonProps>
Property Value
IRenderFunction<IButtonProps>
Inherited From ControlBarButtonProps.onRenderChildren
onRenderDescription
Custom render function for the description text.
onRenderDescription?: IRenderFunction<IButtonProps>
Property Value
IRenderFunction<IButtonProps>
Inherited From ControlBarButtonProps.onRenderDescription
onRenderIcon
Custom render function for the icon
onRenderIcon?: IRenderFunction<IButtonProps>
Property Value
IRenderFunction<IButtonProps>
Inherited From ControlBarButtonProps.onRenderIcon
onRenderMenu
Warning
This API is now deprecated.
Deprecated at v6.3.2, to be removed at >= v7.0.0.
Use menuAs
instead.
onRenderMenu?: IRenderFunction<IContextualMenuProps>
Property Value
IRenderFunction<IContextualMenuProps>
Inherited From ControlBarButtonProps.onRenderMenu
onRenderMenuIcon
Custom render function for button menu icon
onRenderMenuIcon?: IRenderFunction<IButtonProps>
Property Value
IRenderFunction<IButtonProps>
Inherited From ControlBarButtonProps.onRenderMenuIcon
onRenderOffIcon
Icon to render when the button is not checked.
onRenderOffIcon?: IRenderFunction<IButtonProps>
Property Value
IRenderFunction<IButtonProps>
Inherited From ControlBarButtonProps.onRenderOffIcon
onRenderOnIcon
Icon to render when the button is checked.
onRenderOnIcon?: IRenderFunction<IButtonProps>
Property Value
IRenderFunction<IButtonProps>
Inherited From ControlBarButtonProps.onRenderOnIcon
onRenderText
Custom render function for the label text.
onRenderText?: IRenderFunction<IButtonProps>
Property Value
IRenderFunction<IButtonProps>
Inherited From ControlBarButtonProps.onRenderText
onReset
onReset?: FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onReset
onResetCapture
onResetCapture?: FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onResetCapture
onScroll
onScroll?: UIEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
UIEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onScroll
onScrollCapture
onScrollCapture?: UIEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
UIEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onScrollCapture
onSeeked
onSeeked?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onSeeked
onSeekedCapture
onSeekedCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onSeekedCapture
onSeeking
onSeeking?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onSeeking
onSeekingCapture
onSeekingCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onSeekingCapture
onSelect
onSelect?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onSelect
onSelectCapture
onSelectCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onSelectCapture
onStalled
onStalled?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onStalled
onStalledCapture
onStalledCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onStalledCapture
onSubmit
onSubmit?: FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onSubmit
onSubmitCapture
onSubmitCapture?: FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
FormEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onSubmitCapture
onSuspend
onSuspend?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onSuspend
onSuspendCapture
onSuspendCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onSuspendCapture
onTimeUpdate
onTimeUpdate?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onTimeUpdate
onTimeUpdateCapture
onTimeUpdateCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onTimeUpdateCapture
onTouchCancel
onTouchCancel?: TouchEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
TouchEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onTouchCancel
onTouchCancelCapture
onTouchCancelCapture?: TouchEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
TouchEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onTouchCancelCapture
onTouchEnd
onTouchEnd?: TouchEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
TouchEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onTouchEnd
onTouchEndCapture
onTouchEndCapture?: TouchEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
TouchEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onTouchEndCapture
onTouchMove
onTouchMove?: TouchEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
TouchEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onTouchMove
onTouchMoveCapture
onTouchMoveCapture?: TouchEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
TouchEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onTouchMoveCapture
onTouchStart
onTouchStart?: TouchEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
TouchEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onTouchStart
onTouchStartCapture
onTouchStartCapture?: TouchEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
TouchEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onTouchStartCapture
onTransitionEnd
onTransitionEnd?: TransitionEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
TransitionEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onTransitionEnd
onTransitionEndCapture
onTransitionEndCapture?: TransitionEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
TransitionEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onTransitionEndCapture
onVolumeChange
onVolumeChange?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onVolumeChange
onVolumeChangeCapture
onVolumeChangeCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onVolumeChangeCapture
onWaiting
onWaiting?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onWaiting
onWaitingCapture
onWaitingCapture?: ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
ReactEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onWaitingCapture
onWheel
onWheel?: WheelEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
WheelEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onWheel
onWheelCapture
onWheelCapture?: WheelEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Property Value
WheelEventHandler<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement | BaseButton | Button | HTMLSpanElement>
Inherited From ControlBarButtonProps.onWheelCapture
open
optimum
pattern
persistMenu
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
boolean
Inherited From ControlBarButtonProps.persistMenu
placeholder
playsInline
poster
prefix
preload
primary
Changes the visual presentation of the button to be emphasized.
primary?: boolean
Property Value
boolean
Inherited From ControlBarButtonProps.primary
primaryActionButtonProps
Optional props to be applied only to the primary action button of SplitButton and not to the overall SplitButton container
primaryActionButtonProps?: IButtonProps
Property Value
IButtonProps
Inherited From ControlBarButtonProps.primaryActionButtonProps
primaryDisabled
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
boolean
Inherited From ControlBarButtonProps.primaryDisabled
property
radioGroup
readOnly
rel
renderPersistedMenuHiddenOnMount
Warning
This API is now deprecated.
There is known bug in Edge when this prop is true where scrollbars overlap with the content when a menu is first rendered hidden. Please do not start using this. If you are already using this, please make sure that you are doing so only in non-Edge browsers. See: https://github.com/microsoft/fluentui/issues/9034
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
boolean
Inherited From ControlBarButtonProps.renderPersistedMenuHiddenOnMount
required
resource
results
rev
reversed
role
rootProps
Warning
This API is now deprecated.
Deprecated at v0.56.2, to be removed at >= v1.0.0. Use native props on the Button itself instead. They will be mixed into the button/anchor element rendered by the component.
rootProps?: ButtonHTMLAttributes<HTMLButtonElement> | AnchorHTMLAttributes<HTMLAnchorElement>
Property Value
ButtonHTMLAttributes<HTMLButtonElement> | AnchorHTMLAttributes<HTMLAnchorElement>
Inherited From ControlBarButtonProps.rootProps
rows
rowSpan
sandbox
scope
scoped
scrolling
seamless
secondaryText
Description of the action this button takes. Only used for compound buttons.
secondaryText?: string
Property Value
string
Inherited From ControlBarButtonProps.secondaryText
security
selected
shape
showLabel
Whether the label is displayed or not.
showLabel?: boolean
Property Value
boolean
Inherited From ControlBarButtonProps.showLabel
size
sizes
slot
span
spellCheck
split
If set to true, and if menuProps
and onClick
are provided, the button will render as a SplitButton.
split?: boolean
Property Value
boolean
Inherited From ControlBarButtonProps.split
splitButtonAriaLabel
Accessible label for the dropdown chevron button if this button is split.
splitButtonAriaLabel?: string
Property Value
string
Inherited From ControlBarButtonProps.splitButtonAriaLabel
splitButtonMenuProps
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
IButtonProps
Inherited From ControlBarButtonProps.splitButtonMenuProps
src
srcDoc
srcLang
srcSet
start
step
style
summary
suppressContentEditableWarning
suppressContentEditableWarning?: boolean
Property Value
boolean
Inherited From ControlBarButtonProps.suppressContentEditableWarning
suppressHydrationWarning
suppressHydrationWarning?: boolean
Property Value
boolean
Inherited From ControlBarButtonProps.suppressHydrationWarning
tabIndex
target
text
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
string
Inherited From ControlBarButtonProps.text
theme
Theme provided by HOC.
theme?: ITheme
Property Value
ITheme
Inherited From ControlBarButtonProps.theme
title
toggle
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
boolean
Inherited From ControlBarButtonProps.toggle
toggled
Warning
This API is now deprecated.
No longer used. Use checked
if setting state.
toggled?: boolean
Property Value
boolean
Inherited From ControlBarButtonProps.toggled
tooltipId
Id to use for the tooltip host.
tooltipId?: string
Property Value
string
Inherited From ControlBarButtonProps.tooltipId
translate
type
typeof
uniqueId
Unique ID to identify the item. Typically a duplicate of key value.
uniqueId?: string | number
Property Value
string | number
Inherited From ControlBarButtonProps.uniqueId
unselectable
unselectable?: "off" | "on"
Property Value
"off" | "on"
Inherited From ControlBarButtonProps.unselectable
useMap
value
value?: string | number | (readonly string[])
Property Value
string | number | (readonly string[])
Inherited From ControlBarButtonProps.value