Skip to content

Commit

Permalink
chore(*): cleanup jsdocs css prop definiations
Browse files Browse the repository at this point in the history
  • Loading branch information
clukhei committed Oct 28, 2024
1 parent 255e4f5 commit dc10b71
Show file tree
Hide file tree
Showing 7 changed files with 3 additions and 25 deletions.
5 changes: 0 additions & 5 deletions src/components/Accordion/sgds-accordion-item.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,6 @@ import accordionItemStyle from "./accordion-item.css";
* @slot accordion-content - The accordion-item content slot.
* @slot accordion-caret - The caret icon of accordion-item.
*
* @cssprop --accordion-item-padding-y - The top and bottom padding for the container of accordion item's content
* @cssprop --accordion-item-padding-x - The right and left padding for the container of accordion item's content
* @cssprop --accordion-item-border-radius - The border radius of the accordion item
* @cssprop --accordion-item-font-weight - The font weight of accordion-btn when it is not collapsed
* @cssprop --accordion-item-line-height - The line height of accordion
*/
export class SgdsAccordionItem extends SgdsElement {
static styles = [...SgdsElement.styles, accordionItemStyle];
Expand Down
1 change: 0 additions & 1 deletion src/components/Accordion/sgds-accordion.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ const VALID_KEYS = ["Enter", "ArrowUp", "ArrowLeft", "ArrowDown", "ArrowRight"];
* @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`
* @slot default - slot for accordion-item
*
* @cssprop --accordion-active-color - The colour of accordion when it is active
*/

export class SgdsAccordion extends SgdsElement {
Expand Down
1 change: 0 additions & 1 deletion src/components/Alert/sgds-alert-link.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ import anchorStyles from "../../styles/anchor.css";
* @summary Alert link are used within the alert's message that is passed into the default slot of `<sgds-alert>`
*
* @slot default - The text content of the anchor element
* @cssproperty --alert-link-anchor-color - The margin-right css of icon slot, to position the gap between icon and alert message
*/
export class SgdsAlertLink extends SgdsElement {
static styles = [...SgdsElement.styles, anchorStyles, alertLinkStyle];
Expand Down
4 changes: 0 additions & 4 deletions src/components/Alert/sgds-alert.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,6 @@ export type AlertVariant = "info" | "success" | "danger" | "warning" | "neutral"
* @event sgds-show - Emitted when the alert appears.
* @event sgds-hide - Emitted after the alert closes.
*
* @cssproperty --alert-bg - The background color of alert
* @cssproperty --alert-border-color - The color of the border of alert
* @cssproperty --alert-icon-margin-right - The margin-right css of icon slot to position the gap between icon and alert message
*
*/
export class SgdsAlert extends ScopedElementsMixin(SgdsElement) {
static styles = [...SgdsElement.styles, alertStyle];
Expand Down
6 changes: 0 additions & 6 deletions src/components/Badge/sgds-badge.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,6 @@ export type BadgeVariant = "info" | "success" | "danger" | "warning" | "neutral"
*
* @event sgds-show - Emitted when the badge appears.
* @event sgds-hide - Emitted after the badge closes.
*
* @cssprop --sgds-badge-bg - The background color of the badge
* @cssprop --sgds-badge-color - The text color of badge
* @cssprop --sgds-badge-border-radius - The border radius of badge
* @cssprop --sgds-badge-border-color - The border color of the badge, only applicable when outlined prop is true
*
*/
export class SgdsBadge extends ScopedElementsMixin(SgdsElement) {
static styles = [...SgdsElement.styles, badgeStyle];
Expand Down
7 changes: 0 additions & 7 deletions src/components/Button/sgds-button.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,6 @@ export type ButtonVariant = "primary" | "outline" | "ghost" | "danger";
* @event sgds-blur - Emitted when the button is blurred.
* @event sgds-focus - Emitted when the button is focused.
*
* @cssprop --sgds-btn-font-weight - The font weight of text content in button
* @cssprop --sgds-btn-bg - The background color of button
* @cssprop --sgds-btn-hover-bg - The background color of a button in hover state
* @cssprop --sgds-btn-border-radius - The border radius of button border
* @cssprop --sgds-btn-color - The text color of button, applicable to primary, outline, and ghost variants only
* @cssprop --sgds-btn-border-width - The thickness of the button border, applicable to outline variant only
* @cssprop --sgds-btn-border-color - The color of the button border, applicable to outline variant only
*
*/
export class SgdsButton extends ButtonElement {
Expand Down
4 changes: 3 additions & 1 deletion src/components/Progress/sgds-progress-bar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ import { styleMap } from "lit/directives/style-map.js";
import SgdsElement from "../../base/sgds-element";
import progressBarStyle from "./progress-bar.css";
export type ProgressBarVariant = "primary" | "neutral";

/**
* @summary Provide up-to-date feedback on the progress of a workflow or action with simple yet flexible progress bars.
*/
export class SgdsProgressBar extends SgdsElement {
static styles = [...SgdsElement.styles, progressBarStyle];

Expand Down

0 comments on commit dc10b71

Please sign in to comment.