Skip to content

Commit ad716c7

Browse files
bennypowersbennypowers
committed
docs: missing jsdoc
1 parent ddd370e commit ad716c7

File tree

6 files changed

+358
-2
lines changed

6 files changed

+358
-2
lines changed

‎elements/pf-chip/pf-chip-group.ts‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,22 @@ const REMAINING_RE = /\$\{\s*remaining\s*\}/g;
4040
* @fires remove - Fires when chip group is closed/removed
4141
* @slot category-name
4242
* Category name text for chip group category. If this prop is supplied chip group with have a label and category styling applied
43-
* @slot
44-
* Should be <Chip> elements.
43+
* @slot - `<pf-chip>` elements.
44+
* @cssprop [--pf-c-chip-group__list--MarginBottom=calc(var(--pf-global--spacer--xs, 0.25rem) * -1)]
45+
* @cssprop [--pf-c-chip-group__list--MarginRight=calc(var(--pf-global--spacer--xs, 0.25rem) * -1)]
46+
* @cssprop [--pf-c-chip-group--m-category--PaddingTop=var(--pf-global--spacer--xs, 0.25rem)]
47+
* @cssprop [--pf-c-chip-group--m-category--PaddingRight=var(--pf-global--spacer--xs, 0.25rem)]
48+
* @cssprop [--pf-c-chip-group--m-category--PaddingBottom=var(--pf-global--spacer--xs, 0.25rem)]
49+
* @cssprop [--pf-c-chip-group--m-category--PaddingLeft=var(--pf-global--spacer--sm, 0.5rem)]
50+
* @cssprop [--pf-c-chip-group--m-category--BorderRadius=var(--pf-global--BorderRadius--sm, 3px)]
51+
* @cssprop [--pf-c-chip-group--m-category--BackgroundColor=var(--pf-global--BackgroundColor--200, #f0f0f0)]
52+
* @cssprop [--pf-c-chip-group__label--MarginRight=var(--pf-global--spacer--sm, 0.5rem)]
53+
* @cssprop [--pf-c-chip-group__label--FontSize=var(--pf-global--FontSize--sm, 0.875rem)]
54+
* @cssprop [--pf-c-chip-group__label--MaxWidth=18ch]
55+
* @cssprop [--pf-c-chip-group__close--MarginTop=calc(var(--pf-global--spacer--xs, 0.25rem) * -1)]
56+
* @cssprop [--pf-c-chip-group__close--MarginBottom=calc(var(--pf-global--spacer--xs, 0.25rem) * -1)]
57+
* @cssprop [--pf-c-chip-group__list-item--MarginRight=var(--pf-global--spacer--xs, 0.25rem)]
58+
* @cssprop [--pf-c-chip-group__list-item--MarginBottom=var(--pf-global--spacer--xs, 0.25rem)]
4559
*/
4660
@customElement('pf-chip-group')
4761
export class PfChipGroup extends LitElement {

‎elements/pf-chip/pf-chip.ts‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,23 @@ export class PfChipRemoveEvent extends Event {
2020
* @slot
2121
* chip text
2222
* @csspart text - container for chip text
23+
* @cssprop [--pf-c-chip--PaddingTop=var(--pf-global--spacer--xs, 0.25rem)]
24+
* @cssprop [--pf-c-chip--PaddingRight=var(--pf-global--spacer--sm, 0.5rem)]
25+
* @cssprop [--pf-c-chip--PaddingBottom=var(--pf-global--spacer--xs, 0.25rem)]
26+
* @cssprop [--pf-c-chip--PaddingLeft=var(--pf-global--spacer--sm, 0.5rem)]
27+
* @cssprop [--pf-c-chip--BackgroundColor=var(--pf-global--Color--light-100, #fff)]
28+
* @cssprop [--pf-c-chip--BorderRadius=var(--pf-global--BorderRadius--sm, 3px)]
29+
* @cssprop [--pf-c-chip--before--BorderColor=var(--pf-global--BorderColor--300, #f0f0f0)]
30+
* @cssprop [--pf-c-chip--before--BorderWidth=var(--pf-global--BorderWidth--sm, 1px)]
31+
* @cssprop [--pf-c-chip--before--BorderRadius=var(--pf-c-chip--BorderRadius)]
32+
* @cssprop [--pf-c-chip--m-overflow__text--Color=var(--pf-global--primary-color--100, #06c)]
33+
* @cssprop [--pf-c-chip--m-draggable--BackgroundColor=var(--pf-global--BackgroundColor--200, #f0f0f0)]
34+
* @cssprop [--pf-c-chip--m-draggable--BoxShadow=var(--pf-global--BoxShadow--sm, 0 0.0625rem 0.125rem 0 rgba(3, 3, 3, 0.12), 0 0 0.125rem 0 rgba(3, 3, 3, 0.06))]
35+
* @cssprop [--pf-c-chip--m-draggable__icon--FontSize=var(--pf-global--icon--FontSize--sm, 0.625rem)]
36+
* @cssprop [--pf-c-chip__text--FontSize=var(--pf-global--FontSize--xs, 0.75rem)]
37+
* @cssprop [--pf-c-chip__text--Color=var(--pf-global--Color--100, #151515)]
38+
* @cssprop [--pf-c-chip__text--MaxWidth=16ch]
39+
* @cssprop [--pf-c-chip__icon--MarginLeft=var(--pf-global--spacer--sm, 0.5rem)]
2340
*/
2441
@customElement('pf-chip')
2542
export class PfChip extends LitElement {

‎elements/pf-clipboard-copy/pf-clipboard-copy.ts‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,31 @@ export class PfClipboardCopyCopiedEvent extends Event {
2424
* @slot - Place content to copy here, or use the `value` attribute
2525
* @slot actions - Place additional action buttons here
2626
* @fires {PfClipboardCopyCopiedEvent} copy - when the text snippet is successfully copied.
27+
* @cssprop [--pf-c-clipboard-copy__toggle-icon--Transition=.2s ease-in 0s]
28+
* @cssprop [--pf-c-clipboard-copy--m-expanded__toggle-icon--Rotate=90deg]
29+
* @cssprop [--pf-c-clipboard-copy__expandable-content--PaddingTop=var(--pf-global--spacer--md, 1rem)]
30+
* @cssprop [--pf-c-clipboard-copy__expandable-content--PaddingRight=var(--pf-global--spacer--md, 1rem)]
31+
* @cssprop [--pf-c-clipboard-copy__expandable-content--PaddingBottom=var(--pf-global--spacer--md, 1rem)]
32+
* @cssprop [--pf-c-clipboard-copy__expandable-content--PaddingLeft=var(--pf-global--spacer--md, 1rem)]
33+
* @cssprop [--pf-c-clipboard-copy__expandable-content--BackgroundColor=var(--pf-global--BackgroundColor--light-100, #fff)]
34+
* @cssprop [--pf-c-clipboard-copy__expandable-content--BorderTopWidth=0]
35+
* @cssprop [--pf-c-clipboard-copy__expandable-content--BorderRightWidth=var(--pf-global--BorderWidth--sm, 1px)]
36+
* @cssprop [--pf-c-clipboard-copy__expandable-content--BorderBottomWidth=var(--pf-global--BorderWidth--sm, 1px)]
37+
* @cssprop [--pf-c-clipboard-copy__expandable-content--BorderLeftWidth=var(--pf-global--BorderWidth--sm, 1px)]
38+
* @cssprop [--pf-c-clipboard-copy__expandable-content--BorderColor=var(--pf-global--BorderColor--100, #d2d2d2)]
39+
* @cssprop [--pf-c-clipboard-copy__expandable-content--OutlineOffset=calc(-1 * var(--pf-global--spacer--xs, 0.25rem))]
40+
* @cssprop [--pf-c-clipboard-copy--m-inline--PaddingTop=0]
41+
* @cssprop [--pf-c-clipboard-copy--m-inline--PaddingBottom=0]
42+
* @cssprop [--pf-c-clipboard-copy--m-inline--PaddingLeft=var(--pf-global--spacer--xs, 0.25rem)]
43+
* @cssprop [--pf-c-clipboard-copy--m-inline--BackgroundColor=var(--pf-global--BackgroundColor--200, #f0f0f0)]
44+
* @cssprop [--pf-c-clipboard-copy__text--m-code--FontFamily=var(--pf-global--FontFamily--monospace, "Liberation Mono", consolas, "SFMono-Regular", menlo, monaco, "Courier New", monospace)]
45+
* @cssprop [--pf-c-clipboard-copy__text--m-code--FontSize=var(--pf-global--FontSize--sm, 0.875rem)]
46+
* @cssprop [--pf-c-clipboard-copy__actions-item--MarginTop=calc(-1 * var(--pf-global--spacer--form-element, 0.375rem))]
47+
* @cssprop [--pf-c-clipboard-copy__actions-item--MarginBottom=calc(-1 * var(--pf-global--spacer--form-element, 0.375rem))]
48+
* @cssprop [--pf-c-clipboard-copy__actions-item--button--PaddingTop=var(--pf-global--spacer--xs, 0.25rem)]
49+
* @cssprop [--pf-c-clipboard-copy__actions-item--button--PaddingRight=var(--pf-global--spacer--sm, 0.5rem)]
50+
* @cssprop [--pf-c-clipboard-copy__actions-item--button--PaddingBottom=var(--pf-global--spacer--xs, 0.25rem)]
51+
* @cssprop [--pf-c-clipboard-copy__actions-item--button--PaddingLeft=var(--pf-global--spacer--sm, 0.5rem)]
2752
*/
2853
@customElement('pf-clipboard-copy')
2954
export class PfClipboardCopy extends LitElement {

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

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,35 @@ import styles from './pf-panel.css';
1414
* @slot header - Place header content here
1515
* @slot - Place main content here
1616
* @slot footer - Place footer content here
17+
* @cssprop [--pf-c-panel--Width=auto]
18+
* @cssprop [--pf-c-panel--MinWidth=auto]
19+
* @cssprop [--pf-c-panel--MaxWidth=none]
20+
* @cssprop [--pf-c-panel--ZIndex=auto]
21+
* @cssprop [--pf-c-panel--BackgroundColor=var(--pf-global--BackgroundColor--100, #fff)]
22+
* @cssprop [--pf-c-panel--BoxShadow=none]
23+
* @cssprop [--pf-c-panel--before--BorderWidth=0]
24+
* @cssprop [--pf-c-panel--before--BorderColor=var(--pf-global--BorderColor--100, #d2d2d2)]
25+
* @cssprop [--pf-c-panel--m-bordered--before--BorderWidth=var(--pf-global--BorderWidth--sm, 1px)]
26+
* @cssprop [--pf-c-panel--m-raised--BoxShadow=var(--pf-global--BoxShadow--md, 0 0.25rem 0.5rem 0rem rgba(3, 3, 3, 0.12), 0 0 0.25rem 0 rgba(3, 3, 3, 0.06))]
27+
* @cssprop [--pf-c-panel--m-raised--ZIndex=var(--pf-global--ZIndex--sm, 200)]
28+
* @cssprop [--pf-c-panel__header--PaddingTop=var(--pf-global--spacer--md, 1rem)]
29+
* @cssprop [--pf-c-panel__header--PaddingRight=var(--pf-global--spacer--md, 1rem)]
30+
* @cssprop [--pf-c-panel__header--PaddingBottom=var(--pf-global--spacer--md, 1rem)]
31+
* @cssprop [--pf-c-panel__header--PaddingLeft=var(--pf-global--spacer--md, 1rem)]
32+
* @cssprop [--pf-c-panel__main--MaxHeight=none]
33+
* @cssprop [--pf-c-panel__main--Overflow=visible]
34+
* @cssprop [--pf-c-panel__main-body--PaddingTop=var(--pf-global--spacer--md, 1rem)]
35+
* @cssprop [--pf-c-panel__main-body--PaddingRight=var(--pf-global--spacer--md, 1rem)]
36+
* @cssprop [--pf-c-panel__main-body--PaddingBottom=var(--pf-global--spacer--md, 1rem)]
37+
* @cssprop [--pf-c-panel__main-body--PaddingLeft=var(--pf-global--spacer--md, 1rem)]
38+
* @cssprop [--pf-c-panel__footer--PaddingTop=var(--pf-global--spacer--md, 1rem)]
39+
* @cssprop [--pf-c-panel__footer--PaddingRight=var(--pf-global--spacer--md, 1rem)]
40+
* @cssprop [--pf-c-panel__footer--PaddingBottom=var(--pf-global--spacer--md, 1rem)]
41+
* @cssprop [--pf-c-panel__footer--PaddingLeft=var(--pf-global--spacer--md, 1rem)]
42+
* @cssprop [--pf-c-panel__footer--BoxShadow=none]
43+
* @cssprop [--pf-c-panel--m-scrollable__main--MaxHeight=18.75rem]
44+
* @cssprop [--pf-c-panel--m-scrollable__main--Overflow=auto]
45+
* @cssprop [--pf-c-panel--m-scrollable__footer--BoxShadow=0 -0.3125rem 0.25rem -0.25rem rgba(3, 3, 3, 0.16)]
1746
*/
1847
@customElement('pf-panel')
1948
export class PfPanel extends LitElement {

0 commit comments

Comments
 (0)