Boolean if the tab is currently active. Only one tab should be active at a
time.
Optional aria-activedescendant
aria-activedescendant?:string
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
Optional aria-atomic
aria-atomic?:Booleanish
Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
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.
Optional aria-busy
aria-busy?:Booleanish
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.
Indicates what functions can be performed when a dragged object is released on the drop target.
deprecated
in ARIA 1.1
Optional aria-errormessage
aria-errormessage?:string
Identifies the element that provides an error message for the object.
see
aria-invalid @see aria-describedby.
Optional aria-expanded
aria-expanded?:Booleanish
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
Optional aria-flowto
aria-flowto?:string
Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,
allows assistive technology to override the general default of reading in document source order.
Optional aria-grabbed
aria-grabbed?:Booleanish
Indicates an element's "grabbed" state in a drag-and-drop operation.
Indicates the entered value does not conform to the format expected by the application.
see
aria-errormessage.
Optional aria-keyshortcuts
aria-keyshortcuts?:string
Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
Optional aria-label
aria-label?:string
Defines a string value that labels the current element.
see
aria-labelledby.
Optional aria-labelledby
aria-labelledby?:string
Identifies the element (or elements) that labels the current element.
see
aria-describedby.
Optional aria-level
aria-level?:number
Defines the hierarchical level of an element within a structure.
Optional aria-live
aria-live?:"off" | "assertive" | "polite"
Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
Optional aria-modal
aria-modal?:Booleanish
Indicates whether an element is modal when displayed.
Optional aria-multiline
aria-multiline?:Booleanish
Indicates whether a text box accepts multiple lines of input or only a single line.
Optional aria-multiselectable
aria-multiselectable?:Booleanish
Indicates that the user may select more than one item from the current selectable descendants.
Optional aria-orientation
aria-orientation?:"horizontal" | "vertical"
Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
Optional aria-owns
aria-owns?:string
Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
between DOM elements where the DOM hierarchy cannot be used to represent the relationship.
see
aria-controls.
Optional aria-placeholder
aria-placeholder?:string
Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
A hint could be a sample value or a brief description of the expected format.
Optional aria-posinset
aria-posinset?:number
Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
Indicates if items in a table or grid are sorted in ascending or descending order.
Optional aria-valuemax
aria-valuemax?:number
Defines the maximum allowed value for a range widget.
Optional aria-valuemin
aria-valuemin?:number
Defines the minimum allowed value for a range widget.
Optional aria-valuenow
aria-valuenow?:number
Defines the current value for a range widget.
see
aria-valuetext.
Optional aria-valuetext
aria-valuetext?:string
Defines the human readable text alternative of aria-valuenow for a range widget.
Optional autoCapitalize
autoCapitalize?:string
Optional autoCorrect
autoCorrect?:string
Optional autoSave
autoSave?:string
Optional children
children?:ReactNode
The children to display in the tab. This is required and should normally
just be text or an icon.
Optional className
className?:string
An optional className to apply to the tab.
Optional color
color?:string
Optional contentClassName
contentClassName?:string
An optional className to apply to the <span> surrounding the children
of the Tab. You probably won't need to use this.
Optional contentEditable
contentEditable?:Booleanish | "inherit"
Optional contentStyle
contentStyle?:CSSProperties
An optional style to apply to the <span> surrounding the children of
the Tab. You probably won't need to use this.
Optional contextMenu
contextMenu?:string
Optional dangerouslySetInnerHTML
dangerouslySetInnerHTML?:{ __html: string }
Type declaration
__html: string
Optional datatype
datatype?:string
Optional defaultChecked
defaultChecked?:boolean
Optional defaultValue
defaultValue?:string | number | readonly string[]
Optional dir
dir?:string
Optional disableEnterClick
disableEnterClick?:boolean
Boolean if the enter keyboard click polyfill should be completely disabled.
This is generally used if the keyboard functionality is already built-in to
the element like buttons or labels.
Optional disablePressedFallback
disablePressedFallback?:boolean
Boolean if the component should fallback to using the custom pressed class
names when ripples are disabled.
defaultvalue
false
Optional disableProgrammaticRipple
disableProgrammaticRipple?:boolean
Boolean if the ripple component should not be triggered after a
"programmatic" ripple effect. This would be if the .click() function is
called on an element through javascript or some other means.
Optional disableRipple
disableRipple?:boolean
Boolean if the ripple effect should be disabled for all child components
that use the Ripple states.
Optional disabled
disabled?:boolean
Boolean if the tab should be disabled.
Optional draggable
draggable?:Booleanish
Optional enablePressedAndRipple
enablePressedAndRipple?:boolean
Boolean if the element should be able to gain both the ripple effect and
the pressed states changes. This will only be enabled if both the
disableRipple and disabledPressedFallback are still false
An optional object of event handlers to merge with the required
ripple trigger event handlers.
Optional hidden
hidden?:boolean
Optional icon
icon?:ReactNode
An optional icon to render in the Tab along with the normal text. If you
want to have an icon only tab, you should not use this prop and instead
just provide the icon as the tab's children.
Optional iconAfter
iconAfter?:boolean
Boolean if the icon should appear after the text instead of before. When
the stacked prop is also enabled, it will cause the icon to appear below
the text instead of above.
id
id:string
The id for the tab. This is required for a11y and linking the TabPanel to
a specific tab.
The id for the TabPanel that the Tab controls. This is really just used
to create an aria-controls attribute on the Tab itself, but Googling
this results in some "interesting" results showing aria-controls doesn't
really do much so this prop can be omitted.
In addition, if you are using dynamically rendered tab panels, this value
should only be provided when the tab becomes active as the id will not
exist in the DOM until then and will be invalid.
Optional placeholder
placeholder?:string
Optional prefix
prefix?:string
Optional property
property?:string
Optional radioGroup
radioGroup?:string
Optional resource
resource?:string
Optional results
results?:number
Optional rippleClassName
rippleClassName?:string
An optional className to apply to the ripple element.
Optional rippleClassNames
rippleClassNames?:CSSTransitionClassNames
The class names to apply during the different stages for the ripple
animation. You probably don't want to use this.
Optional rippleContainerClassName
rippleContainerClassName?:string
An optional className to apply to the ripple's container element.
Optional rippleTimeout
rippleTimeout?:TransitionTimeout
The amount of time before a ripple finishes its animation. You probably
don't want to change this value unless you updated the duration in scss or
changed the different class names for the ripple animation.
Optional role
role?:AriaRole
Optional security
security?:string
Optional slot
slot?:string
Optional spellCheck
spellCheck?:Booleanish
Optional stacked
stacked?:boolean
Boolean if the icon and text should be stacked instead of rendered inline.
This is only valid when the icon prop has been provided.
Boolean if the tab is currently active. Only one tab should be active at a time.