@mittwald/flow-react-components 0.2.0-alpha.66 → 0.2.0-alpha.68

package/dist/assets/doc-properties.json

@@ -166448,168 +166448,6 @@
       }
     }
   },
-  {
-    "tags": {
-      "flr-generate": "all",
-      "flr-clear-props-context": ""
-    },
-    "filePath": "/home/runner/work/flow/flow/packages/components/src/components/Avatar/Avatar.tsx",
-    "description": "",
-    "displayName": "Avatar",
-    "methods": [],
-    "props": {
-      "size": {
-        "defaultValue": {
-          "value": "\"m\""
-        },
-        "description": "The size of the avatar.",
-        "name": "size",
-        "parent": {
-          "fileName": "components/src/components/Avatar/Avatar.tsx",
-          "name": "AvatarProps"
-        },
-        "declarations": [
-          {
-            "fileName": "components/src/components/Avatar/Avatar.tsx",
-            "name": "AvatarProps"
-          }
-        ],
-        "required": false,
-        "type": {
-          "name": "\"s\" | \"m\" | \"l\" | \"xs\""
-        }
-      },
-      "color": {
-        "defaultValue": null,
-        "description": "The color of icons and initials inside the avatar.",
-        "name": "color",
-        "parent": {
-          "fileName": "components/src/components/Avatar/Avatar.tsx",
-          "name": "AvatarProps"
-        },
-        "declarations": [
-          {
-            "fileName": "components/src/components/Avatar/Avatar.tsx",
-            "name": "AvatarProps"
-          }
-        ],
-        "required": false,
-        "type": {
-          "name": "\"blue\" | \"violet\" | \"teal\" | \"lilac\" | \"green\""
-        }
-      },
-      "children": {
-        "defaultValue": null,
-        "description": "",
-        "name": "children",
-        "declarations": [
-          {
-            "fileName": "flow/node_modules/.pnpm/@types+react@19.0.10/node_modules/@types/react/index.d.ts",
-            "name": "TypeLiteral"
-          }
-        ],
-        "required": false,
-        "type": {
-          "name": "ReactNode"
-        }
-      },
-      "className": {
-        "defaultValue": null,
-        "description": "The elements class name.",
-        "name": "className",
-        "parent": {
-          "fileName": "src/lib/types/props.ts",
-          "name": "PropsWithClassName"
-        },
-        "declarations": [
-          {
-            "fileName": "src/lib/types/props.ts",
-            "name": "PropsWithClassName"
-          }
-        ],
-        "required": false,
-        "type": {
-          "name": "string"
-        }
-      },
-      "wrapWith": {
-        "defaultValue": null,
-        "description": "",
-        "name": "wrapWith",
-        "parent": {
-          "fileName": "src/lib/componentFactory/flowComponent.tsx",
-          "name": "FlowComponentProps"
-        },
-        "declarations": [
-          {
-            "fileName": "src/lib/componentFactory/flowComponent.tsx",
-            "name": "FlowComponentProps"
-          }
-        ],
-        "required": false,
-        "type": {
-          "name": "ReactElement<unknown, string | JSXElementConstructor<any>>"
-        }
-      },
-      "tunnelId": {
-        "defaultValue": null,
-        "description": "@internal",
-        "name": "tunnelId",
-        "parent": {
-          "fileName": "src/lib/types/props.ts",
-          "name": "PropsWithTunnel"
-        },
-        "declarations": [
-          {
-            "fileName": "src/lib/types/props.ts",
-            "name": "PropsWithTunnel"
-          }
-        ],
-        "required": false,
-        "type": {
-          "name": "string | null"
-        }
-      },
-      "ref": {
-        "defaultValue": null,
-        "description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}",
-        "name": "ref",
-        "parent": {
-          "fileName": "flow/node_modules/.pnpm/@types+react@19.0.10/node_modules/@types/react/index.d.ts",
-          "name": "RefAttributes"
-        },
-        "declarations": [
-          {
-            "fileName": "flow/node_modules/.pnpm/@types+react@19.0.10/node_modules/@types/react/index.d.ts",
-            "name": "RefAttributes"
-          }
-        ],
-        "required": false,
-        "type": {
-          "name": "Ref<HTMLDivElement>"
-        }
-      },
-      "key": {
-        "defaultValue": null,
-        "description": "",
-        "name": "key",
-        "parent": {
-          "fileName": "flow/node_modules/.pnpm/@types+react@19.0.10/node_modules/@types/react/index.d.ts",
-          "name": "Attributes"
-        },
-        "declarations": [
-          {
-            "fileName": "flow/node_modules/.pnpm/@types+react@19.0.10/node_modules/@types/react/index.d.ts",
-            "name": "Attributes"
-          }
-        ],
-        "required": false,
-        "type": {
-          "name": "Key | null"
-        }
-      }
-    }
-  },
   {
     "tags": {
       "flr-generate": "all",
@@ -175985,11 +175823,51 @@
       "flr-generate": "all",
       "flr-clear-props-context": ""
     },
-    "filePath": "/home/runner/work/flow/flow/packages/components/src/components/AlertBadge/AlertBadge.tsx",
+    "filePath": "/home/runner/work/flow/flow/packages/components/src/components/Avatar/Avatar.tsx",
     "description": "",
-    "displayName": "AlertBadge",
+    "displayName": "Avatar",
     "methods": [],
     "props": {
+      "size": {
+        "defaultValue": {
+          "value": "\"m\""
+        },
+        "description": "The size of the avatar.",
+        "name": "size",
+        "parent": {
+          "fileName": "components/src/components/Avatar/Avatar.tsx",
+          "name": "AvatarProps"
+        },
+        "declarations": [
+          {
+            "fileName": "components/src/components/Avatar/Avatar.tsx",
+            "name": "AvatarProps"
+          }
+        ],
+        "required": false,
+        "type": {
+          "name": "\"s\" | \"m\" | \"l\" | \"xs\""
+        }
+      },
+      "color": {
+        "defaultValue": null,
+        "description": "The color of icons and initials inside the avatar.",
+        "name": "color",
+        "parent": {
+          "fileName": "components/src/components/Avatar/Avatar.tsx",
+          "name": "AvatarProps"
+        },
+        "declarations": [
+          {
+            "fileName": "components/src/components/Avatar/Avatar.tsx",
+            "name": "AvatarProps"
+          }
+        ],
+        "required": false,
+        "type": {
+          "name": "\"blue\" | \"violet\" | \"teal\" | \"lilac\" | \"green\""
+        }
+      },
       "children": {
         "defaultValue": null,
         "description": "",
@@ -176005,19 +175883,23 @@
           "name": "ReactNode"
         }
       },
-      "status": {
+      "className": {
         "defaultValue": null,
-        "description": "The elements status",
-        "name": "status",
+        "description": "The elements class name.",
+        "name": "className",
+        "parent": {
+          "fileName": "src/lib/types/props.ts",
+          "name": "PropsWithClassName"
+        },
         "declarations": [
           {
             "fileName": "src/lib/types/props.ts",
-            "name": "TypeLiteral"
+            "name": "PropsWithClassName"
           }
         ],
         "required": false,
         "type": {
-          "name": "Status"
+          "name": "string"
         }
       },
       "wrapWith": {
@@ -176058,25 +175940,6 @@
           "name": "string | null"
         }
       },
-      "className": {
-        "defaultValue": null,
-        "description": "The elements class name.",
-        "name": "className",
-        "parent": {
-          "fileName": "src/lib/types/props.ts",
-          "name": "PropsWithClassName"
-        },
-        "declarations": [
-          {
-            "fileName": "src/lib/types/props.ts",
-            "name": "PropsWithClassName"
-          }
-        ],
-        "required": false,
-        "type": {
-          "name": "string"
-        }
-      },
       "ref": {
         "defaultValue": null,
         "description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}",
@@ -176122,28 +175985,165 @@
       "flr-generate": "all",
       "flr-clear-props-context": ""
     },
-    "filePath": "/home/runner/work/flow/flow/packages/components/src/components/Alert/Alert.tsx",
+    "filePath": "/home/runner/work/flow/flow/packages/components/src/components/AlertBadge/AlertBadge.tsx",
     "description": "",
-    "displayName": "Alert",
+    "displayName": "AlertBadge",
     "methods": [],
     "props": {
-      "ref": {
+      "children": {
         "defaultValue": null,
-        "description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}",
-        "name": "ref",
-        "parent": {
-          "fileName": "flow/node_modules/.pnpm/@types+react@19.0.10/node_modules/@types/react/index.d.ts",
-          "name": "RefAttributes"
-        },
+        "description": "",
+        "name": "children",
         "declarations": [
           {
             "fileName": "flow/node_modules/.pnpm/@types+react@19.0.10/node_modules/@types/react/index.d.ts",
-            "name": "RefAttributes"
+            "name": "TypeLiteral"
           }
         ],
         "required": false,
         "type": {
-          "name": "Ref<HTMLElement>"
+          "name": "ReactNode"
+        }
+      },
+      "status": {
+        "defaultValue": null,
+        "description": "The elements status",
+        "name": "status",
+        "declarations": [
+          {
+            "fileName": "src/lib/types/props.ts",
+            "name": "TypeLiteral"
+          }
+        ],
+        "required": false,
+        "type": {
+          "name": "Status"
+        }
+      },
+      "wrapWith": {
+        "defaultValue": null,
+        "description": "",
+        "name": "wrapWith",
+        "parent": {
+          "fileName": "src/lib/componentFactory/flowComponent.tsx",
+          "name": "FlowComponentProps"
+        },
+        "declarations": [
+          {
+            "fileName": "src/lib/componentFactory/flowComponent.tsx",
+            "name": "FlowComponentProps"
+          }
+        ],
+        "required": false,
+        "type": {
+          "name": "ReactElement<unknown, string | JSXElementConstructor<any>>"
+        }
+      },
+      "tunnelId": {
+        "defaultValue": null,
+        "description": "@internal",
+        "name": "tunnelId",
+        "parent": {
+          "fileName": "src/lib/types/props.ts",
+          "name": "PropsWithTunnel"
+        },
+        "declarations": [
+          {
+            "fileName": "src/lib/types/props.ts",
+            "name": "PropsWithTunnel"
+          }
+        ],
+        "required": false,
+        "type": {
+          "name": "string | null"
+        }
+      },
+      "className": {
+        "defaultValue": null,
+        "description": "The elements class name.",
+        "name": "className",
+        "parent": {
+          "fileName": "src/lib/types/props.ts",
+          "name": "PropsWithClassName"
+        },
+        "declarations": [
+          {
+            "fileName": "src/lib/types/props.ts",
+            "name": "PropsWithClassName"
+          }
+        ],
+        "required": false,
+        "type": {
+          "name": "string"
+        }
+      },
+      "ref": {
+        "defaultValue": null,
+        "description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}",
+        "name": "ref",
+        "parent": {
+          "fileName": "flow/node_modules/.pnpm/@types+react@19.0.10/node_modules/@types/react/index.d.ts",
+          "name": "RefAttributes"
+        },
+        "declarations": [
+          {
+            "fileName": "flow/node_modules/.pnpm/@types+react@19.0.10/node_modules/@types/react/index.d.ts",
+            "name": "RefAttributes"
+          }
+        ],
+        "required": false,
+        "type": {
+          "name": "Ref<HTMLDivElement>"
+        }
+      },
+      "key": {
+        "defaultValue": null,
+        "description": "",
+        "name": "key",
+        "parent": {
+          "fileName": "flow/node_modules/.pnpm/@types+react@19.0.10/node_modules/@types/react/index.d.ts",
+          "name": "Attributes"
+        },
+        "declarations": [
+          {
+            "fileName": "flow/node_modules/.pnpm/@types+react@19.0.10/node_modules/@types/react/index.d.ts",
+            "name": "Attributes"
+          }
+        ],
+        "required": false,
+        "type": {
+          "name": "Key | null"
+        }
+      }
+    }
+  },
+  {
+    "tags": {
+      "flr-generate": "all",
+      "flr-clear-props-context": ""
+    },
+    "filePath": "/home/runner/work/flow/flow/packages/components/src/components/Alert/Alert.tsx",
+    "description": "",
+    "displayName": "Alert",
+    "methods": [],
+    "props": {
+      "ref": {
+        "defaultValue": null,
+        "description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}",
+        "name": "ref",
+        "parent": {
+          "fileName": "flow/node_modules/.pnpm/@types+react@19.0.10/node_modules/@types/react/index.d.ts",
+          "name": "RefAttributes"
+        },
+        "declarations": [
+          {
+            "fileName": "flow/node_modules/.pnpm/@types+react@19.0.10/node_modules/@types/react/index.d.ts",
+            "name": "RefAttributes"
+          }
+        ],
+        "required": false,
+        "type": {
+          "name": "Ref<HTMLElement>"
         }
       },
       "key": {
@@ -195099,6 +195099,144 @@
       }
     }
   },
+  {
+    "tags": {},
+    "filePath": "/home/runner/work/flow/flow/packages/components/src/components/Popover/components/PopoverTrigger/PopoverTrigger.tsx",
+    "description": "",
+    "displayName": "PopoverTrigger",
+    "methods": [],
+    "props": {
+      "isDefaultOpen": {
+        "defaultValue": null,
+        "description": "Whether the overlay should be open initially.",
+        "name": "isDefaultOpen",
+        "parent": {
+          "fileName": "components/src/components/OverlayTrigger/OverlayTrigger.tsx",
+          "name": "OverlayTriggerProps"
+        },
+        "declarations": [
+          {
+            "fileName": "components/src/components/OverlayTrigger/OverlayTrigger.tsx",
+            "name": "OverlayTriggerProps"
+          }
+        ],
+        "required": false,
+        "type": {
+          "name": "boolean"
+        }
+      },
+      "controller": {
+        "defaultValue": null,
+        "description": "A controller to control the state of the overlay.",
+        "name": "controller",
+        "parent": {
+          "fileName": "components/src/components/OverlayTrigger/OverlayTrigger.tsx",
+          "name": "OverlayTriggerProps"
+        },
+        "declarations": [
+          {
+            "fileName": "components/src/components/OverlayTrigger/OverlayTrigger.tsx",
+            "name": "OverlayTriggerProps"
+          }
+        ],
+        "required": false,
+        "type": {
+          "name": "OverlayController"
+        }
+      },
+      "wrapWith": {
+        "defaultValue": null,
+        "description": "",
+        "name": "wrapWith",
+        "parent": {
+          "fileName": "src/lib/componentFactory/flowComponent.tsx",
+          "name": "FlowComponentProps"
+        },
+        "declarations": [
+          {
+            "fileName": "src/lib/componentFactory/flowComponent.tsx",
+            "name": "FlowComponentProps"
+          }
+        ],
+        "required": false,
+        "type": {
+          "name": "ReactElement<unknown, string | JSXElementConstructor<any>>"
+        }
+      },
+      "tunnelId": {
+        "defaultValue": null,
+        "description": "@internal",
+        "name": "tunnelId",
+        "parent": {
+          "fileName": "src/lib/types/props.ts",
+          "name": "PropsWithTunnel"
+        },
+        "declarations": [
+          {
+            "fileName": "src/lib/types/props.ts",
+            "name": "PropsWithTunnel"
+          }
+        ],
+        "required": false,
+        "type": {
+          "name": "string | null"
+        }
+      },
+      "children": {
+        "defaultValue": null,
+        "description": "",
+        "name": "children",
+        "declarations": [
+          {
+            "fileName": "flow/node_modules/.pnpm/@types+react@19.0.10/node_modules/@types/react/index.d.ts",
+            "name": "TypeLiteral"
+          }
+        ],
+        "required": false,
+        "type": {
+          "name": "ReactNode"
+        }
+      },
+      "ref": {
+        "defaultValue": null,
+        "description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}",
+        "name": "ref",
+        "parent": {
+          "fileName": "flow/node_modules/.pnpm/@types+react@19.0.10/node_modules/@types/react/index.d.ts",
+          "name": "RefAttributes"
+        },
+        "declarations": [
+          {
+            "fileName": "flow/node_modules/.pnpm/@types+react@19.0.10/node_modules/@types/react/index.d.ts",
+            "name": "RefAttributes"
+          }
+        ],
+        "required": false,
+        "type": {
+          "name": "Ref<HTMLDivElement>"
+        }
+      },
+      "key": {
+        "defaultValue": null,
+        "description": "",
+        "name": "key",
+        "parent": {
+          "fileName": "flow/node_modules/.pnpm/@types+react@19.0.10/node_modules/@types/react/index.d.ts",
+          "name": "Attributes"
+        },
+        "declarations": [
+          {
+            "fileName": "flow/node_modules/.pnpm/@types+react@19.0.10/node_modules/@types/react/index.d.ts",
+            "name": "Attributes"
+          }
+        ],
+        "required": false,
+        "type": {
+          "name": "Key | null"
+        }
+      }
+    }
+  },
   {
     "tags": {
       "flr-generate": "all",
@@ -195582,144 +195720,6 @@
       }
     }
   },
