Skip to content

Commit ca58287

Browse files
web-padawanweb-padawan
authored
docs: add upload-file custom CSS properties to styling JSDoc (#10579)
1 parent e4170bf commit ca58287

File tree

4 files changed

+132
-24
lines changed

4 files changed

+132
-24
lines changed

‎packages/upload/src/vaadin-upload-file.d.ts‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,34 @@ export interface UploadFileEventMap extends HTMLElementEventMap, UploadFileCusto
6565
* `uploading` | Uploading is in progress.
6666
* `complete` | Uploading has finished successfully.
6767
*
68+
* The following custom CSS properties are available for styling:
69+
*
70+
* Custom CSS property |
71+
* :--------------------------------------------|
72+
* `--vaadin-upload-file-border-radius` |
73+
* `--vaadin-upload-file-button-background` |
74+
* `--vaadin-upload-file-button-border-color` |
75+
* `--vaadin-upload-file-button-border-radius` |
76+
* `--vaadin-upload-file-button-border-width` |
77+
* `--vaadin-upload-file-button-text-color` |
78+
* `--vaadin-upload-file-button-padding` |
79+
* `--vaadin-upload-file-done-color` |
80+
* `--vaadin-upload-file-error-color` |
81+
* `--vaadin-upload-file-error-font-size` |
82+
* `--vaadin-upload-file-error-font-weight` |
83+
* `--vaadin-upload-file-error-line-height` |
84+
* `--vaadin-upload-file-gap` |
85+
* `--vaadin-upload-file-name-color` |
86+
* `--vaadin-upload-file-name-font-size` |
87+
* `--vaadin-upload-file-name-font-weight` |
88+
* `--vaadin-upload-file-name-line-height` |
89+
* `--vaadin-upload-file-padding` |
90+
* `--vaadin-upload-file-status-color` |
91+
* `--vaadin-upload-file-status-font-size` |
92+
* `--vaadin-upload-file-status-font-weight` |
93+
* `--vaadin-upload-file-status-line-height` |
94+
* `--vaadin-upload-file-warning-color` |
95+
*
6896
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
6997
*/
7098
declare class UploadFile extends UploadFileMixin(ThemableMixin(HTMLElement)) {

‎packages/upload/src/vaadin-upload-file.js‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,34 @@ import { UploadFileMixin } from './vaadin-upload-file-mixin.js';
4545
* `uploading` | Uploading is in progress.
4646
* `complete` | Uploading has finished successfully.
4747
*
48+
* The following custom CSS properties are available for styling:
49+
*
50+
* Custom CSS property |
51+
* :--------------------------------------------|
52+
* `--vaadin-upload-file-border-radius` |
53+
* `--vaadin-upload-file-button-background` |
54+
* `--vaadin-upload-file-button-border-color` |
55+
* `--vaadin-upload-file-button-border-radius` |
56+
* `--vaadin-upload-file-button-border-width` |
57+
* `--vaadin-upload-file-button-text-color` |
58+
* `--vaadin-upload-file-button-padding` |
59+
* `--vaadin-upload-file-done-color` |
60+
* `--vaadin-upload-file-error-color` |
61+
* `--vaadin-upload-file-error-font-size` |
62+
* `--vaadin-upload-file-error-font-weight` |
63+
* `--vaadin-upload-file-error-line-height` |
64+
* `--vaadin-upload-file-gap` |
65+
* `--vaadin-upload-file-name-color` |
66+
* `--vaadin-upload-file-name-font-size` |
67+
* `--vaadin-upload-file-name-font-weight` |
68+
* `--vaadin-upload-file-name-line-height` |
69+
* `--vaadin-upload-file-padding` |
70+
* `--vaadin-upload-file-status-color` |
71+
* `--vaadin-upload-file-status-font-size` |
72+
* `--vaadin-upload-file-status-font-weight` |
73+
* `--vaadin-upload-file-status-line-height` |
74+
* `--vaadin-upload-file-warning-color` |
75+
*
4876
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
4977
*
5078
* @customElement

‎packages/upload/src/vaadin-upload.d.ts‎

Lines changed: 38 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -149,18 +149,44 @@ export interface UploadEventMap extends HTMLElementEventMap, UploadCustomEventMa
149149
*
150150
* The following custom CSS properties are available for styling:
151151
*
152-
* Custom CSS property | Description
153-
* -----------------------------------------|-------------
154-
* `--vaadin-upload-background` | The host element background
155-
* `--vaadin-upload-border-color` | The host element border color
156-
* `--vaadin-upload-border-radius` | The host element border radius
157-
* `--vaadin-upload-border-width` | The host element border width
158-
* `--vaadin-upload-padding` | The host element padding
159-
* `--vaadin-upload-drop-label-color` | The drop label color
160-
* `--vaadin-upload-drop-label-font-size` | The drop label font size
161-
* `--vaadin-upload-drop-label-font-weight` | The drop label font weight
162-
* `--vaadin-upload-drop-label-gap` | The drop label gap
163-
* `--vaadin-upload-drop-label-line-height` | The drop label line height
152+
* Custom CSS property |
153+
* :--------------------------------------------|
154+
* `--vaadin-upload-background` |
155+
* `--vaadin-upload-border-color` |
156+
* `--vaadin-upload-border-radius` |
157+
* `--vaadin-upload-border-width` |
158+
* `--vaadin-upload-gap` |
159+
* `--vaadin-upload-padding` |
160+
* `--vaadin-upload-drop-label-color` |
161+
* `--vaadin-upload-drop-label-font-size` |
162+
* `--vaadin-upload-drop-label-font-weight` |
163+
* `--vaadin-upload-drop-label-gap` |
164+
* `--vaadin-upload-drop-label-line-height` |
165+
* `--vaadin-upload-file-list-divider-color` |
166+
* `--vaadin-upload-file-list-divider-width` |
167+
* `--vaadin-upload-file-border-radius` |
168+
* `--vaadin-upload-file-button-background` |
169+
* `--vaadin-upload-file-button-border-color` |
170+
* `--vaadin-upload-file-button-border-radius` |
171+
* `--vaadin-upload-file-button-border-width` |
172+
* `--vaadin-upload-file-button-text-color` |
173+
* `--vaadin-upload-file-button-padding` |
174+
* `--vaadin-upload-file-done-color` |
175+
* `--vaadin-upload-file-error-color` |
176+
* `--vaadin-upload-file-error-font-size` |
177+
* `--vaadin-upload-file-error-font-weight` |
178+
* `--vaadin-upload-file-error-line-height` |
179+
* `--vaadin-upload-file-gap` |
180+
* `--vaadin-upload-file-name-color` |
181+
* `--vaadin-upload-file-name-font-size` |
182+
* `--vaadin-upload-file-name-font-weight` |
183+
* `--vaadin-upload-file-name-line-height` |
184+
* `--vaadin-upload-file-padding` |
185+
* `--vaadin-upload-file-status-color` |
186+
* `--vaadin-upload-file-status-font-size` |
187+
* `--vaadin-upload-file-status-font-weight` |
188+
* `--vaadin-upload-file-status-line-height` |
189+
* `--vaadin-upload-file-warning-color` |
164190
*
165191
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
166192
*

‎packages/upload/src/vaadin-upload.js‎

Lines changed: 38 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -47,18 +47,44 @@ import { UploadMixin } from './vaadin-upload-mixin.js';
4747
*
4848
* The following custom CSS properties are available for styling:
4949
*
50-
* Custom CSS property | Description
51-
* -----------------------------------------|-------------
52-
* `--vaadin-upload-background` | The host element background
53-
* `--vaadin-upload-border-color` | The host element border color
54-
* `--vaadin-upload-border-radius` | The host element border radius
55-
* `--vaadin-upload-border-width` | The host element border width
56-
* `--vaadin-upload-padding` | The host element padding
57-
* `--vaadin-upload-drop-label-color` | The drop label color
58-
* `--vaadin-upload-drop-label-font-size` | The drop label font size
59-
* `--vaadin-upload-drop-label-font-weight` | The drop label font weight
60-
* `--vaadin-upload-drop-label-gap` | The drop label gap
61-
* `--vaadin-upload-drop-label-line-height` | The drop label line height
50+
* Custom CSS property |
51+
* :--------------------------------------------|
52+
* `--vaadin-upload-background` |
53+
* `--vaadin-upload-border-color` |
54+
* `--vaadin-upload-border-radius` |
55+
* `--vaadin-upload-border-width` |
56+
* `--vaadin-upload-gap` |
57+
* `--vaadin-upload-padding` |
58+
* `--vaadin-upload-drop-label-color` |
59+
* `--vaadin-upload-drop-label-font-size` |
60+
* `--vaadin-upload-drop-label-font-weight` |
61+
* `--vaadin-upload-drop-label-gap` |
62+
* `--vaadin-upload-drop-label-line-height` |
63+
* `--vaadin-upload-file-list-divider-color` |
64+
* `--vaadin-upload-file-list-divider-width` |
65+
* `--vaadin-upload-file-border-radius` |
66+
* `--vaadin-upload-file-button-background` |
67+
* `--vaadin-upload-file-button-border-color` |
68+
* `--vaadin-upload-file-button-border-radius` |
69+
* `--vaadin-upload-file-button-border-width` |
70+
* `--vaadin-upload-file-button-text-color` |
71+
* `--vaadin-upload-file-button-padding` |
72+
* `--vaadin-upload-file-done-color` |
73+
* `--vaadin-upload-file-error-color` |
74+
* `--vaadin-upload-file-error-font-size` |
75+
* `--vaadin-upload-file-error-font-weight` |
76+
* `--vaadin-upload-file-error-line-height` |
77+
* `--vaadin-upload-file-gap` |
78+
* `--vaadin-upload-file-name-color` |
79+
* `--vaadin-upload-file-name-font-size` |
80+
* `--vaadin-upload-file-name-font-weight` |
81+
* `--vaadin-upload-file-name-line-height` |
82+
* `--vaadin-upload-file-padding` |
83+
* `--vaadin-upload-file-status-color` |
84+
* `--vaadin-upload-file-status-font-size` |
85+
* `--vaadin-upload-file-status-font-weight` |
86+
* `--vaadin-upload-file-status-line-height` |
87+
* `--vaadin-upload-file-warning-color` |
6288
*
6389
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
6490
*

0 commit comments

Comments
 (0)