chore: clean build (#2744)

Clean up after merging the rating component.
swisspost · Mar 1, 2024 · 2552e06 · 2552e06
1 parent 8715a34
commit 2552e06
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 19 deletions.
diff --git a/packages/components/src/components.d.ts b/packages/components/src/components.d.ts
@@ -169,19 +169,19 @@ export namespace Components {
     }
     interface PostRating {
         /**
-          * Defines the visualized overall rating, the component should show.
+          * Defines the rating that the component should show.
          */
         "currentRating": number;
         /**
-          * Defined the invisible label on the component.
+          * Defines a hidden label for the component.
          */
         "label": string;
         /**
           * Defines if the component is readonly or not. This usually should be used together with the `currentRating` property.
          */
         "readonly": boolean;
         /**
-          * Defined the amount of stars rendered in the component.
+          * Defines the total amount of stars rendered in the component.
          */
         "stars": number;
     }
@@ -333,8 +333,8 @@ declare global {
         new (): HTMLPostPopovercontainerElement;
     };
     interface HTMLPostRatingElementEventMap {
-        "input": {value: number};
-        "change": {value: number};
+        "input": { value: number };
+        "change": { value: number };
     }
     interface HTMLPostRatingElement extends Components.PostRating, HTMLStencilElement {
         addEventListener<K extends keyof HTMLPostRatingElementEventMap>(type: K, listener: (this: HTMLPostRatingElement, ev: PostRatingCustomEvent<HTMLPostRatingElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -516,27 +516,27 @@ declare namespace LocalJSX {
     }
     interface PostRating {
         /**
-          * Defines the visualized overall rating, the component should show.
+          * Defines the rating that the component should show.
          */
         "currentRating"?: number;
         /**
-          * Defined the invisible label on the component.
+          * Defines a hidden label for the component.
          */
         "label"?: string;
         /**
-          * An event emitted whenever the components value has changed (on blur). The event payload can be used like so: `event.detail.value`.
+          * An event emitted whenever the component's value has changed (on blur). The event payload can be used like so: `event.detail.value`.
          */
-        "onChange"?: (event: PostRatingCustomEvent<{value: number}>) => void;
+        "onChange"?: (event: PostRatingCustomEvent<{ value: number }>) => void;
         /**
-          * An event emitted whenever the components value has changed (on input). The event payload can be used like so: `event.detail.value`.
+          * An event emitted whenever the component's value has changed (on input). The event payload can be used like so: `event.detail.value`.
          */
-        "onInput"?: (event: PostRatingCustomEvent<{value: number}>) => void;
+        "onInput"?: (event: PostRatingCustomEvent<{ value: number }>) => void;
         /**
           * Defines if the component is readonly or not. This usually should be used together with the `currentRating` property.
          */
         "readonly"?: boolean;
         /**
-          * Defined the amount of stars rendered in the component.
+          * Defines the total amount of stars rendered in the component.
          */
         "stars"?: number;
     }

diff --git a/packages/components/src/components/post-rating/readme.md b/packages/components/src/components/post-rating/readme.md
@@ -9,18 +9,18 @@
 
 | Property        | Attribute        | Description                                                                                                          | Type      | Default    |
 | --------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------- | --------- | ---------- |
-| `currentRating` | `current-rating` | Defines the visualized overall rating, the component should show.                                                    | `number`  | `0`        |
-| `label`         | `label`          | Defined the invisible label on the component.                                                                        | `string`  | `'Rating'` |
+| `currentRating` | `current-rating` | Defines the rating that the component should show.                                                                   | `number`  | `0`        |
+| `label`         | `label`          | Defines a hidden label for the component.                                                                            | `string`  | `'Rating'` |
 | `readonly`      | `readonly`       | Defines if the component is readonly or not. This usually should be used together with the `currentRating` property. | `boolean` | `false`    |
-| `stars`         | `stars`          | Defined the amount of stars rendered in the component.                                                               | `number`  | `5`        |
+| `stars`         | `stars`          | Defines the total amount of stars rendered in the component.                                                         | `number`  | `5`        |
 
 
 ## Events
 
-| Event    | Description                                                                                                                         | Type                              |
-| -------- | ----------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
-| `change` | An event emitted whenever the components value has changed (on blur). The event payload can be used like so: `event.detail.value`.  | `CustomEvent<{ value: number; }>` |
-| `input`  | An event emitted whenever the components value has changed (on input). The event payload can be used like so: `event.detail.value`. | `CustomEvent<{ value: number; }>` |
+| Event    | Description                                                                                                                          | Type                              |
+| -------- | ------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------- |
+| `change` | An event emitted whenever the component's value has changed (on blur). The event payload can be used like so: `event.detail.value`.  | `CustomEvent<{ value: number; }>` |
+| `input`  | An event emitted whenever the component's value has changed (on input). The event payload can be used like so: `event.detail.value`. | `CustomEvent<{ value: number; }>` |
 
 
 ## Dependencies