@quidgest/ui 0.14.0 → 0.14.2

package/esm/components/QPropertyList/QPropertyListRow.vue.js

@@ -1,5 +1,8 @@
-import { defineComponent as y, computed as o, openBlock as a, createElementBlock as q, normalizeClass as c, createElementVNode as n, toDisplayString as v, renderSlot as C, createBlock as h, resolveDynamicComponent as g, mergeProps as k } from "vue";
-const B = { class: "q-property-list-field__container" }, b = /* @__PURE__ */ y({
+import { defineComponent as v, computed as o, openBlock as n, createElementBlock as a, normalizeClass as c, createElementVNode as i, toDisplayString as q, renderSlot as C, createBlock as h, resolveDynamicComponent as k, mergeProps as g, createCommentVNode as V } from "vue";
+const B = {
+  key: 0,
+  class: "q-property-list-field__container"
+}, P = /* @__PURE__ */ v({
   __name: "QPropertyListRow",
   props: {
     field: {},
@@ -7,50 +10,50 @@ const B = { class: "q-property-list-field__container" }, b = /* @__PURE__ */ y({
     readonly: { type: Boolean }
   },
   emits: ["focus", "field-change"],
-  setup(i, { emit: p }) {
-    const e = i, r = p, d = o(() => ["q-property-list__row", e.class]), u = o(() => {
-      var t;
+  setup(p, { emit: d }) {
+    const e = p, r = d, u = o(() => ["q-property-list__row", e.class]), f = o(() => {
+      var s;
       const l = ["q-property-list__cell", "q-property-list__cell--label"];
-      return (t = e.field.props) != null && t.required && l.push("q-property-list__cell--required"), l;
-    }), f = o(() => e.readonly || (e.field.props.readonly ?? !1));
-    function s() {
+      return (s = e.field.props) != null && s.required && l.push("q-property-list__cell--required"), l;
+    }), m = o(() => e.readonly || (e.field.props.readonly ?? !1));
+    function t() {
       r("focus", e.field);
     }
-    function m(l) {
+    function _(l) {
       r("field-change", e.field, l);
     }
-    const _ = o(() => ({
+    const y = o(() => ({
       ...e.field.props,
-      readonly: f.value
+      readonly: m.value
     }));
-    return (l, t) => (a(), q(
+    return (l, s) => (n(), a(
       "tr",
       {
-        class: c(d.value),
-        onFocusin: s
+        class: c(u.value),
+        onFocusin: t
       },
       [
-        n(
+        i(
           "td",
           {
-            class: c(u.value),
-            onClick: s
+            class: c(f.value),
+            onClick: t
           },
-          v(e.field.label),
+          q(e.field.label),
           3
           /* TEXT, CLASS */
         ),
-        n("td", {
+        i("td", {
           class: "q-property-list__cell",
-          onClick: s
+          onClick: t
         }, [
           C(l.$slots, "default", {}, () => [
-            n("div", B, [
-              (a(), h(g(e.field.component), k(_.value, {
+            e.field.component ? (n(), a("div", B, [
+              (n(), h(k(e.field.component), g(y.value, {
                 "model-value": e.field.props.modelValue,
-                "onUpdate:modelValue": m
+                "onUpdate:modelValue": _
               }), null, 16, ["model-value"]))
-            ])
+            ])) : V("v-if", !0)
           ])
         ])
       ],
@@ -60,5 +63,5 @@ const B = { class: "q-property-list-field__container" }, b = /* @__PURE__ */ y({
   }
 });
 export {
-  b as default
+  P as default
 };

package/esm/components/QPropertyList/index.d.ts

@@ -3,7 +3,6 @@ import { default as _QPropertyListRow } from './QPropertyListRow';
 import { default as _QPropertyListGroup } from './QPropertyListGroup';
 import { default as _QPropertyListPanel } from './QPropertyListPanel';
 import { QPropertyListProps, QPropertyListRowProps, QPropertyListGroupProps, QPropertyListPanelProps } from './types';
-
 declare const QPropertyList: typeof _QPropertyList;
 declare const QPropertyListRow: typeof _QPropertyListRow;
 declare const QPropertyListGroup: typeof _QPropertyListGroup;

package/esm/components/QPropertyList/types.d.ts

@@ -1,101 +1,133 @@
 import { Icon } from '../QIcon';
-import { Component } from 'vue';
-
-export type PanelPostion = 'bottom' | 'right';
+/**
+ * Position where the panel should be rendered relative to the main content
+ * @value 'bottom' - Panel appears below the main content
+ * @value 'right' - Panel appears to the right of the main content
+ */
+export type PanelPosition = 'bottom' | 'right';
 export type QPropertyListProps = {
     /**
-     * List of fields to be rendered
+     * Array of field configurations that define the content and behavior
+     * of each property list item
      */
     fields?: QPropertyListField[];
     /**
-     * Disables/Enables the description panel
+     * When true, hides the description panel that displays additional field information.
      */
     noPanel?: boolean;
     /**
-     * Decides if the groups have the toggle functionality
+     * When true, disables the ability to expand/collapse property groups.
      */
     noToggle?: boolean;
     /**
-     * Decides the panel positioning (bottom, right)
+     * Determines the layout position of the description panel.
      */
-    panelPosition?: PanelPostion;
+    panelPosition?: PanelPosition;
     /**
-     * The row groups used for organizing the available fields.
+     * Configuration for property groups used to organize and categorize fields.
      */
     groups?: QPropertyListGroupProps[];
     /**
-     * Custom set of classes to apply to the component.
+     * When true, renders all fields in a read-only state preventing user interaction.
+     */
+    readonly?: boolean;
+    /**
+     * Custom CSS classes to apply to the root element.
      */
     class?: string | unknown[];
     /**
-     * The internal elements of the component
+     * Custom icon configurations.
      */
-    internals?: Internals;
+    icons?: typeof DEFAULT_ICONS;
     /**
-     * Decides if the component is readonly
+     * Custom text configurations.
      */
-    readonly?: boolean;
+    texts?: typeof DEFAULT_TEXTS;
 };
 export type QPropertyListGroupProps = {
     /**
-     * The group id
+     * Unique identifier for the property group.
      */
     id: string;
     /**
-     * The group title
+     * Display title for the group header.
      */
     title: string;
     /**
-     * Decided if the group has toggle functionality
+     * When true, disables the expand/collapse functionality for this specific group,
+     * keeping it permanently expanded.
      */
     noToggle?: boolean;
     /**
-     * The internal elements of the component
+     * Custom icon configurations.
+     */
+    icons?: typeof DEFAULT_ICONS;
+    /**
+     * Custom text configurations.
      */
-    internals?: Internals;
+    texts?: typeof DEFAULT_TEXTS;
 };
 export type QPropertyListField = {
+    /**
+     * Unique identifier for the field.
+     */
     id: string;
+    /**
+     * Associates the field with a specific group.
+     */
     group?: string;
+    /**
+     * Display label that appears above the field input.
+     */
     label: string;
+    /**
+     * Additional explanatory text shown below the field.
+     */
     description?: string;
-    component: string | Component;
+    /**
+     * Component responsible for rendering the field's input element.
+     */
+    component?: string;
+    /**
+     * Configuration object passed as props to the rendered component.
+     * Supports any valid props accepted by the specified component.
+     * @example { placeholder: 'Enter value', disabled: false }
+     */
     props: Record<string, unknown>;
 };
 export type QPropertyListRowProps = {
     /**
-     * The field to be rendered
+     * Configuration object for the field to be rendered within this row.
      */
     field: QPropertyListField;
     /**
-     * Custom set of classes to apply to the component.
+     * Custom CSS classes to apply to the row element.
      */
     class?: string | unknown[];
     /**
-     * Decides if the row is readonly
+     * When true, renders the field in a read-only state preventing user interaction.
      */
     readonly?: boolean;
 };
 export type QPropertyListPanelProps = {
     /**
-     * The field to be rendered
+     * Configuration object for the currently selected field to display
+     * in the description panel.
      */
     field?: QPropertyListField;
     /**
-     * Necessary strings to be used in the component.
+     * Custom icon configurations.
+     */
+    icons?: typeof DEFAULT_ICONS;
+    /**
+     * Custom text configurations.
      */
-    internals?: Internals;
+    texts?: typeof DEFAULT_TEXTS;
 };
 export declare const DEFAULT_TEXTS: {
     emptyMessage: string;
 };
-export type texts = {
-    texts: typeof DEFAULT_TEXTS;
-};
-export declare const DEFAULT_ICONS: Record<string, Icon>;
-type Internals = {
-    icons: typeof DEFAULT_ICONS;
-    texts: typeof DEFAULT_TEXTS;
-};
+type IconKeys = 'open' | 'close';
+export declare const DEFAULT_ICONS: Record<IconKeys, Icon>;
 export {};
 //# sourceMappingURL=types.d.ts.map

package/esm/components/QPropertyList/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/components/QPropertyList/types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAA;AAC9C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,KAAK,CAAA;AAEpC,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,OAAO,CAAA;AAE7C,MAAM,MAAM,kBAAkB,GAAG;IAChC;;OAEG;IACH,MAAM,CAAC,EAAE,kBAAkB,EAAE,CAAA;IAE7B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;OAEG;IACH,aAAa,CAAC,EAAE,YAAY,CAAA;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,uBAAuB,EAAE,CAAA;IAElC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,EAAE,CAAA;IAE1B;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,CAAA;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,GAAG,SAAS,CAAA;IAC7B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IACnC;;OAEG;IACH,KAAK,EAAE,kBAAkB,CAAA;IAEzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,EAAE,CAAA;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,kBAAkB,CAAA;IAE1B;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,aAAa;;CAEzB,CAAA;AAED,MAAM,MAAM,KAAK,GAAG;IACnB,KAAK,EAAE,OAAO,aAAa,CAAA;CAC3B,CAAA;AAGD,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAO9C,CAAA;AAGD,KAAK,SAAS,GAAG;IAChB,KAAK,EAAE,OAAO,aAAa,CAAA;IAC3B,KAAK,EAAE,OAAO,aAAa,CAAA;CAC3B,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/components/QPropertyList/types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAA;AAE9C;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,OAAO,CAAA;AAE9C,MAAM,MAAM,kBAAkB,GAAG;IAChC;;;OAGG;IACH,MAAM,CAAC,EAAE,kBAAkB,EAAE,CAAA;IAE7B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,uBAAuB,EAAE,CAAA;IAElC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,EAAE,CAAA;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,aAAa,CAAA;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,aAAa,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,aAAa,CAAA;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,aAAa,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IACnC;;OAEG;IACH,KAAK,EAAE,kBAAkB,CAAA;IAEzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,EAAE,CAAA;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACrC;;;OAGG;IACH,KAAK,CAAC,EAAE,kBAAkB,CAAA;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,aAAa,CAAA;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,aAAa,CAAA;CAC5B,CAAA;AAED,eAAO,MAAM,aAAa;;CAEzB,CAAA;AAED,KAAK,QAAQ,GAAG,MAAM,GAAG,OAAO,CAAA;AAGhC,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,QAAQ,EAAE,IAAI,CAOhD,CAAA"}