Skip to content

Commit 221b286

Browse files
docs: add tabs and tabsheet base style properties to JSDoc (#10633) (#10637)
Co-authored-by: Serhii Kulykov <iamkulykov@gmail.com>
1 parent db58e05 commit 221b286

File tree

6 files changed

+72
-0
lines changed

6 files changed

+72
-0
lines changed

packages/tabs/src/vaadin-tab.d.ts

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,19 @@ import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mix
2626
* `orientation` | Set to `horizontal` or `vertical` depending on the direction of items
2727
* `has-tooltip` | Set when the tab has a slotted tooltip
2828
*
29+
* The following custom CSS properties are available for styling:
30+
*
31+
* Custom CSS property |
32+
* :------------------------------|
33+
* | `--vaadin-tab-background` |
34+
* | `--vaadin-tab-border-color` |
35+
* | `--vaadin-tab-border-width` |
36+
* | `--vaadin-tab-font-size` |
37+
* | `--vaadin-tab-font-weight` |
38+
* | `--vaadin-tab-gap` |
39+
* | `--vaadin-tab-padding` |
40+
* | `--vaadin-tab-text-color` |
41+
*
2942
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
3043
*/
3144
declare class Tab extends ElementMixin(ThemableMixin(ItemMixin(HTMLElement))) {}

packages/tabs/src/vaadin-tab.js

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,19 @@ import { tabStyles } from './styles/vaadin-tab-base-styles.js';
3232
* `orientation` | Set to `horizontal` or `vertical` depending on the direction of items
3333
* `has-tooltip` | Set when the tab has a slotted tooltip
3434
*
35+
* The following custom CSS properties are available for styling:
36+
*
37+
* Custom CSS property |
38+
* :------------------------------|
39+
* | `--vaadin-tab-background` |
40+
* | `--vaadin-tab-border-color` |
41+
* | `--vaadin-tab-border-width` |
42+
* | `--vaadin-tab-font-size` |
43+
* | `--vaadin-tab-font-weight` |
44+
* | `--vaadin-tab-gap` |
45+
* | `--vaadin-tab-padding` |
46+
* | `--vaadin-tab-text-color` |
47+
*
3548
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
3649
*
3750
* @customElement

packages/tabs/src/vaadin-tabs.d.ts

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,19 @@ export interface TabsEventMap extends HTMLElementEventMap, TabsCustomEventMap {}
5656
* `orientation` | Tabs disposition, valid values are `horizontal` and `vertical`
5757
* `overflow` | It's set to `start`, `end`, none or both.
5858
*
59+
* The following custom CSS properties are available for styling:
60+
*
61+
* Custom CSS property |
62+
* :--------------------------------|
63+
* | `--vaadin-tabs-background` |
64+
* | `--vaadin-tabs-border-color` |
65+
* | `--vaadin-tabs-border-radius` |
66+
* | `--vaadin-tabs-border-width` |
67+
* | `--vaadin-tabs-font-size` |
68+
* | `--vaadin-tabs-font-weight` |
69+
* | `--vaadin-tabs-gap` |
70+
* | `--vaadin-tabs-padding` |
71+
*
5972
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
6073
*
6174
* @fires {CustomEvent} items-changed - Fired when the `items` property changes.

packages/tabs/src/vaadin-tabs.js

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,19 @@ import { TabsMixin } from './vaadin-tabs-mixin.js';
4242
* `orientation` | Tabs disposition, valid values are `horizontal` and `vertical`
4343
* `overflow` | It's set to `start`, `end`, none or both.
4444
*
45+
* The following custom CSS properties are available for styling:
46+
*
47+
* Custom CSS property |
48+
* :--------------------------------|
49+
* | `--vaadin-tabs-background` |
50+
* | `--vaadin-tabs-border-color` |
51+
* | `--vaadin-tabs-border-radius` |
52+
* | `--vaadin-tabs-border-width` |
53+
* | `--vaadin-tabs-font-size` |
54+
* | `--vaadin-tabs-font-weight` |
55+
* | `--vaadin-tabs-gap` |
56+
* | `--vaadin-tabs-padding` |
57+
*
4558
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
4659
*
4760
* @fires {CustomEvent} items-changed - Fired when the `items` property changes.

packages/tabsheet/src/vaadin-tabsheet.d.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,16 @@ export interface TabSheetEventMap extends HTMLElementEventMap, TabSheetCustomEve
6363
* `loading` | Set when a tab without associated content is selected
6464
* `overflow` | Set to `top`, `bottom`, `start`, `end`, all of them, or none.
6565
*
66+
* The following custom CSS properties are available for styling:
67+
*
68+
* Custom CSS property |
69+
* :------------------------------------|
70+
* | `--vaadin-tabsheet-border-color` |
71+
* | `--vaadin-tabsheet-border-radius` |
72+
* | `--vaadin-tabsheet-border-width` |
73+
* | `--vaadin-tabsheet-gap` |
74+
* | `--vaadin-tabsheet-padding` |
75+
*
6676
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
6777
*
6878
* @fires {CustomEvent} items-changed - Fired when the `items` property changes.

packages/tabsheet/src/vaadin-tabsheet.js

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,16 @@ import { TabSheetMixin } from './vaadin-tabsheet-mixin.js';
5151
* `loading` | Set when a tab without associated content is selected
5252
* `overflow` | Set to `top`, `bottom`, `start`, `end`, all of them, or none.
5353
*
54+
* The following custom CSS properties are available for styling:
55+
*
56+
* Custom CSS property |
57+
* :------------------------------------|
58+
* | `--vaadin-tabsheet-border-color` |
59+
* | `--vaadin-tabsheet-border-radius` |
60+
* | `--vaadin-tabsheet-border-width` |
61+
* | `--vaadin-tabsheet-gap` |
62+
* | `--vaadin-tabsheet-padding` |
63+
*
5464
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
5565
*
5666
* @fires {CustomEvent} items-changed - Fired when the `items` property changes.

0 commit comments

Comments
 (0)