@quaffui/quaff 0.1.0-prealpha9 → 1.0.0-alpha2

package/dist/components/list/docs.props.js

@@ -1,226 +1,434 @@
-export const QSeparatorPropsVertical = [
+// AUTO GENERATED FILE - DO NOT MODIFY OR DELETE
+// @quaffHash 46d43615919b54aefb6da6bb65b543bb
+export const QSeparatorVerticalDocsProps = [
     {
+        isArray: false,
+        optional: true,
+        isSnippet: false,
         name: "spacing",
-        type: '"none" | "sm" | "md" | "lg"',
-        optional: false,
-        clickableType: false,
-        description: "",
-        default: "",
+        type: {
+            name: "Q.Size",
+            isClickable: false,
+        },
+        description: "Spacing around the separator.",
+        default: '"none"',
     },
     {
+        isArray: false,
+        optional: true,
+        isSnippet: false,
         name: "inset",
-        type: "boolean",
-        optional: false,
-        clickableType: false,
-        description: "",
-        default: "",
+        type: {
+            name: "boolean",
+            isClickable: false,
+        },
+        description: "Adds horizontal padding to the separator container, adding space around the separator.",
+        default: "false",
     },
     {
+        isArray: false,
+        optional: true,
+        isSnippet: false,
         name: "vertical",
-        type: "true",
-        optional: false,
-        clickableType: false,
-        description: "",
-        default: "",
+        type: {
+            name: "true",
+            isClickable: false,
+        },
+        description: "Sets the separator orientation to vertical.",
+        default: "undefined",
     },
     {
-        name: "color",
-        type: "string",
+        isArray: false,
         optional: true,
-        clickableType: false,
-        description: "",
-        default: "",
+        isSnippet: false,
+        name: "color",
+        type: {
+            name: "string",
+            isClickable: false,
+        },
+        description: "Color of the separator line.",
+        default: '"outline"',
     },
     {
+        isArray: false,
+        optional: true,
+        isSnippet: false,
         name: "size",
-        type: "string",
-        optional: false,
-        clickableType: false,
-        description: "",
-        default: "",
+        type: {
+            name: "string",
+            isClickable: false,
+        },
+        description: "Custom size (thickness) of the separator line.",
+        default: "undefined",
     },
     {
-        name: "text",
-        type: "string",
+        isArray: false,
         optional: true,
-        clickableType: false,
-        description: "",
-        default: "",
+        isSnippet: false,
+        name: "text",
+        type: {
+            name: "string",
+            isClickable: false,
+        },
+        description: "Text to display. Its position on the separator is determined by the textAlign prop.",
+        default: "undefined",
     },
     {
+        isArray: false,
+        optional: true,
+        isSnippet: false,
         name: "textAlign",
-        type: '"top" | "middle" | "bottom"',
-        optional: false,
-        clickableType: false,
-        description: "",
-        default: "",
+        type: [
+            {
+                name: '"top"',
+                isClickable: false,
+            },
+            {
+                name: '"middle"',
+                isClickable: false,
+            },
+            {
+                name: '"bottom"',
+                isClickable: false,
+            },
+        ],
+        description: "Vertical alignment of the text when text prop is used.",
+        default: '"middle"',
     },
 ];
-export const QSeparatorPropsHorizontal = [
+export const QSeparatorVerticalDocsSnippets = [];
+export const QSeparatorHorizontalDocsProps = [
     {
+        isArray: false,
+        optional: true,
+        isSnippet: false,
         name: "spacing",
-        type: '"none" | "sm" | "md" | "lg"',
-        optional: false,
-        clickableType: false,
-        description: "",
-        default: "",
+        type: {
+            name: "Q.Size",
+            isClickable: false,
+        },
+        description: "Spacing around the separator.",
+        default: '"none"',
     },
     {
+        isArray: false,
+        optional: true,
+        isSnippet: false,
         name: "inset",
-        type: "boolean",
-        optional: false,
-        clickableType: false,
-        description: "",
-        default: "",
+        type: {
+            name: "boolean",
+            isClickable: false,
+        },
+        description: "Adds vertical padding to the separator container, adding space around the separator.",
+        default: "false",
     },
     {
+        isArray: false,
+        optional: true,
+        isSnippet: false,
         name: "vertical",
-        type: "false",
-        optional: false,
-        clickableType: false,
-        description: "",
-        default: "",
+        type: {
+            name: "false",
+            isClickable: false,
+        },
+        description: "Sets the separator orientation to horizontal.",
+        default: "undefined",
     },
     {
-        name: "color",
-        type: "string",
+        isArray: false,
         optional: true,
-        clickableType: false,
-        description: "",
-        default: "",
+        isSnippet: false,
+        name: "color",
+        type: {
+            name: "string",
+            isClickable: false,
+        },
+        description: "Color of the separator line.",
+        default: '"outline"',
     },
     {
+        isArray: false,
+        optional: true,
+        isSnippet: false,
         name: "size",
-        type: "string",
-        optional: false,
-        clickableType: false,
-        description: "",
-        default: "",
+        type: {
+            name: "string",
+            isClickable: false,
+        },
+        description: "Custom size (thickness) of the separator line.",
+        default: "undefined",
     },
     {
-        name: "text",
-        type: "string",
+        isArray: false,
         optional: true,
-        clickableType: false,
-        description: "",
-        default: "",
+        isSnippet: false,
+        name: "text",
+        type: {
+            name: "string",
+            isClickable: false,
+        },
+        description: "Text to display. Its position on the separator is determined by the textAlign prop.",
+        default: "undefined",
     },
     {
+        isArray: false,
+        optional: true,
+        isSnippet: false,
         name: "textAlign",
-        type: '"left" | "center" | "right"',
-        optional: false,
-        clickableType: false,
-        description: "",
-        default: "",
+        type: [
+            {
+                name: '"left"',
+                isClickable: false,
+            },
+            {
+                name: '"center"',
+                isClickable: false,
+            },
+            {
+                name: '"right"',
+                isClickable: false,
+            },
+        ],
+        description: "Horizontal alignment of the text when text prop is used.",
+        default: '"center"',
     },
 ];
+export const QSeparatorHorizontalDocsSnippets = [];
 export const QListDocsProps = [
     {
+        isArray: false,
+        optional: true,
+        isSnippet: false,
         name: "bordered",
-        type: "boolean",
-        optional: false,
-        clickableType: false,
-        description: "",
-        default: "",
+        type: {
+            name: "boolean",
+            isClickable: false,
+        },
+        description: "Adds a border around the list.",
+        default: "false",
     },
     {
+        isArray: false,
+        optional: true,
+        isSnippet: false,
         name: "roundedBorders",
-        type: "boolean",
-        optional: false,
-        clickableType: false,
-        description: "",
-        default: "",
+        type: {
+            name: "boolean",
+            isClickable: false,
+        },
+        description: "Makes the borders of the list rounded when bordered is true.",
+        default: "false",
     },
     {
+        isArray: false,
+        optional: true,
+        isSnippet: false,
         name: "dense",
-        type: "boolean",
-        optional: false,
-        clickableType: false,
-        description: "",
-        default: "",
+        type: {
+            name: "boolean",
+            isClickable: false,
+        },
+        description: "Makes all the items in the list more compact.",
+        default: "false",
     },
     {
+        isArray: false,
+        optional: true,
+        isSnippet: false,
         name: "separator",
-        type: "boolean",
-        optional: false,
-        clickableType: false,
-        description: "",
-        default: "",
+        type: {
+            name: "boolean",
+            isClickable: false,
+        },
+        description: "Adds separators between list items.",
+        default: "false",
     },
     {
+        isArray: false,
+        optional: true,
+        isSnippet: false,
         name: "separatorOptions",
-        type: 'QSeparatorProps["textAlign"]\n  };',
-        optional: false,
-        clickableType: true,
-        description: "",
-        default: "",
+        type: {
+            name: 'Omit<QSeparatorHorizontalProps, "vertical">',
+            isClickable: false,
+        },
+        description: "Options for the separators. These will be applied to all separators in the list.",
+        default: "undefined",
     },
     {
+        isArray: false,
+        optional: true,
+        isSnippet: false,
         name: "padding",
-        type: "boolean",
-        optional: false,
-        clickableType: false,
-        description: "",
-        default: "",
+        type: {
+            name: "boolean",
+            isClickable: false,
+        },
+        description: "Adds padding to the list container.",
+        default: "true",
     },
     {
+        isArray: false,
+        optional: true,
+        isSnippet: false,
         name: "tag",
-        type: "string",
+        type: {
+            name: "string",
+            isClickable: false,
+        },
+        description: "HTML tag to be used for the list container.",
+        default: '"div"',
+    },
+    {
+        isArray: false,
         optional: true,
-        clickableType: false,
-        description: "",
-        default: "",
+        isSnippet: false,
+        name: "activeClass",
+        type: {
+            name: "string",
+            isClickable: false,
+        },
+        description: "The class to apply to items that are active. For more granular control, you can also use the `activeClass` prop on each QItem.",
+        default: "undefined",
     },
 ];
+export const QListDocsSnippets = [];
 export const QItemDocsProps = [
     {
+        isArray: false,
+        optional: true,
+        isSnippet: false,
         name: "tag",
-        type: "string",
-        optional: false,
-        clickableType: false,
-        description: "",
-        default: "",
+        type: {
+            name: "string",
+            isClickable: false,
+        },
+        description: "HTML tag to be used for the list item.",
+        default: '"div"',
     },
     {
+        isArray: false,
+        optional: true,
+        isSnippet: false,
         name: "active",
-        type: "boolean",
-        optional: false,
-        clickableType: false,
-        description: "",
-        default: "",
+        type: {
+            name: "boolean",
+            isClickable: false,
+        },
+        description: "Indicates if the item is currently active.",
+        default: "false",
     },
     {
+        isArray: false,
+        optional: true,
+        isSnippet: false,
         name: "clickable",
-        type: "boolean",
-        optional: false,
-        clickableType: false,
-        description: "",
-        default: "",
+        type: {
+            name: "boolean",
+            isClickable: false,
+        },
+        description: "Makes the item clickable and adds hover effects.",
+        default: "false",
     },
     {
+        isArray: false,
+        optional: true,
+        isSnippet: false,
         name: "dense",
-        type: "boolean",
-        optional: false,
-        clickableType: false,
-        description: "",
-        default: "",
+        type: {
+            name: "boolean",
+            isClickable: false,
+        },
+        description: "Makes the item more compact.",
+        default: "false",
     },
     {
+        isArray: false,
+        optional: true,
+        isSnippet: false,
+        name: "noRipple",
+        type: {
+            name: "boolean",
+            isClickable: false,
+        },
+        description: "Disables the ripple effect when clicking the item.",
+        default: "false",
+    },
+    {
+        isArray: false,
+        optional: true,
+        isSnippet: false,
         name: "tabindex",
-        type: "string | number",
-        optional: false,
-        clickableType: false,
-        description: "",
-        default: "",
+        type: {
+            name: 'HTMLAttributes<HTMLElement>["tabindex"]',
+            isClickable: false,
+        },
+        description: "Tab index for keyboard navigation.",
+        default: "0",
+    },
+    {
+        isArray: false,
+        optional: true,
+        isSnippet: false,
+        name: "target",
+        type: {
+            name: 'HTMLAnchorAttributes["target"]',
+            isClickable: false,
+        },
+        description: "Target attribute for anchor tags when using router links.",
+        default: "undefined",
     },
 ];
+export const QItemDocsSnippets = [];
 export const QItemSectionDocsProps = [
     {
+        isArray: false,
+        optional: true,
+        isSnippet: false,
         name: "type",
-        type: "QItemSectionTypes",
-        optional: false,
-        clickableType: true,
-        description: "",
-        default: "",
+        type: {
+            name: "QItemSectionTypes",
+            isClickable: true,
+        },
+        description: "Type of the section, determines its layout and styling.",
+        default: '"content"',
+    },
+];
+export const QItemSectionDocsSnippets = [
+    {
+        isArray: false,
+        optional: true,
+        isSnippet: true,
+        name: "headline",
+        type: [],
+        description: "Main content or title of the section. By default, inherits the content of the children snippet.",
+        default: "children",
+    },
+    {
+        isArray: false,
+        optional: true,
+        isSnippet: true,
+        name: "line1",
+        type: [],
+        description: "First line of supporting text.",
+        default: "undefined",
+    },
+    {
+        isArray: false,
+        optional: true,
+        isSnippet: true,
+        name: "line2",
+        type: [],
+        description: "Second line of supporting text.",
+        default: "undefined",
+    },
+    {
+        isArray: false,
+        optional: true,
+        isSnippet: true,
+        name: "line3",
+        type: [],
+        description: "Third line of supporting text.",
+        default: "undefined",
     },
 ];