Skip to content

Commit e05c5b2

Browse files
bennypowersbennypowers
committed
docs(elements): standard jsdoc syntax
docs(elements): standard jsdoc syntax
1 parent 517d97c commit e05c5b2

File tree

27 files changed

+1332
-1360
lines changed

27 files changed

+1332
-1360
lines changed

‎elements/pf-accordion/pf-accordion-header.ts‎

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -39,60 +39,60 @@ export class PfAccordionHeaderChangeEvent extends Event {
3939
* These elements will appear inline with the accordion header, between the header and the chevron
4040
* (or after the chevron and header in disclosure mode).
4141
* @fires {AccordionHeaderChangeEvent} change - when the open panels change
42-
* @cssprop {<color>} --pf-c-accordion__toggle--Color
42+
* @cssprop {<color>} [--pf-c-accordion__toggle--Color=var(--pf-global--Color--100, #151515)]
4343
* Sets the font color for the accordion header.
44-
* {@default `var(--pf-global--Color--100, #151515)`}
45-
* @cssprop {<color>} --pf-c-accordion__toggle--BackgroundColor
44+
*
45+
* @cssprop {<color>} [--pf-c-accordion__toggle--BackgroundColor=transparent]
4646
* Sets the background color for the accordion header toggle element.
47-
* {@default `transparent`}
48-
* @cssprop {<color>} --pf-c-accordion__toggle--after--BackgroundColor
47+
*
48+
* @cssprop {<color>} [--pf-c-accordion__toggle--after--BackgroundColor=transparent]
4949
* Sets the background color for the after element for the accordion header toggle element.
50-
* {@default `transparent`}
51-
* @cssprop {<length>} --pf-c-accordion__toggle--PaddingTop
50+
*
51+
* @cssprop {<length>} [--pf-c-accordion__toggle--PaddingTop=var(--pf-global--spacer--sm, 0.5rem)]
5252
* Sets the top padding for the accordion header.
53-
* {@default `var(--pf-global--spacer--sm, 0.5rem)`}
54-
* @cssprop {<length>} --pf-c-accordion__toggle--PaddingRight
53+
*
54+
* @cssprop {<length>} [--pf-c-accordion__toggle--PaddingRight=var(--pf-global--spacer--md, 1rem)]
5555
* Sets the right padding for the accordion header.
56-
* {@default `var(--pf-global--spacer--md, 1rem)`}
57-
* @cssprop {<length>} --pf-c-accordion__toggle--PaddingBottom
56+
*
57+
* @cssprop {<length>} [--pf-c-accordion__toggle--PaddingBottom=var(--pf-global--spacer--sm, 0.5rem)]
5858
* Sets the bottom padding for the accordion header.
59-
* {@default `var(--pf-global--spacer--sm, 0.5rem)`}
60-
* @cssprop {<length>} --pf-c-accordion__toggle--PaddingLeft
59+
*
60+
* @cssprop {<length>} [--pf-c-accordion__toggle--PaddingLeft=var(--pf-global--spacer--md, 1rem)]
6161
* Sets the left padding for the accordion header.
62-
* {@default `var(--pf-global--spacer--md, 1rem)`}
63-
* @cssprop {<length>} --pf-c-accordion__toggle--FontSize
62+
*
63+
* @cssprop {<length>} [--pf-c-accordion__toggle--FontSize=var(--pf-global--FontSize--lg, 1rem)]
6464
* Sets the sidebar background color for the accordion header.
65-
* {@default `var(--pf-global--FontSize--lg, 1rem)`}
66-
* @cssprop {<color>} --pf-c-accordion__toggle--FontFamily
65+
*
66+
* @cssprop {<color>} [--pf-c-accordion__toggle--FontFamily=var(--pf-global--FontFamily--redhat-updated--heading--sans-serif, "RedHatDisplayUpdated", helvetica, arial, sans-serif)]
6767
* Sets the font family for the accordion header.
68-
* {@default `var(--pf-global--FontFamily--redhat-updated--heading--sans-serif, "RedHatDisplayUpdated", helvetica, arial, sans-serif)`}
69-
* @cssprop --pf-c-accordion__toggle--FontWeight
68+
*
69+
* @cssprop [--pf-c-accordion__toggle--FontWeight=var(--pf-global--FontWeight--normal, 400)]
7070
* Sets the font weight for the accordion header.
71-
* {@default `var(--pf-global--FontWeight--normal, 400)`}
72-
* @cssprop {<color>} --pf-c-accordion__toggle--active--BackgroundColor
71+
*
72+
* @cssprop {<color>} [--pf-c-accordion__toggle--active--BackgroundColor=var(--pf-global--BackgroundColor--200, #f0f0f0)]
7373
* Sets the active backgrdound color for the accordion header.
74-
* {@default `var(--pf-global--BackgroundColor--200, #f0f0f0)`}
75-
* @cssprop {<color>} --pf-c-accordion__toggle--active-text--Color
74+
*
75+
* @cssprop {<color>} [--pf-c-accordion__toggle--active-text--Color=var(--pf-global--link--Color, #0066cc)]
7676
* Sets the active text color for the accordion header.
77-
* {@default `var(--pf-global--link--Color, #0066cc)`}
78-
* @cssprop --pf-c-accordion__toggle--active-text--FontWeight
77+
*
78+
* @cssprop [--pf-c-accordion__toggle--active-text--FontWeight=var(--pf-global--FontWeight--semi-bold, 700)]
7979
* Sets the active text font weight for the accordion header.
80-
* {@default `var(--pf-global--FontWeight--semi-bold, 700)`}
81-
* @cssprop {<color>} --pf-c-accordion__toggle--expanded--before--BackgroundColor
80+
*
81+
* @cssprop {<color>} [--pf-c-accordion__toggle--expanded--before--BackgroundColor=var(--pf-global--link--Color, #0066cc)]
8282
* Sets the hover expanded before background color for the accordion header.
83-
* {@default `var(--pf-global--link--Color, #0066cc)`}
84-
* @cssprop --pf-c-accordion__toggle--expanded-icon--Rotate
83+
*
84+
* @cssprop [--pf-c-accordion__toggle--expanded-icon--Rotate=90deg]
8585
* Sets the expanded icon rotation degrees for the accordion header.
86-
* {@default `90deg`}
87-
* @cssprop {<length>} --pf-c-accordion__toggle-text--MaxWidth
86+
*
87+
* @cssprop {<length>} [--pf-c-accordion__toggle-text--MaxWidth=calc(100 - var(--pf-global--spacer--lg, 1.5rem))]
8888
* Sets the max width for the text inside the accordion header.
89-
* {@default `calc(100% - var(--pf-global--spacer--lg, 1.5rem))`}
90-
* @cssprop --pf-c-accordion__toggle--before--Width
89+
*
90+
* @cssprop [--pf-c-accordion__toggle--before--Width=var(--pf-global--BorderWidth--lg, 3px)]
9191
* Sets the sidebar width for the accordion header.
92-
* {@default `var(--pf-global--BorderWidth--lg, 3px)`}
93-
* @cssprop --pf-c-accordion__toggle-icon--Transition
92+
*
93+
* @cssprop [--pf-c-accordion__toggle-icon--Transition=0.2s ease-in 0s]
9494
* Sets the transition animation for the accordion header.
95-
* {@default `0.2s ease-in 0s`}
95+
*
9696
*/
9797
@customElement('pf-accordion-header')
9898
export class PfAccordionHeader extends LitElement {

‎elements/pf-accordion/pf-accordion-panel.ts‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -9,40 +9,40 @@ import style from './pf-accordion-panel.css';
99
/**
1010
* Accordion Panel
1111
* @slot - Panel content
12-
* @cssprop {<color>} --pf-c-accordion--BackgroundColor
12+
* @cssprop {<color>} [--pf-c-accordion--BackgroundColor=var(--pf-global--BackgroundColor--light-100, #ffffff)]
1313
* Sets the background color for the panel content.
14-
* {@default `var(--pf-global--BackgroundColor--light-100, #ffffff)`}
15-
* @cssprop {<color>} --pf-c-accordion__panel--Color
14+
*
15+
* @cssprop {<color>} [--pf-c-accordion__panel--Color=var(--pf-global--Color--dark-200, #6a6e73)]
1616
* Sets the font color for the panel content.
17-
* {@default `var(--pf-global--Color--dark-200, #6a6e73)`}
18-
* @cssprop {<length>} --pf-c-accordion__panel--FontSize
17+
*
18+
* @cssprop {<length>} [--pf-c-accordion__panel--FontSize=var(--pf-global--FontSize--sm, 0.875rem)]
1919
* Sets the font size for the panel content.
20-
* {@default `var(--pf-global--FontSize--sm, 0.875rem)`}
21-
* @cssprop {<color>} --pf-c-accordion__panel--content-body--before--BackgroundColor
20+
*
21+
* @cssprop {<color>} [--pf-c-accordion__panel--content-body--before--BackgroundColor=var(--pf-global--primary-color--100, #0066cc)]
2222
* Sets the sidebar color for the panel when the context is expanded.
23-
* {@default `var(--pf-global--primary-color--100, #0066cc)`}
24-
* @cssprop {<length>} --pf-c-accordion__panel--m-fixed--MaxHeight
23+
*
24+
* @cssprop {<length>} [--pf-c-accordion__panel--m-fixed--MaxHeight=9.375rem]
2525
* Sets the maximum height for the panel content.
2626
* Will only be used if the `fixed` attribute is used.
27-
* {@default `9.375rem`}
28-
* @cssprop {<length>} --pf-c-accordion__panel-body--PaddingTop
27+
*
28+
* @cssprop {<length>} [--pf-c-accordion__panel-body--PaddingTop=var(--pf-global--spacer--sm, 0.5rem)]
2929
* Sets the padding top for the panel content.
30-
* {@default `var(--pf-global--spacer--sm, 0.5rem)`}
31-
* @cssprop {<length>} --pf-c-accordion__panel-body--PaddingRight
30+
*
31+
* @cssprop {<length>} [--pf-c-accordion__panel-body--PaddingRight=var(--pf-global--spacer--md, 1rem)]
3232
* Sets the padding right for the panel content.
33-
* {@default `var(--pf-global--spacer--md, 1rem)`}
34-
* @cssprop {<length>} --pf-c-accordion__panel-body--PaddingBottom
33+
*
34+
* @cssprop {<length>} [--pf-c-accordion__panel-body--PaddingBottom=var(--pf-global--spacer--sm, 0.5rem)]
3535
* Sets the padding bottom for the panel content.
36-
* {@default `var(--pf-global--spacer--sm, 0.5rem)`}
37-
* @cssprop {<length>} --pf-c-accordion__panel-body--PaddingLeft
36+
*
37+
* @cssprop {<length>} [--pf-c-accordion__panel-body--PaddingLeft=var(--pf-global--spacer--md, 1rem)]
3838
* Sets the padding left for the panel content.
39-
* {@default `var(--pf-global--spacer--md, 1rem)`}
40-
* @cssprop {<color>} --pf-c-accordion__panel-body--before--BackgroundColor
39+
*
40+
* @cssprop {<color>} [--pf-c-accordion__panel-body--before--BackgroundColor=transparent]
4141
* Sets the background color for the panel content.
42-
* {@default `transparent`}
43-
* @cssprop --pf-c-accordion__panel-body--before--Width
42+
*
43+
* @cssprop [--pf-c-accordion__panel-body--before--Width=var(--pf-global--BorderWidth--lg, 3px)]
4444
* Sets the before width for the panel content.
45-
* {@default `var(--pf-global--BorderWidth--lg, 3px)`}
45+
*
4646
*/
4747
@customElement('pf-accordion-panel')
4848
export class PfAccordionPanel extends LitElement {

0 commit comments

Comments
 (0)