Skip to content

Commit ec6c0fe

Browse files
docs: add progress-bar base style properties to JSDoc (#10634) (#10658)
Co-authored-by: Serhii Kulykov <iamkulykov@gmail.com>
1 parent adf2a59 commit ec6c0fe

File tree

2 files changed

+38
-22
lines changed

2 files changed

+38
-22
lines changed

packages/progress-bar/src/vaadin-progress-bar.d.ts

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,24 +19,32 @@ import { ProgressMixin } from './vaadin-progress-mixin.js';
1919
*
2020
* The following shadow DOM parts are available for styling:
2121
*
22-
* Part name | Description
23-
* ----------------|----------------
24-
* `bar` | Progress-bar's background
25-
* `value` | Progress-bar's foreground
26-
*
27-
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
28-
*
29-
* The following custom properties are available:
30-
*
31-
* Custom property | Description | Default
32-
* ----------------|-------------|-------------
33-
* `--vaadin-progress-value` | current progress value (between 0 and 1) | 0
22+
* Part name | Description
23+
* -----------|----------------
24+
* `bar` | Progress-bar's background
25+
* `value` | Progress-bar's foreground
26+
*
27+
* The following custom CSS properties are available for styling:
28+
*
29+
* Custom CSS property |
30+
* :--------------------------------------------|
31+
* | `--vaadin-progress-bar-animation-duration` |
32+
* | `--vaadin-progress-bar-background` |
33+
* | `--vaadin-progress-bar-border-color` |
34+
* | `--vaadin-progress-bar-border-radius` |
35+
* | `--vaadin-progress-bar-border-width` |
36+
* | `--vaadin-progress-bar-height` |
37+
* | `--vaadin-progress-bar-padding` |
38+
* | `--vaadin-progress-bar-value-background` |
39+
* | `--vaadin-progress-value` |
3440
*
3541
* The following state attributes are available for styling:
3642
*
3743
* Attribute | Description
3844
* ----------------|-------------------------------------
3945
* `indeterminate` | Set to an indeterminate progress bar
46+
*
47+
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
4048
*/
4149
declare class ProgressBar extends ProgressMixin(ThemableMixin(ElementMixin(HTMLElement))) {}
4250

packages/progress-bar/src/vaadin-progress-bar.js

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,25 +24,33 @@ import { ProgressMixin } from './vaadin-progress-mixin.js';
2424
*
2525
* The following shadow DOM parts are available for styling:
2626
*
27-
* Part name | Description
28-
* ----------------|----------------
29-
* `bar` | Progress-bar's background
30-
* `value` | Progress-bar's foreground
27+
* Part name | Description
28+
* -----------|----------------
29+
* `bar` | Progress-bar's background
30+
* `value` | Progress-bar's foreground
3131
*
32-
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
33-
*
34-
* The following custom properties are available:
32+
* The following custom CSS properties are available for styling:
3533
*
36-
* Custom property | Description | Default
37-
* ----------------|-------------|-------------
38-
* `--vaadin-progress-value` | current progress value (between 0 and 1) | 0
34+
* Custom CSS property |
35+
* :--------------------------------------------|
36+
* | `--vaadin-progress-bar-animation-duration` |
37+
* | `--vaadin-progress-bar-background` |
38+
* | `--vaadin-progress-bar-border-color` |
39+
* | `--vaadin-progress-bar-border-radius` |
40+
* | `--vaadin-progress-bar-border-width` |
41+
* | `--vaadin-progress-bar-height` |
42+
* | `--vaadin-progress-bar-padding` |
43+
* | `--vaadin-progress-bar-value-background` |
44+
* | `--vaadin-progress-value` |
3945
*
4046
* The following state attributes are available for styling:
4147
*
4248
* Attribute | Description
4349
* ----------------|-------------------------------------
4450
* `indeterminate` | Set to an indeterminate progress bar
4551
*
52+
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
53+
*
4654
* @customElement
4755
* @extends HTMLElement
4856
* @mixes ProgressMixin

0 commit comments

Comments
 (0)