Skip to content

docs: add progress-bar base style properties to JSDoc #10634

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
web-padawan merged 2 commits into from
Dec 15, 2025
Merged

docs: add progress-bar base style properties to JSDoc #10634

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bec0e80
docs: add progress-bar base style properties to JSDoc
web-padawan Dec 12, 2025
1de910d
docs: add --vaadin-progress-value back
web-padawan Dec 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 20 additions & 12 deletions packages/progress-bar/src/vaadin-progress-bar.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,24 +19,32 @@ import { ProgressMixin } from './vaadin-progress-mixin.js';
*
* The following shadow DOM parts are available for styling:
*
* Part name | Description
* ----------------|----------------
* `bar` | Progress-bar's background
* `value` | Progress-bar's foreground
*
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
*
* The following custom properties are available:
*
* Custom property | Description | Default
* ----------------|-------------|-------------
* `--vaadin-progress-value` | current progress value (between 0 and 1) | 0
* Part name | Description
* -----------|----------------
* `bar` | Progress-bar's background
* `value` | Progress-bar's foreground
*
* The following custom CSS properties are available for styling:
*
* Custom CSS property |
* :--------------------------------------------|
* | `--vaadin-progress-bar-animation-duration` |
* | `--vaadin-progress-bar-background` |
* | `--vaadin-progress-bar-border-color` |
* | `--vaadin-progress-bar-border-radius` |
* | `--vaadin-progress-bar-border-width` |
* | `--vaadin-progress-bar-height` |
* | `--vaadin-progress-bar-padding` |
* | `--vaadin-progress-bar-value-background` |
* | `--vaadin-progress-value` |
*
* The following state attributes are available for styling:
*
* Attribute | Description
* ----------------|-------------------------------------
* `indeterminate` | Set to an indeterminate progress bar
*
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
*/
declare class ProgressBar extends ProgressMixin(ThemableMixin(ElementMixin(HTMLElement))) {}

Expand Down
28 changes: 18 additions & 10 deletions packages/progress-bar/src/vaadin-progress-bar.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,25 +24,33 @@ import { ProgressMixin } from './vaadin-progress-mixin.js';
*
* The following shadow DOM parts are available for styling:
*
* Part name | Description
* ----------------|----------------
* `bar` | Progress-bar's background
* `value` | Progress-bar's foreground
* Part name | Description
* -----------|----------------
* `bar` | Progress-bar's background
* `value` | Progress-bar's foreground
*
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
*
* The following custom properties are available:
* The following custom CSS properties are available for styling:
*
* Custom property | Description | Default
* ----------------|-------------|-------------
* `--vaadin-progress-value` | current progress value (between 0 and 1) | 0
* Custom CSS property |
* :--------------------------------------------|
* | `--vaadin-progress-bar-animation-duration` |
* | `--vaadin-progress-bar-background` |
* | `--vaadin-progress-bar-border-color` |
* | `--vaadin-progress-bar-border-radius` |
* | `--vaadin-progress-bar-border-width` |
* | `--vaadin-progress-bar-height` |
* | `--vaadin-progress-bar-padding` |
* | `--vaadin-progress-bar-value-background` |
* | `--vaadin-progress-value` |
*
* The following state attributes are available for styling:
*
* Attribute | Description
* ----------------|-------------------------------------
* `indeterminate` | Set to an indeterminate progress bar
*
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
*
* @customElement
* @extends HTMLElement
* @mixes ProgressMixin
Expand Down