Skip to content

Commit

Permalink
update API docs for progress
Browse files Browse the repository at this point in the history
  • Loading branch information
huntabyte committed Feb 17, 2025
1 parent 7fefc59 commit 456eab3
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions docs/src/lib/content/api-reference/progress.api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import {
createApiSchema,
createDataAttrSchema,
createNumberProp,
createPropSchema,
withChildProps,
} from "./helpers.js";
import { ProgressStateAttr } from "./extended-types/progress/index.js";
Expand All @@ -13,12 +14,16 @@ export const root = createApiSchema<ProgressRootPropsWithoutHTML>({
props: {
max: createNumberProp({
default: "100",
description:
"The maximum value of the progress bar. Used to calculate the percentage of the progress bar.",
description: "The maximum value of the progress bar.",
}),
value: createNumberProp({
min: createNumberProp({
default: "0",
description: "The current value of the progress bar.",
description: "The minimum value of the progress bar.",
}),
value: createPropSchema({
default: "0",
description: "The current value of the progress bar. If set to `null` ",
type: "number | null",
}),
...withChildProps({ elType: "HTMLDivElement" }),
},
Expand All @@ -33,10 +38,18 @@ export const root = createApiSchema<ProgressRootPropsWithoutHTML>({
description: "The current state of the progress bar.",
isEnum: true,
}),
createDataAttrSchema({
name: "min",
description: "The minimum value of the progress bar.",
}),
createDataAttrSchema({
name: "max",
description: "The maximum value of the progress bar.",
}),
createDataAttrSchema({
name: "indeterminate",
description: "Present when the value is `null`.",
}),
createDataAttrSchema({
name: "progress-root",
description: "Present on the root element.",
Expand Down

0 comments on commit 456eab3

Please sign in to comment.