SwitchProps
the-cdj-ui / types/Switch.types / SwitchProps
Interface: SwitchProps
Extends
Omit
<MuiSwitchProps
,"color"
>
Properties
about?
optional
about:string
Inherited from
Omit.about
Defined in
node_modules/@types/react/index.d.ts:2920
accessKey?
optional
accessKey:string
Inherited from
Omit.accessKey
Defined in
node_modules/@types/react/index.d.ts:2895
action?
optional
action:Ref
<ButtonBaseActions
>
A ref for imperative actions.
It currently only supports focusVisible()
action.
Inherited from
Omit.action
Defined in
node_modules/@mui/material/ButtonBase/ButtonBase.d.ts:13
aria-activedescendant?
optional
aria-activedescendant:string
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
Inherited from
Omit.aria-activedescendant
Defined in
node_modules/@types/react/index.d.ts:2593
aria-atomic?
optional
aria-atomic:Booleanish
Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
Inherited from
Omit.aria-atomic
Defined in
node_modules/@types/react/index.d.ts:2595
aria-autocomplete?
optional
aria-autocomplete:"none"
|"inline"
|"both"
|"list"
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.
Inherited from
Omit.aria-autocomplete
Defined in
node_modules/@types/react/index.d.ts:2600
aria-braillelabel?
optional
aria-braillelabel:string
Defines a string value that labels the current element, which is intended to be converted into Braille.
See
aria-label.
Inherited from
Omit.aria-braillelabel
Defined in
node_modules/@types/react/index.d.ts:2606
aria-brailleroledescription?
optional
aria-brailleroledescription:string
Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
See
aria-roledescription.
Inherited from
Omit.aria-brailleroledescription
Defined in
node_modules/@types/react/index.d.ts:2611
aria-busy?
optional
aria-busy:Booleanish
Inherited from
Omit.aria-busy
Defined in
node_modules/@types/react/index.d.ts:2612
aria-checked?
optional
aria-checked:boolean
|"mixed"
|"false"
|"true"
Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
See
- aria-pressed
- aria-selected.
Inherited from
Omit.aria-checked
Defined in
node_modules/@types/react/index.d.ts:2617
aria-colcount?
optional
aria-colcount:number
Defines the total number of columns in a table, grid, or treegrid.
See
aria-colindex.
Inherited from
Omit.aria-colcount
Defined in
node_modules/@types/react/index.d.ts:2622
aria-colindex?
optional
aria-colindex:number
Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
See
- aria-colcount
- aria-colspan.
Inherited from
Omit.aria-colindex
Defined in
node_modules/@types/react/index.d.ts:2627
aria-colindextext?
optional
aria-colindextext:string
Defines a human readable text alternative of aria-colindex.
See
aria-rowindextext.
Inherited from
Omit.aria-colindextext
Defined in
node_modules/@types/react/index.d.ts:2632
aria-colspan?
optional
aria-colspan:number
Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
See
- aria-colindex
- aria-rowspan.
Inherited from
Omit.aria-colspan
Defined in
node_modules/@types/react/index.d.ts:2637
aria-controls?
optional
aria-controls:string
Identifies the element (or elements) whose contents or presence are controlled by the current element.
See
aria-owns.
Inherited from
Omit.aria-controls
Defined in
node_modules/@types/react/index.d.ts:2642
aria-current?
optional
aria-current:boolean
|"time"
|"page"
|"false"
|"true"
|"step"
|"location"
|"date"
Indicates the element that represents the current item within a container or set of related elements.
Inherited from
Omit.aria-current
Defined in
node_modules/@types/react/index.d.ts:2644
aria-describedby?
optional
aria-describedby:string
Identifies the element (or elements) that describes the object.
See
aria-labelledby
Inherited from
Omit.aria-describedby
Defined in
node_modules/@types/react/index.d.ts:2649
aria-description?
optional
aria-description:string
Defines a string value that describes or annotates the current element.
See
related aria-describedby.
Inherited from
Omit.aria-description
Defined in
node_modules/@types/react/index.d.ts:2654
aria-details?
optional
aria-details:string
Identifies the element that provides a detailed, extended description for the object.
See
aria-describedby.
Inherited from
Omit.aria-details
Defined in
node_modules/@types/react/index.d.ts:2659
aria-disabled?
optional
aria-disabled:Booleanish
Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
See
- aria-hidden
- aria-readonly.
Inherited from
Omit.aria-disabled
Defined in
node_modules/@types/react/index.d.ts:2664
aria-dropeffect?
optional
aria-dropeffect:"none"
|"link"
|"copy"
|"move"
|"execute"
|"popup"
Indicates what functions can be performed when a dragged object is released on the drop target.
Deprecated
in ARIA 1.1
Inherited from
Omit.aria-dropeffect
Defined in
node_modules/@types/react/index.d.ts:2669
aria-errormessage?
optional
aria-errormessage:string
Identifies the element that provides an error message for the object.
See
- aria-invalid
- aria-describedby.
Inherited from
Omit.aria-errormessage
Defined in
node_modules/@types/react/index.d.ts:2674
aria-expanded?
optional
aria-expanded:Booleanish
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
Inherited from
Omit.aria-expanded
Defined in
node_modules/@types/react/index.d.ts:2676
aria-flowto?
optional
aria-flowto:string
Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.
Inherited from
Omit.aria-flowto
Defined in
node_modules/@types/react/index.d.ts:2681
aria-grabbed?
optional
aria-grabbed:Booleanish
Indicates an element's "grabbed" state in a drag-and-drop operation.
Deprecated
in ARIA 1.1
Inherited from
Omit.aria-grabbed
Defined in
node_modules/@types/react/index.d.ts:2686
aria-haspopup?
optional
aria-haspopup:boolean
|"dialog"
|"menu"
|"grid"
|"listbox"
|"false"
|"true"
|"tree"
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
Inherited from
Omit.aria-haspopup
Defined in
node_modules/@types/react/index.d.ts:2688
aria-hidden?
optional
aria-hidden:Booleanish
Indicates whether the element is exposed to an accessibility API.
See
aria-disabled.
Inherited from
Omit.aria-hidden
Defined in
node_modules/@types/react/index.d.ts:2693
aria-invalid?
optional
aria-invalid:boolean
|"false"
|"true"
|"grammar"
|"spelling"
Indicates the entered value does not conform to the format expected by the application.
See
aria-errormessage.
Inherited from
Omit.aria-invalid
Defined in
node_modules/@types/react/index.d.ts:2698
aria-keyshortcuts?
optional
aria-keyshortcuts:string
Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
Inherited from
Omit.aria-keyshortcuts
Defined in
node_modules/@types/react/index.d.ts:2700
aria-label?
optional
aria-label:string
Defines a string value that labels the current element.
See
aria-labelledby.
Inherited from
Omit.aria-label
Defined in
node_modules/@types/react/index.d.ts:2705
aria-labelledby?
optional
aria-labelledby:string
Identifies the element (or elements) that labels the current element.
See
aria-describedby.
Inherited from
Omit.aria-labelledby
Defined in
node_modules/@types/react/index.d.ts:2710
aria-level?
optional
aria-level:number
Defines the hierarchical level of an element within a structure.
Inherited from
Omit.aria-level
Defined in
node_modules/@types/react/index.d.ts:2712
aria-live?
optional
aria-live:"off"
|"assertive"
|"polite"
Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
Inherited from
Omit.aria-live
Defined in
node_modules/@types/react/index.d.ts:2714
aria-modal?
optional
aria-modal:Booleanish
Indicates whether an element is modal when displayed.
Inherited from
Omit.aria-modal
Defined in
node_modules/@types/react/index.d.ts:2716
aria-multiline?
optional
aria-multiline:Booleanish
Indicates whether a text box accepts multiple lines of input or only a single line.
Inherited from
Omit.aria-multiline
Defined in
node_modules/@types/react/index.d.ts:2718
aria-multiselectable?
optional
aria-multiselectable:Booleanish
Indicates that the user may select more than one item from the current selectable descendants.
Inherited from
Omit.aria-multiselectable
Defined in
node_modules/@types/react/index.d.ts:2720
aria-orientation?
optional
aria-orientation:"horizontal"
|"vertical"
Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
Inherited from
Omit.aria-orientation
Defined in
node_modules/@types/react/index.d.ts:2722
aria-owns?
optional
aria-owns:string
Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.
See
aria-controls.
Inherited from
Omit.aria-owns
Defined in
node_modules/@types/react/index.d.ts:2728
aria-placeholder?
optional
aria-placeholder:string
Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.
Inherited from
Omit.aria-placeholder
Defined in
node_modules/@types/react/index.d.ts:2733
aria-posinset?
optional
aria-posinset:number
Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
See
aria-setsize.
Inherited from
Omit.aria-posinset
Defined in
node_modules/@types/react/index.d.ts:2738
aria-pressed?
optional
aria-pressed:boolean
|"mixed"
|"false"
|"true"
Indicates the current "pressed" state of toggle buttons.
See
- aria-checked
- aria-selected.
Inherited from
Omit.aria-pressed
Defined in
node_modules/@types/react/index.d.ts:2743
aria-readonly?
optional
aria-readonly:Booleanish
Indicates that the element is not editable, but is otherwise operable.
See
aria-disabled.
Inherited from
Omit.aria-readonly
Defined in
node_modules/@types/react/index.d.ts:2748
aria-relevant?
optional
aria-relevant:"text"
|"all"
|"additions"
|"additions removals"
|"additions text"
|"removals"
|"removals additions"
|"removals text"
|"text additions"
|"text removals"
Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
See
aria-atomic.
Inherited from
Omit.aria-relevant
Defined in
node_modules/@types/react/index.d.ts:2753
aria-required?
optional
aria-required:Booleanish
Indicates that user input is required on the element before a form may be submitted.
Inherited from
Omit.aria-required
Defined in
node_modules/@types/react/index.d.ts:2766
aria-roledescription?
optional
aria-roledescription:string
Defines a human-readable, author-localized description for the role of an element.
Inherited from
Omit.aria-roledescription
Defined in
node_modules/@types/react/index.d.ts:2768
aria-rowcount?
optional
aria-rowcount:number
Defines the total number of rows in a table, grid, or treegrid.
See
aria-rowindex.
Inherited from
Omit.aria-rowcount
Defined in
node_modules/@types/react/index.d.ts:2773
aria-rowindex?
optional
aria-rowindex:number
Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
See
- aria-rowcount
- aria-rowspan.
Inherited from
Omit.aria-rowindex
Defined in
node_modules/@types/react/index.d.ts:2778
aria-rowindextext?
optional
aria-rowindextext:string
Defines a human readable text alternative of aria-rowindex.
See
aria-colindextext.
Inherited from
Omit.aria-rowindextext
Defined in
node_modules/@types/react/index.d.ts:2783
aria-rowspan?
optional
aria-rowspan:number
Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
See
- aria-rowindex
- aria-colspan.
Inherited from
Omit.aria-rowspan
Defined in
node_modules/@types/react/index.d.ts:2788
aria-selected?
optional
aria-selected:Booleanish
Indicates the current "selected" state of various widgets.
See
- aria-checked
- aria-pressed.
Inherited from
Omit.aria-selected
Defined in
node_modules/@types/react/index.d.ts:2793
aria-setsize?
optional
aria-setsize:number
Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
See
aria-posinset.
Inherited from
Omit.aria-setsize
Defined in
node_modules/@types/react/index.d.ts:2798
aria-sort?
optional
aria-sort:"none"
|"ascending"
|"descending"
|"other"
Indicates if items in a table or grid are sorted in ascending or descending order.
Inherited from
Omit.aria-sort
Defined in
node_modules/@types/react/index.d.ts:2800
aria-valuemax?
optional
aria-valuemax:number
Defines the maximum allowed value for a range widget.
Inherited from
Omit.aria-valuemax
Defined in
node_modules/@types/react/index.d.ts:2802
aria-valuemin?
optional
aria-valuemin:number
Defines the minimum allowed value for a range widget.
Inherited from
Omit.aria-valuemin
Defined in
node_modules/@types/react/index.d.ts:2804
aria-valuenow?
optional
aria-valuenow:number
Defines the current value for a range widget.
See
aria-valuetext.
Inherited from
Omit.aria-valuenow
Defined in
node_modules/@types/react/index.d.ts:2809
aria-valuetext?
optional
aria-valuetext:string
Defines the human readable text alternative of aria-valuenow for a range widget.
Inherited from
Omit.aria-valuetext
Defined in
node_modules/@types/react/index.d.ts:2811
ariaLabel?
optional
ariaLabel:string
Defined in
src/types/Switch.types.d.ts:21
autoCapitalize?
optional
autoCapitalize:string
Inherited from
Omit.autoCapitalize
Defined in
node_modules/@types/react/index.d.ts:2933
autoCorrect?
optional
autoCorrect:string
Inherited from
Omit.autoCorrect
Defined in
node_modules/@types/react/index.d.ts:2934
autoFocus?
optional
autoFocus:boolean
Inherited from
Omit.autoFocus
Defined in
node_modules/@mui/material/internal/SwitchBase.d.ts:8
autoSave?
optional
autoSave:string
Inherited from
Omit.autoSave
Defined in
node_modules/@types/react/index.d.ts:2935
centerRipple?
optional
centerRipple:boolean
If true
, the ripples are centered.
They won't start at the cursor interaction position.
Default
false
Inherited from
Omit.centerRipple
Defined in
node_modules/@mui/material/ButtonBase/ButtonBase.d.ts:19
checked?
optional
checked:boolean
If true
, the component is checked.
Overrides
Omit.checked
Defined in
checkedIcon?
optional
checkedIcon:ReactNode
The icon to display when the component is checked.
Inherited from
Omit.checkedIcon
Defined in
node_modules/@mui/material/Switch/Switch.d.ts:17
classes?
optional
classes:Partial
<SwitchClasses
>
Override or extend the styles applied to the component.
Inherited from
Omit.classes
Defined in
node_modules/@mui/material/Switch/Switch.d.ts:21
className?
optional
className:string
Inherited from
Omit.className
Defined in
node_modules/@mui/material/OverridableComponent.d.ts:60
color?
optional
color:"default"
|"primary"
|"secondary"
|"error"
|"success"
|"info"
|"warning"
Defined in
component?
optional
component:ElementType
<any
, keyof IntrinsicElements>
Inherited from
Omit.component
Defined in
node_modules/@mui/material/ButtonBase/ButtonBase.d.ts:130
content?
optional
content:string
Inherited from
Omit.content
Defined in
node_modules/@types/react/index.d.ts:2921
contentEditable?
optional
contentEditable:"inherit"
|Booleanish
|"plaintext-only"
Inherited from
Omit.contentEditable
Defined in
node_modules/@types/react/index.d.ts:2898
contextMenu?
optional
contextMenu:string
Inherited from
Omit.contextMenu
Defined in
node_modules/@types/react/index.d.ts:2899
dangerouslySetInnerHTML?
optional
dangerouslySetInnerHTML:object
__html
__html:
string
|TrustedHTML
Inherited from
Omit.dangerouslySetInnerHTML
Defined in
node_modules/@types/react/index.d.ts:2380
datatype?
optional
datatype:string
Inherited from
Omit.datatype
Defined in
node_modules/@types/react/index.d.ts:2922
defaultChecked?
optional
defaultChecked:boolean
The default checked state. Use when the component is not controlled.
Inherited from
Omit.defaultChecked
Defined in
node_modules/@mui/material/internal/SwitchBase.d.ts:21
defaultValue?
optional
defaultValue:string
|number
| readonlystring
[]
Inherited from
Omit.defaultValue
Defined in
node_modules/@types/react/index.d.ts:2890
dir?
optional
dir:string
Inherited from
Omit.dir
Defined in
node_modules/@types/react/index.d.ts:2900
disabled?
optional
disabled:boolean
If true
, the component is disabled.
Overrides
Omit.disabled
Defined in
src/types/Switch.types.d.ts:16
disableFocusRipple?
optional
disableFocusRipple:boolean
If true
, the keyboard focus ripple is disabled.
Default
false
Inherited from
Omit.disableFocusRipple
Defined in
node_modules/@mui/material/internal/SwitchBase.d.ts:35
disableRipple?
optional
disableRipple:boolean
If true
, the ripple effect is disabled.
Default
false