Skip to content

Commit 5bc5f01

Browse files
docs: add app-layout and drawer toggle base style props to JSDoc (#10671) (#10680)
Co-authored-by: Serhii Kulykov <iamkulykov@gmail.com>
1 parent 83468a0 commit 5bc5f01

File tree

4 files changed

+98
-2
lines changed

4 files changed

+98
-2
lines changed

packages/app-layout/src/vaadin-app-layout.d.ts

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,22 @@ export type AppLayoutEventMap = AppLayoutCustomEventMap & HTMLElementEventMap;
8686
* `has-drawer` | Set when the element has light DOM content in the drawer slot.
8787
* `has-navbar` | Set when the element has light DOM content in the navbar slot.
8888
*
89+
* The following custom CSS properties are available for styling:
90+
*
91+
* Custom CSS property |
92+
* :----------------------------------------------------|
93+
* | `--vaadin-app-layout-drawer-background` |
94+
* | `--vaadin-app-layout-drawer-width` |
95+
* | `--vaadin-app-layout-navbar-background` |
96+
* | `--vaadin-app-layout-navbar-gap` |
97+
* | `--vaadin-app-layout-navbar-padding-bottom` |
98+
* | `--vaadin-app-layout-navbar-padding-inline-end` |
99+
* | `--vaadin-app-layout-navbar-padding-inline-start` |
100+
* | `--vaadin-app-layout-navbar-padding-top` |
101+
* | `--vaadin-app-layout-transition-duration` |
102+
* | `--vaadin-overlay-backdrop-background` |
103+
* | `--vaadin-overlay-shadow` |
104+
*
89105
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
90106
*
91107
* ### Component's slots

packages/app-layout/src/vaadin-app-layout.js

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,15 +58,31 @@ import { AppLayoutMixin } from './vaadin-app-layout-mixin.js';
5858
* `navbar-bottom` | Container for the bottom navigation bar
5959
* `drawer` | Container for the drawer area
6060
*
61-
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
62-
*
6361
* The following state attributes are available for styling:
6462
*
6563
* Attribute | Description
6664
* ---------------|-------------
6765
* `has-drawer` | Set when the element has light DOM content in the drawer slot.
6866
* `has-navbar` | Set when the element has light DOM content in the navbar slot.
6967
*
68+
* The following custom CSS properties are available for styling:
69+
*
70+
* Custom CSS property |
71+
* :----------------------------------------------------|
72+
* | `--vaadin-app-layout-drawer-background` |
73+
* | `--vaadin-app-layout-drawer-width` |
74+
* | `--vaadin-app-layout-navbar-background` |
75+
* | `--vaadin-app-layout-navbar-gap` |
76+
* | `--vaadin-app-layout-navbar-padding-bottom` |
77+
* | `--vaadin-app-layout-navbar-padding-inline-end` |
78+
* | `--vaadin-app-layout-navbar-padding-inline-start` |
79+
* | `--vaadin-app-layout-navbar-padding-top` |
80+
* | `--vaadin-app-layout-transition-duration` |
81+
* | `--vaadin-overlay-backdrop-background` |
82+
* | `--vaadin-overlay-shadow` |
83+
*
84+
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
85+
*
7086
* ### Component's slots
7187
*
7288
* The following slots are available to be set

packages/app-layout/src/vaadin-drawer-toggle.d.ts

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,38 @@ import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mix
1515
* <vaadin-drawer-toggle slot="navbar">Toggle drawer</vaadin-drawer-toggle>
1616
* </vaadin-app-layout>
1717
* ```
18+
*
19+
* ### Styling
20+
*
21+
* The following shadow DOM parts are available for styling:
22+
*
23+
* Part name | Description
24+
* -------------|------------
25+
* `icon` | The icon element
26+
*
27+
* The following state attributes are available for styling:
28+
*
29+
* Attribute | Description
30+
* -------------|------------
31+
* `focus-ring` | Set when the element is focused using the keyboard
32+
* `focused` | Set when the element is focused
33+
*
34+
* The following custom CSS properties are available for styling:
35+
*
36+
* Custom CSS property |
37+
* :----------------------------------|
38+
* | `--vaadin-button-background` |
39+
* | `--vaadin-button-border-color` |
40+
* | `--vaadin-button-border-radius` |
41+
* | `--vaadin-button-border-width` |
42+
* | `--vaadin-button-font-size` |
43+
* | `--vaadin-button-line-height` |
44+
* | `--vaadin-button-margin` |
45+
* | `--vaadin-button-padding` |
46+
* | `--vaadin-button-text-color` |
47+
* | `--vaadin-icon-size` |
48+
*
49+
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
1850
*/
1951
declare class DrawerToggle extends ButtonMixin(DirMixin(ThemableMixin(HTMLElement))) {
2052
ariaLabel: string;

packages/app-layout/src/vaadin-drawer-toggle.js

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,38 @@ import { drawerToggle } from './styles/vaadin-drawer-toggle-base-styles.js';
2323
* </vaadin-app-layout>
2424
* ```
2525
*
26+
* ### Styling
27+
*
28+
* The following shadow DOM parts are available for styling:
29+
*
30+
* Part name | Description
31+
* -------------|------------
32+
* `icon` | The icon element
33+
*
34+
* The following state attributes are available for styling:
35+
*
36+
* Attribute | Description
37+
* -------------|------------
38+
* `focus-ring` | Set when the element is focused using the keyboard
39+
* `focused` | Set when the element is focused
40+
*
41+
* The following custom CSS properties are available for styling:
42+
*
43+
* Custom CSS property |
44+
* :----------------------------------|
45+
* | `--vaadin-button-background` |
46+
* | `--vaadin-button-border-color` |
47+
* | `--vaadin-button-border-radius` |
48+
* | `--vaadin-button-border-width` |
49+
* | `--vaadin-button-font-size` |
50+
* | `--vaadin-button-line-height` |
51+
* | `--vaadin-button-margin` |
52+
* | `--vaadin-button-padding` |
53+
* | `--vaadin-button-text-color` |
54+
* | `--vaadin-icon-size` |
55+
*
56+
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
57+
*
2658
* @customElement
2759
* @extends HTMLElement
2860
* @mixes ButtonMixin

0 commit comments

Comments
 (0)