Skip to content

Commit dc10b71

Browse files
committed
chore(*): cleanup jsdocs css prop definiations
1 parent 255e4f5 commit dc10b71

File tree

7 files changed

+3
-25
lines changed

7 files changed

+3
-25
lines changed

src/components/Accordion/sgds-accordion-item.ts

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,6 @@ import accordionItemStyle from "./accordion-item.css";
2323
* @slot accordion-content - The accordion-item content slot.
2424
* @slot accordion-caret - The caret icon of accordion-item.
2525
*
26-
* @cssprop --accordion-item-padding-y - The top and bottom padding for the container of accordion item's content
27-
* @cssprop --accordion-item-padding-x - The right and left padding for the container of accordion item's content
28-
* @cssprop --accordion-item-border-radius - The border radius of the accordion item
29-
* @cssprop --accordion-item-font-weight - The font weight of accordion-btn when it is not collapsed
30-
* @cssprop --accordion-item-line-height - The line height of accordion
3126
*/
3227
export class SgdsAccordionItem extends SgdsElement {
3328
static styles = [...SgdsElement.styles, accordionItemStyle];

src/components/Accordion/sgds-accordion.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ const VALID_KEYS = ["Enter", "ArrowUp", "ArrowLeft", "ArrowDown", "ArrowRight"];
1414
* @summary A dropdown mechanism that allow users to either show or hide related content. `SgdsAccordion` is a wrapper to manage the behaviour for multiple `SgdsAccordionItems`
1515
* @slot default - slot for accordion-item
1616
*
17-
* @cssprop --accordion-active-color - The colour of accordion when it is active
1817
*/
1918

2019
export class SgdsAccordion extends SgdsElement {

src/components/Alert/sgds-alert-link.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ import anchorStyles from "../../styles/anchor.css";
88
* @summary Alert link are used within the alert's message that is passed into the default slot of `<sgds-alert>`
99
*
1010
* @slot default - The text content of the anchor element
11-
* @cssproperty --alert-link-anchor-color - The margin-right css of icon slot, to position the gap between icon and alert message
1211
*/
1312
export class SgdsAlertLink extends SgdsElement {
1413
static styles = [...SgdsElement.styles, anchorStyles, alertLinkStyle];

src/components/Alert/sgds-alert.ts

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,6 @@ export type AlertVariant = "info" | "success" | "danger" | "warning" | "neutral"
1818
* @event sgds-show - Emitted when the alert appears.
1919
* @event sgds-hide - Emitted after the alert closes.
2020
*
21-
* @cssproperty --alert-bg - The background color of alert
22-
* @cssproperty --alert-border-color - The color of the border of alert
23-
* @cssproperty --alert-icon-margin-right - The margin-right css of icon slot to position the gap between icon and alert message
24-
*
2521
*/
2622
export class SgdsAlert extends ScopedElementsMixin(SgdsElement) {
2723
static styles = [...SgdsElement.styles, alertStyle];

src/components/Badge/sgds-badge.ts

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,6 @@ export type BadgeVariant = "info" | "success" | "danger" | "warning" | "neutral"
1717
*
1818
* @event sgds-show - Emitted when the badge appears.
1919
* @event sgds-hide - Emitted after the badge closes.
20-
*
21-
* @cssprop --sgds-badge-bg - The background color of the badge
22-
* @cssprop --sgds-badge-color - The text color of badge
23-
* @cssprop --sgds-badge-border-radius - The border radius of badge
24-
* @cssprop --sgds-badge-border-color - The border color of the badge, only applicable when outlined prop is true
25-
*
2620
*/
2721
export class SgdsBadge extends ScopedElementsMixin(SgdsElement) {
2822
static styles = [...SgdsElement.styles, badgeStyle];

src/components/Button/sgds-button.ts

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,6 @@ export type ButtonVariant = "primary" | "outline" | "ghost" | "danger";
1919
* @event sgds-blur - Emitted when the button is blurred.
2020
* @event sgds-focus - Emitted when the button is focused.
2121
*
22-
* @cssprop --sgds-btn-font-weight - The font weight of text content in button
23-
* @cssprop --sgds-btn-bg - The background color of button
24-
* @cssprop --sgds-btn-hover-bg - The background color of a button in hover state
25-
* @cssprop --sgds-btn-border-radius - The border radius of button border
26-
* @cssprop --sgds-btn-color - The text color of button, applicable to primary, outline, and ghost variants only
27-
* @cssprop --sgds-btn-border-width - The thickness of the button border, applicable to outline variant only
28-
* @cssprop --sgds-btn-border-color - The color of the button border, applicable to outline variant only
2922
*
3023
*/
3124
export class SgdsButton extends ButtonElement {

src/components/Progress/sgds-progress-bar.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ import { styleMap } from "lit/directives/style-map.js";
44
import SgdsElement from "../../base/sgds-element";
55
import progressBarStyle from "./progress-bar.css";
66
export type ProgressBarVariant = "primary" | "neutral";
7-
7+
/**
8+
* @summary Provide up-to-date feedback on the progress of a workflow or action with simple yet flexible progress bars.
9+
*/
810
export class SgdsProgressBar extends SgdsElement {
911
static styles = [...SgdsElement.styles, progressBarStyle];
1012

0 commit comments

Comments
 (0)