@kubex/zinc 1.1.77 → 1.1.79

package/dist/custom-elements.json

@@ -32072,12 +32072,32 @@
             {
               "description": "An example CSS custom property.",
               "name": "--example"
+            },
+            {
+              "description": "The color of the preview value.",
+              "name": "--preview-color"
+            },
+            {
+              "description": "The font size of the preview value.",
+              "name": "--preview-size"
             }
           ],
           "cssParts": [
+            {
+              "description": "The form control that wraps the symbols and help text.",
+              "name": "form-control"
+            },
+            {
+              "description": "The help text's wrapper.",
+              "name": "form-control-help-text"
+            },
             {
               "description": "The component's base wrapper.",
               "name": "base"
+            },
+            {
+              "description": "The value shown next to the symbols when `preview` is enabled.",
+              "name": "preview"
             }
           ],
           "slots": [
@@ -32088,6 +32108,10 @@
             {
               "description": "An example slot.",
               "name": "example"
+            },
+            {
+              "description": "Text that describes how to use the rating. Alternatively, you can use the `help-text` attribute.",
+              "name": "help-text"
             }
           ],
           "members": [
@@ -32098,6 +32122,13 @@
               "readonly": true,
               "default": "new FormControlController(this, { assumeInteractionOn: ['zn-blur', 'zn-input'] })"
             },
+            {
+              "kind": "field",
+              "name": "hasSlotController",
+              "privacy": "private",
+              "readonly": true,
+              "default": "new HasSlotController(this, 'help-text')"
+            },
             {
               "kind": "field",
               "name": "rating",
@@ -32105,6 +32136,13 @@
                 "text": "HTMLElement"
               }
             },
+            {
+              "kind": "field",
+              "name": "symbols",
+              "type": {
+                "text": "HTMLElement"
+              }
+            },
             {
               "kind": "field",
               "name": "hoverValue",
@@ -32131,6 +32169,16 @@
               },
               "attribute": "label"
             },
+            {
+              "kind": "field",
+              "name": "helpText",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "description": "The rating's help text. If you need to display HTML, use the `help-text` slot instead.",
+              "attribute": "help-text"
+            },
             {
               "kind": "field",
               "name": "name",
@@ -32184,6 +32232,16 @@
               "default": "false",
               "attribute": "disabled"
             },
+            {
+              "kind": "field",
+              "name": "preview",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Displays the value alongside the symbols, updating live as the pointer moves across them.",
+              "attribute": "preview"
+            },
             {
               "kind": "field",
               "name": "size",
@@ -32285,6 +32343,24 @@
                 }
               ]
             },
+            {
+              "kind": "method",
+              "name": "_formatValue",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "string"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "value",
+                  "type": {
+                    "text": "number"
+                  }
+                }
+              ]
+            },
             {
               "kind": "method",
               "name": "_getValueFromMousePosition",
@@ -32432,6 +32508,15 @@
               },
               "fieldName": "label"
             },
