Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mj12albert committed Jan 24, 2025
1 parent 3e71a35 commit d010114
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/reference/generated/progress-indicator.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ProgressIndicator",
"description": "Visualizes the completion status of the task.\nRenders a `<span>` element.",
"description": "Visualizes the completion status of the task.\nRenders a `<div>` element.",
"props": {
"className": {
"type": "string | (state) => string",
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/generated/progress-track.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ProgressTrack",
"description": "Contains the progress bar indicator.\nRenders a `<span>` element.",
"description": "Contains the progress bar indicator.\nRenders a `<div>` element.",
"props": {
"className": {
"type": "string | (state) => string",
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/generated/progress-value.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"name": "ProgressValue",
"description": "",
"description": "A text element displaying the current value.\nRenders a `<span>` element.",
"props": {
"className": {
"type": "string | (state) => string",
"description": "Class names applied to the element or a function that returns them based on the component's state."
"description": "CSS class applied to the element, or a function that\nreturns a class based on the components state."
},
"render": {
"type": "React.ReactElement | (props, state) => React.ReactElement",
"description": "A function to customize rendering of the component."
"description": "Allows you to replace the component’s HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
}
},
"dataAttributes": {},
Expand Down
8 changes: 6 additions & 2 deletions packages/react/src/progress/value/ProgressValue.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,15 @@ ProgressValue.propTypes /* remove-proptypes */ = {
*/
children: PropTypes.func,
/**
* Class names applied to the element or a function that returns them based on the component's state.
* CSS class applied to the element, or a function that
* returns a class based on the component’s state.
*/
className: PropTypes.oneOfType([PropTypes.func, PropTypes.string]),
/**
* A function to customize rendering of the component.
* Allows you to replace the component’s HTML element
* with a different tag, or compose it with another component.
*
* Accepts a `ReactElement` or a function that returns the element to render.
*/
render: PropTypes.oneOfType([PropTypes.element, PropTypes.func]),
} as any;
Expand Down

0 comments on commit d010114

Please sign in to comment.