Boolean if the determinate progress versions should animate when the value
changes. This should really only be enabled if you aren't getting quick
progress updates or the updates happen in chunks.
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 center
center?:number
The center point for the circle. This should be half of the viewBox prop
99% of the time and probably won't be changed.
Optional centered
centered?:boolean
Boolean if the circular progress should be centered using left and right
margins.
Optional children
children?:ReactNode
Optional circleClassName
circleClassName?:string
An optional className to apply to the circle within the circular progress.
Optional circleStyle
circleStyle?:CSSProperties
An optional style to apply to the circle within the circular progress. The
values of this style object will be merged with the current determinate
style (if it exists).
Optional className
className?:string
Optional color
color?:string
Optional contentEditable
contentEditable?:Booleanish | "inherit"
Optional contextMenu
contextMenu?:string
Optional dangerouslySetInnerHTML
dangerouslySetInnerHTML?:{ __html: string }
Type declaration
__html: string
Optional dashoffset
dashoffset?:number
The stroke-dashoffset for the circle within the SVG. You probably won't
be changing this value that much as it should match the
$rmd-progress-circle-dashoffset Sass variable. This is really just used
to help to create the determinate progress animation.
Optional datatype
datatype?:string
Optional defaultChecked
defaultChecked?:boolean
Optional defaultValue
defaultValue?:string | number | readonly string[]
Optional dir
dir?:string
Optional draggable
draggable?:Booleanish
Optional hidden
hidden?:boolean
id
id:string
The id for the progress component. This is required for accessibility since
the progress will 99% of the time be describing the progress of something
else within the page. The element that is loading or tracking progress
should also be updated to have aria-busy="true" and
aria-describedby="THIS_ID".
The max value for the progress component. This is used to determine the
current progress percentage for screen readers and styles.
Optional maxRotation
maxRotation?:number
The max rotation value for the circular progress. If you set this value to
a number less than or equal to 0, the circular progress will no longer
rotate with the determinate progress type.
Optional min
min?:number
The min value for the progress component. This is used to determine the
current progress percentage for screen readers and styles.
The radius for the circle. It is generally recommended to have the radius
be 1/2 of the viewbox and minus a few more pixels so that there is some
surrounding padding. You probably shouldn't really be changing this prop
though.
Optional resource
resource?:string
Optional results
results?:number
Optional role
role?:AriaRole
Optional security
security?:string
Optional slot
slot?:string
Optional small
small?:boolean
Boolean if the smaller size should be used instead.
remarks
@since 2.3.0
Optional spellCheck
spellCheck?:Booleanish
Optional style
style?:CSSProperties
Optional suppressContentEditableWarning
suppressContentEditableWarning?:boolean
Optional suppressHydrationWarning
suppressHydrationWarning?:boolean
Optional svgClassName
svgClassName?:string
An optional className to apply to the svg within the circular progress.
Optional svgStyle
svgStyle?:CSSProperties
An optional style to apply to the svg within the circular progress. The
values of this style object will be merged with the current determinate
style (if it exists).
Optional tabIndex
tabIndex?:number
Optional title
title?:string
Optional translate
translate?:"yes" | "no"
Optional typeof
typeof?:string
Optional unselectable
unselectable?:"on" | "off"
Optional value
value?:number
The current value for the progress component. If this prop is omitted, the
progress component will be put in an "indeterminate" state which will just
infinitely loop an animation until it is unmounted.
This value will be passed down as a percentage based on the min and max
props so that screen readers can be notified of changes.
Optional viewBox
viewBox?:string
The viewbox for the child svg. I wouldn't recommend changing this value as
you will also need to update the dashoffset in both Sass and this prop to
get the animation to look nice again.
Boolean if the determinate progress versions should animate when the value changes. This should really only be enabled if you aren't getting quick progress updates or the updates happen in chunks.