+            {
+              "name": "help-text",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "description": "The rating's help text. If you need to display HTML, use the `help-text` slot instead.",
+              "fieldName": "helpText"
+            },
             {
               "name": "name",
               "type": {
@@ -32479,6 +32564,15 @@
               "default": "false",
               "fieldName": "disabled"
             },
+            {
+              "name": "preview",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Displays the value alongside the symbols, updating live as the pointer moves across them.",
+              "fieldName": "preview"
+            },
             {
               "name": "size",
               "type": {
@@ -32503,7 +32597,7 @@
           "tagNameWithoutPrefix": "rating",
           "tagName": "zn-rating",
           "customElement": true,
-          "jsDoc": "/**\n * @summary Short summary of the component's intended use.\n * @documentation https://zinc.style/components/rating\n * @status experimental\n * @since 1.0\n *\n * @dependency zn-example\n *\n * @event zn-event-name - Emitted as an example.\n *\n * @slot - The default slot.\n * @slot example - An example slot.\n *\n * @csspart base - The component's base wrapper.\n *\n * @cssproperty --example - An example CSS custom property.\n */",
+          "jsDoc": "/**\n * @summary Short summary of the component's intended use.\n * @documentation https://zinc.style/components/rating\n * @status experimental\n * @since 1.0\n *\n * @dependency zn-example\n *\n * @event zn-event-name - Emitted as an example.\n *\n * @slot - The default slot.\n * @slot example - An example slot.\n * @slot help-text - Text that describes how to use the rating. Alternatively, you can use the `help-text` attribute.\n *\n * @csspart form-control - The form control that wraps the symbols and help text.\n * @csspart form-control-help-text - The help text's wrapper.\n * @csspart base - The component's base wrapper.\n * @csspart preview - The value shown next to the symbols when `preview` is enabled.\n *\n * @cssproperty --example - An example CSS custom property.\n * @cssproperty --preview-color - The color of the preview value.\n * @cssproperty --preview-size - The font size of the preview value.\n */",
           "documentation": "https://zinc.style/components/rating",
           "status": "experimental",
           "since": "1.0",
@@ -44374,7 +44468,7 @@
   "package": {
     "name": "@kubex/zinc",
     "description": "A collection of web components for building web applications based off of @shoelace-style/Shoelace",
-    "version": "1.1.77",
+    "version": "1.1.79",
     "author": "",
     "license": "MIT"
   }

package/dist/vscode.html-custom-data.json

@@ -3302,15 +3302,25 @@
     },
     {
       "name": "zn-rating",
-      "description": "Short summary of the component's intended use.\n---\n\n\n### **Events:**\n - **zn-event-name** - Emitted as an example.\n\n### **Methods:**\n - **checkValidity(): _boolean_** - Checks the validity but does not show a validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity()** - Sets a custom validation message. Pass an empty string to restore validity.\n\n### **Slots:**\n - _default_ - The default slot.\n- **example** - An example slot.\n\n### **CSS Properties:**\n - **--example** - An example CSS custom property. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
+      "description": "Short summary of the component's intended use.\n---\n\n\n### **Events:**\n - **zn-event-name** - Emitted as an example.\n\n### **Methods:**\n - **checkValidity(): _boolean_** - Checks the validity but does not show a validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity()** - Sets a custom validation message. Pass an empty string to restore validity.\n\n### **Slots:**\n - _default_ - The default slot.\n- **example** - An example slot.\n- **help-text** - Text that describes how to use the rating. Alternatively, you can use the `help-text` attribute.\n\n### **CSS Properties:**\n - **--example** - An example CSS custom property. _(default: undefined)_\n- **--preview-color** - The color of the preview value. _(default: undefined)_\n- **--preview-size** - The font size of the preview value. _(default: undefined)_\n\n### **CSS Parts:**\n - **form-control** - The form control that wraps the symbols and help text.\n- **form-control-help-text** - The help text's wrapper.\n- **base** - The component's base wrapper.\n- **preview** - The value shown next to the symbols when `preview` is enabled.",
       "attributes": [
         { "name": "label", "values": [] },
+        {
+          "name": "help-text",
+          "description": "The rating's help text. If you need to display HTML, use the `help-text` slot instead.",
+          "values": []
+        },
         { "name": "name", "values": [] },
         { "name": "value", "values": [] },
         { "name": "max", "values": [] },
         { "name": "precision", "values": [] },
         { "name": "readonly", "values": [] },
         { "name": "disabled", "values": [] },
+        {
+          "name": "preview",
+          "description": "Displays the value alongside the symbols, updating live as the pointer moves across them.",
+          "values": []
+        },
         {
           "name": "size",
           "values": [

package/dist/web-types.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
   "name": "@kubex/zinc",
-  "version": "1.1.77",
+  "version": "1.1.79",
   "description-markup": "markdown",
   "contributions": {
     "html": {
@@ -7709,10 +7709,15 @@
         },
         {
           "name": "zn-rating",
-          "description": "Short summary of the component's intended use.\n---\n\n\n### **Events:**\n - **zn-event-name** - Emitted as an example.\n\n### **Methods:**\n - **checkValidity(): _boolean_** - Checks the validity but does not show a validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity()** - Sets a custom validation message. Pass an empty string to restore validity.\n\n### **Slots:**\n - _default_ - The default slot.\n- **example** - An example slot.\n\n### **CSS Properties:**\n - **--example** - An example CSS custom property. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
+          "description": "Short summary of the component's intended use.\n---\n\n\n### **Events:**\n - **zn-event-name** - Emitted as an example.\n\n### **Methods:**\n - **checkValidity(): _boolean_** - Checks the validity but does not show a validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity()** - Sets a custom validation message. Pass an empty string to restore validity.\n\n### **Slots:**\n - _default_ - The default slot.\n- **example** - An example slot.\n- **help-text** - Text that describes how to use the rating. Alternatively, you can use the `help-text` attribute.\n\n### **CSS Properties:**\n - **--example** - An example CSS custom property. _(default: undefined)_\n- **--preview-color** - The color of the preview value. _(default: undefined)_\n- **--preview-size** - The font size of the preview value. _(default: undefined)_\n\n### **CSS Parts:**\n - **form-control** - The form control that wraps the symbols and help text.\n- **form-control-help-text** - The help text's wrapper.\n- **base** - The component's base wrapper.\n- **preview** - The value shown next to the symbols when `preview` is enabled.",
           "doc-url": "",
           "attributes": [
             { "name": "label", "value": { "type": "string" } },
+            {
+              "name": "help-text",
+              "description": "The rating's help text. If you need to display HTML, use the `help-text` slot instead.",
+              "value": { "type": "string", "default": "''" }
+            },
             { "name": "name", "value": { "type": "string" } },
             { "name": "value", "value": { "type": "number", "default": "0" } },
             { "name": "max", "value": { "type": "number", "default": "5" } },
@@ -7728,6 +7733,11 @@
               "name": "disabled",
               "value": { "type": "boolean", "default": "false" }
             },
+            {
+              "name": "preview",
+              "description": "Displays the value alongside the symbols, updating live as the pointer moves across them.",
+              "value": { "type": "boolean", "default": "false" }
+            },
             {
               "name": "size",
               "value": {
@@ -7742,7 +7752,11 @@
           ],
           "slots": [
             { "name": "", "description": "The default slot." },
-            { "name": "example", "description": "An example slot." }
+            { "name": "example", "description": "An example slot." },
+            {
+              "name": "help-text",
+              "description": "Text that describes how to use the rating. Alternatively, you can use the `help-text` attribute."
+            }
           ],
           "events": [
             { "name": "zn-event-name", "description": "Emitted as an example." }
@@ -7750,13 +7764,24 @@
           "js": {
             "properties": [
               { "name": "rating", "type": "HTMLElement" },
+              { "name": "symbols", "type": "HTMLElement" },
               { "name": "label", "type": "string" },
+              {
+                "name": "helpText",
+                "description": "The rating's help text. If you need to display HTML, use the `help-text` slot instead.",
+                "type": "string"
+              },
               { "name": "name", "type": "string" },
               { "name": "value", "type": "number" },
               { "name": "max", "type": "number" },
               { "name": "precision", "type": "number" },
               { "name": "readonly", "type": "boolean" },
               { "name": "disabled", "type": "boolean" },
+              {
+                "name": "preview",
+                "description": "Displays the value alongside the symbols, updating live as the pointer moves across them.",
+                "type": "boolean"
+              },
               { "name": "size", "type": "'small' | 'medium' | 'large'" },
               { "name": "getSymbol", "type": "(value: number) => string" },
               {

package/dist/zn.d.ts

@@ -6939,24 +6939,36 @@ declare module "components/rating/rating.component" {
      *
      * @slot - The default slot.
      * @slot example - An example slot.
+     * @slot help-text - Text that describes how to use the rating. Alternatively, you can use the `help-text` attribute.
      *
+     * @csspart form-control - The form control that wraps the symbols and help text.
+     * @csspart form-control-help-text - The help text's wrapper.
      * @csspart base - The component's base wrapper.
+     * @csspart preview - The value shown next to the symbols when `preview` is enabled.
      *
      * @cssproperty --example - An example CSS custom property.
+     * @cssproperty --preview-color - The color of the preview value.
+     * @cssproperty --preview-size - The font size of the preview value.
      */
     export default class ZnRating extends ZincElement implements ZincFormControl {
         static styles: CSSResultGroup;
         private readonly formControlController;
+        private readonly hasSlotController;
         rating: HTMLElement;
+        symbols: HTMLElement;
         private hoverValue;
         private isHovering;
         label: string;
+        /** The rating's help text. If you need to display HTML, use the `help-text` slot instead. */
+        helpText: string;
         name: string;
         value: number;
         max: number;
         precision: number;
         readonly: boolean;
         disabled: boolean;
+        /** Displays the value alongside the symbols, updating live as the pointer moves across them. */
+        preview: boolean;
         size: 'small' | 'medium' | 'large';
         getSymbol: (value: number) => string;
         /** Gets the validity state object */
@@ -6973,6 +6985,7 @@ declare module "components/rating/rating.component" {
         setCustomValidity(): void;
         private _roundToPrecision;
         private _getValueFromXCoordinate;
+        private _formatValue;
         private _getValueFromMousePosition;
         private _getValueFromTouchPosition;
         private _setValue;