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.
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
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.
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 the current "checked" state of checkboxes, radio buttons, and other widgets.
Defines the total number of columns in a table, grid, or treegrid.
Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
Identifies the element (or elements) whose contents or presence are controlled by the current element.
Indicates the element that represents the current item within a container or set of related elements.
Identifies the element (or elements) that describes the object.
Identifies the element that provides a detailed, extended description for the object.
Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
Indicates what functions can be performed when a dragged object is released on the drop target.
Identifies the element that provides an error message for the object.
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
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.
Indicates an element's "grabbed" state in a drag-and-drop operation.
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
Indicates whether the element is exposed to an accessibility API.
Indicates the entered value does not conform to the format expected by the application.
Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
Defines a string value that labels the current element.
Identifies the element (or elements) that labels the current element.
Defines the hierarchical level of an element within a structure.
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.
Indicates whether an element is modal when displayed.
Indicates whether a text box accepts multiple lines of input or only a single line.
Indicates that the user may select more than one item from the current selectable descendants.
Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
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.
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.
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 the current "pressed" state of toggle buttons.
Indicates that the element is not editable, but is otherwise operable.
Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
Indicates that user input is required on the element before a form may be submitted.
Defines a human-readable, author-localized description for the role of an element.
Defines the total number of rows in a table, grid, or treegrid.
Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
Indicates the current "selected" state of various widgets.
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.
Indicates if items in a table or grid are sorted in ascending or descending order.
Defines the maximum allowed value for a range widget.
Defines the minimum allowed value for a range widget.
Defines the current value for a range widget.
Defines the human readable text alternative of aria-valuenow for a range widget.
The center point for the circle. This should be half of the
99% of the time and probably won't be changed.
Boolean if the circular progress should be centered using left and right margins.
An optional className to apply to the circle within the circular progress.
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).
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.
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
Hints at the type of data that might be entered by the user while editing the element or its contents
Specify that a standard HTML element should behave like a defined custom built-in element
The max value for the progress component. This is used to determine the current progress percentage for screen readers and styles.
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.
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.
Boolean if the smaller size should be used instead.
An optional className to apply to the svg within the circular progress.
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).
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
props so that screen readers can be notified of changes.
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.
Generated using TypeDoc