-  {
-    "tags": {},
-    "filePath": "/home/runner/work/flow/flow/packages/components/src/components/Popover/components/PopoverTrigger/PopoverTrigger.tsx",
-    "description": "",
-    "displayName": "PopoverTrigger",
-    "methods": [],
-    "props": {
-      "isDefaultOpen": {
-        "defaultValue": null,
-        "description": "Whether the overlay should be open initially.",
-        "name": "isDefaultOpen",
-        "parent": {
-          "fileName": "components/src/components/OverlayTrigger/OverlayTrigger.tsx",
-          "name": "OverlayTriggerProps"
-        },
-        "declarations": [
-          {
-            "fileName": "components/src/components/OverlayTrigger/OverlayTrigger.tsx",
-            "name": "OverlayTriggerProps"
-          }
-        ],
-        "required": false,
-        "type": {
-          "name": "boolean"
-        }
-      },
-      "controller": {
-        "defaultValue": null,
-        "description": "A controller to control the state of the overlay.",
-        "name": "controller",
-        "parent": {
-          "fileName": "components/src/components/OverlayTrigger/OverlayTrigger.tsx",
-          "name": "OverlayTriggerProps"
-        },
-        "declarations": [
-          {
-            "fileName": "components/src/components/OverlayTrigger/OverlayTrigger.tsx",
-            "name": "OverlayTriggerProps"
-          }
-        ],
-        "required": false,
-        "type": {
-          "name": "OverlayController"
-        }
-      },
-      "wrapWith": {
-        "defaultValue": null,
-        "description": "",
-        "name": "wrapWith",
-        "parent": {
-          "fileName": "src/lib/componentFactory/flowComponent.tsx",
-          "name": "FlowComponentProps"
-        },
-        "declarations": [
-          {
-            "fileName": "src/lib/componentFactory/flowComponent.tsx",
-            "name": "FlowComponentProps"
-          }
-        ],
-        "required": false,
-        "type": {
-          "name": "ReactElement<unknown, string | JSXElementConstructor<any>>"
-        }
-      },
-      "tunnelId": {
-        "defaultValue": null,
-        "description": "@internal",
-        "name": "tunnelId",
-        "parent": {
-          "fileName": "src/lib/types/props.ts",
-          "name": "PropsWithTunnel"
-        },
-        "declarations": [
-          {
-            "fileName": "src/lib/types/props.ts",
-            "name": "PropsWithTunnel"
-          }
-        ],
-        "required": false,
-        "type": {
-          "name": "string | null"
-        }
-      },
-      "children": {
-        "defaultValue": null,
-        "description": "",
-        "name": "children",
-        "declarations": [
-          {
-            "fileName": "flow/node_modules/.pnpm/@types+react@19.0.10/node_modules/@types/react/index.d.ts",
-            "name": "TypeLiteral"
-          }
-        ],
-        "required": false,
-        "type": {
-          "name": "ReactNode"
-        }
-      },
-      "ref": {
-        "defaultValue": null,
-        "description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}",
-        "name": "ref",
-        "parent": {
-          "fileName": "flow/node_modules/.pnpm/@types+react@19.0.10/node_modules/@types/react/index.d.ts",
-          "name": "RefAttributes"
-        },
-        "declarations": [
-          {
-            "fileName": "flow/node_modules/.pnpm/@types+react@19.0.10/node_modules/@types/react/index.d.ts",
-            "name": "RefAttributes"
-          }
-        ],
-        "required": false,
-        "type": {
-          "name": "Ref<HTMLDivElement>"
-        }
-      },
-      "key": {
-        "defaultValue": null,
-        "description": "",
-        "name": "key",
-        "parent": {
-          "fileName": "flow/node_modules/.pnpm/@types+react@19.0.10/node_modules/@types/react/index.d.ts",
-          "name": "Attributes"
-        },
-        "declarations": [
-          {
-            "fileName": "flow/node_modules/.pnpm/@types+react@19.0.10/node_modules/@types/react/index.d.ts",
-            "name": "Attributes"
-          }
-        ],
-        "required": false,
-        "type": {
-          "name": "Key | null"
-        }
-      }
-    }
-  },
   {
     "tags": {
       "flr-generate": "all"