Skip to content

Commit 4352526

Browse files
authored
docs: document details and accordion base styles properties (#10616)
1 parent a6fe020 commit 4352526

File tree

6 files changed

+70
-4
lines changed

6 files changed

+70
-4
lines changed

packages/accordion/src/vaadin-accordion-heading.d.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,21 @@ import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mix
3838
* `opened` | Set when the collapsible content is expanded and visible.
3939
* `disabled` | Set when the element is disabled.
4040
*
41+
* The following custom CSS properties are available for styling:
42+
*
43+
* Custom CSS property |
44+
* :--------------------------------------------|
45+
* | `--vaadin-accordion-heading-background` |
46+
* | `--vaadin-accordion-heading-border-color` |
47+
* | `--vaadin-accordion-heading-border-radius` |
48+
* | `--vaadin-accordion-heading-border-width` |
49+
* | `--vaadin-accordion-heading-font-size` |
50+
* | `--vaadin-accordion-heading-font-weight` |
51+
* | `--vaadin-accordion-heading-gap` |
52+
* | `--vaadin-accordion-heading-height` |
53+
* | `--vaadin-accordion-heading-padding` |
54+
* | `--vaadin-accordion-heading-text-color` |
55+
*
4156
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
4257
*/
4358
declare class AccordionHeading extends ActiveMixin(DirMixin(ThemableMixin(HTMLElement))) {

packages/accordion/src/vaadin-accordion-heading.js

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,21 @@ import { accordionHeading } from './styles/vaadin-accordion-heading-base-styles.
4343
* `opened` | Set when the collapsible content is expanded and visible.
4444
* `disabled` | Set when the element is disabled.
4545
*
46+
* The following custom CSS properties are available for styling:
47+
*
48+
* Custom CSS property |
49+
* :--------------------------------------------|
50+
* | `--vaadin-accordion-heading-background` |
51+
* | `--vaadin-accordion-heading-border-color` |
52+
* | `--vaadin-accordion-heading-border-radius` |
53+
* | `--vaadin-accordion-heading-border-width` |
54+
* | `--vaadin-accordion-heading-font-size` |
55+
* | `--vaadin-accordion-heading-font-weight` |
56+
* | `--vaadin-accordion-heading-gap` |
57+
* | `--vaadin-accordion-heading-height` |
58+
* | `--vaadin-accordion-heading-padding` |
59+
* | `--vaadin-accordion-heading-text-color` |
60+
*
4661
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
4762
*
4863
* @customElement

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,11 @@ export type AccordionEventMap = AccordionCustomEventMap & HTMLElementEventMap;
5353
*
5454
* ### Styling
5555
*
56-
* See the [`<vaadin-accordion-panel>`](#/elements/vaadin-accordion-panel)
57-
* documentation for the available state attributes and stylable shadow parts.
56+
* Accordion does not have own stylable shadow parts or state attributes. Instead, apply styles to
57+
* the following components:
58+
*
59+
* - [`<vaadin-accordion-heading>`](#/elements/vaadin-accordion-heading)
60+
* - [`<vaadin-accordion-panel>`](#/elements/vaadin-accordion-panel)
5861
*
5962
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
6063
*

packages/accordion/src/vaadin-accordion.js

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,11 @@ import { AccordionMixin } from './vaadin-accordion-mixin.js';
3838
*
3939
* ### Styling
4040
*
41-
* See the [`<vaadin-accordion-panel>`](#/elements/vaadin-accordion-panel)
42-
* documentation for the available state attributes and stylable shadow parts.
41+
* Accordion does not have own stylable shadow parts or state attributes. Instead, apply styles to
42+
* the following components:
43+
*
44+
* - [`<vaadin-accordion-heading>`](#/elements/vaadin-accordion-heading)
45+
* - [`<vaadin-accordion-panel>`](#/elements/vaadin-accordion-panel)
4346
*
4447
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
4548
*

packages/details/src/vaadin-details-summary.d.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,21 @@ import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mix
2929
* `focus-ring` | Set when the element is focused using the keyboard.
3030
* `focused` | Set when the element is focused.
3131
*
32+
* The following custom CSS properties are available for styling:
33+
*
34+
* Custom CSS property |
35+
* :------------------------------------------|
36+
* | `--vaadin-details-summary-background` |
37+
* | `--vaadin-details-summary-border-color` |
38+
* | `--vaadin-details-summary-border-radius` |
39+
* | `--vaadin-details-summary-border-width` |
40+
* | `--vaadin-details-summary-font-size` |
41+
* | `--vaadin-details-summary-font-weight` |
42+
* | `--vaadin-details-summary-gap` |
43+
* | `--vaadin-details-summary-height` |
44+
* | `--vaadin-details-summary-padding` |
45+
* | `--vaadin-details-summary-text-color` |
46+
*
3247
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
3348
*/
3449
declare class DetailsSummary extends ButtonMixin(DirMixin(ThemableMixin(HTMLElement))) {

packages/details/src/vaadin-details-summary.js

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,21 @@ import { detailsSummary } from './styles/vaadin-details-summary-base-styles.js';
3434
* `focus-ring` | Set when the element is focused using the keyboard.
3535
* `focused` | Set when the element is focused.
3636
*
37+
* The following custom CSS properties are available for styling:
38+
*
39+
* Custom CSS property |
40+
* :------------------------------------------|
41+
* | `--vaadin-details-summary-background` |
42+
* | `--vaadin-details-summary-border-color` |
43+
* | `--vaadin-details-summary-border-radius` |
44+
* | `--vaadin-details-summary-border-width` |
45+
* | `--vaadin-details-summary-font-size` |
46+
* | `--vaadin-details-summary-font-weight` |
47+
* | `--vaadin-details-summary-gap` |
48+
* | `--vaadin-details-summary-height` |
49+
* | `--vaadin-details-summary-padding` |
50+
* | `--vaadin-details-summary-text-color` |
51+
*
3752
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
3853
*
3954
* @customElement

0 commit comments

Comments
 (0)