@helpscout/ui-kit-react 0.1.4 → 0.1.6

package/dist/prop-types.json

@@ -915,6 +915,46 @@
     }
   },
   "Input": {
+    "align": {
+      "defaultValue": {
+        "value": "left"
+      },
+      "description": "Change the alignment of the input text.",
+      "name": "align",
+      "parent": {
+        "fileName": "ui-kit-react/lib/components/input/input.tsx",
+        "name": "InputProps"
+      },
+      "declarations": [
+        {
+          "fileName": "ui-kit-react/lib/components/input/input.tsx",
+          "name": "InputProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "\"left\" | \"right\" | null"
+      }
+    },
+    "prefix": {
+      "defaultValue": null,
+      "description": "Render the input with a prefix.",
+      "name": "prefix",
+      "parent": {
+        "fileName": "ui-kit-react/lib/components/input/input.tsx",
+        "name": "InputProps"
+      },
+      "declarations": [
+        {
+          "fileName": "ui-kit-react/lib/components/input/input.tsx",
+          "name": "InputProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
     "state": {
       "defaultValue": null,
       "description": "Changes the appearance of the input to indicate an error, success, or warning state.",
@@ -1646,6 +1686,453 @@
       }
     }
   },
+  "Menu": {
+    "className": {
+      "defaultValue": null,
+      "description": "Optional class name to apply to the menu.",
+      "name": "className",
+      "parent": {
+        "fileName": "ui-kit-react/lib/components/menu/menu.tsx",
+        "name": "MenuProps"
+      },
+      "declarations": [
+        {
+          "fileName": "ui-kit-react/lib/components/menu/menu.tsx",
+          "name": "MenuProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
+    "children": {
+      "defaultValue": null,
+      "description": "The children to render in the menu.",
+      "name": "children",
+      "parent": {
+        "fileName": "ui-kit-react/lib/components/menu/menu.tsx",
+        "name": "MenuProps"
+      },
+      "declarations": [
+        {
+          "fileName": "ui-kit-react/lib/components/menu/menu.tsx",
+          "name": "MenuProps"
+        }
+      ],
+      "required": true,
+      "type": {
+        "name": "ReactNode"
+      }
+    },
+    "disabledKeys": {
+      "defaultValue": null,
+      "description": "Optional array of keys to disable.",
+      "name": "disabledKeys",
+      "parent": {
+        "fileName": "ui-kit-react/lib/components/menu/menu.tsx",
+        "name": "MenuProps"
+      },
+      "declarations": [
+        {
+          "fileName": "ui-kit-react/lib/components/menu/menu.tsx",
+          "name": "MenuProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "(string | number)[]"
+      }
+    },
+    "onAction": {
+      "defaultValue": null,
+      "description": "Handler that is called when an item is selected.",
+      "name": "onAction",
+      "parent": {
+        "fileName": "ui-kit-react/lib/components/menu/menu.tsx",
+        "name": "MenuProps"
+      },
+      "declarations": [
+        {
+          "fileName": "ui-kit-react/lib/components/menu/menu.tsx",
+          "name": "MenuProps"
+        }
+      ],
+      "required": true,
+      "type": {
+        "name": "(key: string | number) => void"
+      }
+    }
+  },
+  "MenuItem": {
+    "isDisabled": {
+      "defaultValue": null,
+      "description": "Whether the menu item is disabled.",
+      "name": "isDisabled",
+      "parent": {
+        "fileName": "ui-kit-react/lib/components/menu/menu.tsx",
+        "name": "MenuItemProps"
+      },
+      "declarations": [
+        {
+          "fileName": "ui-kit-react/lib/components/menu/menu.tsx",
+          "name": "MenuItemProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "boolean"
+      }
+    },
+    "title": {
+      "defaultValue": {
+        "value": ""
+      },
+      "description": "Optional title to apply to the menu item.",
+      "name": "title",
+      "parent": {
+        "fileName": "ui-kit-react/lib/components/menu/menu.tsx",
+        "name": "MenuItemProps"
+      },
+      "declarations": [
+        {
+          "fileName": "ui-kit-react/lib/components/menu/menu.tsx",
+          "name": "MenuItemProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
+    "children": {
+      "defaultValue": null,
+      "description": "The children to render in the menu item.",
+      "name": "children",
+      "parent": {
+        "fileName": "ui-kit-react/lib/components/menu/menu.tsx",
+        "name": "MenuItemProps"
+      },
+      "declarations": [
+        {
+          "fileName": "ui-kit-react/lib/components/menu/menu.tsx",
+          "name": "MenuItemProps"
+        }
+      ],
+      "required": true,
+      "type": {
+        "name": "ReactNode"
+      }
+    },
+    "id": {
+      "defaultValue": null,
+      "description": "The unique id of the item.",
+      "name": "id",
+      "parent": {
+        "fileName": "apps-platform/node_modules/.pnpm/react-aria-components@1.1.1_react-dom@18.2.0_react@18.2.0/node_modules/react-aria-components/dist/types.d.ts",
+        "name": "MenuItemProps"
+      },
+      "declarations": [
+        {
+          "fileName": "apps-platform/node_modules/.pnpm/react-aria-components@1.1.1_react-dom@18.2.0_react@18.2.0/node_modules/react-aria-components/dist/types.d.ts",
+          "name": "MenuItemProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "Key"
+      }
+    },
+    "value": {
+      "defaultValue": null,
+      "description": "The object value that this item represents. When using dynamic collections, this is set automatically.",
+      "name": "value",
+      "parent": {
+        "fileName": "apps-platform/node_modules/.pnpm/react-aria-components@1.1.1_react-dom@18.2.0_react@18.2.0/node_modules/react-aria-components/dist/types.d.ts",
+        "name": "MenuItemProps"
+      },
+      "declarations": [
+        {
+          "fileName": "apps-platform/node_modules/.pnpm/react-aria-components@1.1.1_react-dom@18.2.0_react@18.2.0/node_modules/react-aria-components/dist/types.d.ts",
+          "name": "MenuItemProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "object"
+      }
+    },
+    "textValue": {
+      "defaultValue": null,
+      "description": "A string representation of the item's contents, used for features like typeahead.",
+      "name": "textValue",
+      "parent": {
+        "fileName": "apps-platform/node_modules/.pnpm/react-aria-components@1.1.1_react-dom@18.2.0_react@18.2.0/node_modules/react-aria-components/dist/types.d.ts",
+        "name": "MenuItemProps"
+      },
+      "declarations": [
+        {
+          "fileName": "apps-platform/node_modules/.pnpm/react-aria-components@1.1.1_react-dom@18.2.0_react@18.2.0/node_modules/react-aria-components/dist/types.d.ts",
+          "name": "MenuItemProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
+    "aria-label": {
+      "defaultValue": null,
+      "description": "An accessibility label for this item.",
+      "name": "aria-label",
+      "parent": {
+        "fileName": "apps-platform/node_modules/.pnpm/react-aria-components@1.1.1_react-dom@18.2.0_react@18.2.0/node_modules/react-aria-components/dist/types.d.ts",
+        "name": "MenuItemProps"
+      },
+      "declarations": [
+        {
+          "fileName": "apps-platform/node_modules/.pnpm/react-aria-components@1.1.1_react-dom@18.2.0_react@18.2.0/node_modules/react-aria-components/dist/types.d.ts",
+          "name": "MenuItemProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
+    "className": {
+      "defaultValue": null,
+      "description": "The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the element. A function may be provided to compute the class based on component state.",
+      "name": "className",
+      "parent": {
+        "fileName": "apps-platform/node_modules/.pnpm/react-aria-components@1.1.1_react-dom@18.2.0_react@18.2.0/node_modules/react-aria-components/dist/types.d.ts",
+        "name": "StyleRenderProps"
+      },
+      "declarations": [
+        {
+          "fileName": "apps-platform/node_modules/.pnpm/react-aria-components@1.1.1_react-dom@18.2.0_react@18.2.0/node_modules/react-aria-components/dist/types.d.ts",
+          "name": "StyleRenderProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "(values: MenuItemRenderProps) => string"
+      }
+    },
+    "style": {
+      "defaultValue": null,
+      "description": "The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state.",
+      "name": "style",
+      "parent": {
+        "fileName": "apps-platform/node_modules/.pnpm/react-aria-components@1.1.1_react-dom@18.2.0_react@18.2.0/node_modules/react-aria-components/dist/types.d.ts",
+        "name": "StyleRenderProps"
+      },
+      "declarations": [
+        {
+          "fileName": "apps-platform/node_modules/.pnpm/react-aria-components@1.1.1_react-dom@18.2.0_react@18.2.0/node_modules/react-aria-components/dist/types.d.ts",
+          "name": "StyleRenderProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "(values: MenuItemRenderProps) => CSSProperties"
+      }
+    },
+    "href": {
+      "defaultValue": null,
+      "description": "A URL to link to. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#href).",
+      "name": "href",
+      "parent": {
+        "fileName": "apps-platform/node_modules/.pnpm/@react-types+shared@3.22.1_react@18.2.0/node_modules/@react-types/shared/src/dom.d.ts",
+        "name": "LinkDOMProps"
+      },
+      "declarations": [
+        {
+          "fileName": "apps-platform/node_modules/.pnpm/@react-types+shared@3.22.1_react@18.2.0/node_modules/@react-types/shared/src/dom.d.ts",
+          "name": "LinkDOMProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
+    "target": {
+      "defaultValue": null,
+      "description": "The target window for the link. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target).",
+      "name": "target",
+      "parent": {
+        "fileName": "apps-platform/node_modules/.pnpm/@react-types+shared@3.22.1_react@18.2.0/node_modules/@react-types/shared/src/dom.d.ts",
+        "name": "LinkDOMProps"
+      },
+      "declarations": [
+        {
+          "fileName": "apps-platform/node_modules/.pnpm/@react-types+shared@3.22.1_react@18.2.0/node_modules/@react-types/shared/src/dom.d.ts",
+          "name": "LinkDOMProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "HTMLAttributeAnchorTarget"
+      }
+    },
+    "rel": {
+      "defaultValue": null,
+      "description": "The relationship between the linked resource and the current page. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel).",
+      "name": "rel",
+      "parent": {
+        "fileName": "apps-platform/node_modules/.pnpm/@react-types+shared@3.22.1_react@18.2.0/node_modules/@react-types/shared/src/dom.d.ts",
+        "name": "LinkDOMProps"
+      },
+      "declarations": [
+        {
+          "fileName": "apps-platform/node_modules/.pnpm/@react-types+shared@3.22.1_react@18.2.0/node_modules/@react-types/shared/src/dom.d.ts",
+          "name": "LinkDOMProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
+    "download": {
+      "defaultValue": null,
+      "description": "Causes the browser to download the linked URL. A string may be provided to suggest a file name. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).",
+      "name": "download",
+      "parent": {
+        "fileName": "apps-platform/node_modules/.pnpm/@react-types+shared@3.22.1_react@18.2.0/node_modules/@react-types/shared/src/dom.d.ts",
+        "name": "LinkDOMProps"
+      },
+      "declarations": [
+        {
+          "fileName": "apps-platform/node_modules/.pnpm/@react-types+shared@3.22.1_react@18.2.0/node_modules/@react-types/shared/src/dom.d.ts",
+          "name": "LinkDOMProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string | boolean"
+      }
+    },
+    "ping": {
+      "defaultValue": null,
+      "description": "A space-separated list of URLs to ping when the link is followed. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#ping).",
+      "name": "ping",
+      "parent": {
+        "fileName": "apps-platform/node_modules/.pnpm/@react-types+shared@3.22.1_react@18.2.0/node_modules/@react-types/shared/src/dom.d.ts",
+        "name": "LinkDOMProps"
+      },
+      "declarations": [
+        {
+          "fileName": "apps-platform/node_modules/.pnpm/@react-types+shared@3.22.1_react@18.2.0/node_modules/@react-types/shared/src/dom.d.ts",
+          "name": "LinkDOMProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
+    "referrerPolicy": {
+      "defaultValue": null,
+      "description": "How much of the referrer to send when following the link. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#referrerpolicy).",
+      "name": "referrerPolicy",
+      "parent": {
+        "fileName": "apps-platform/node_modules/.pnpm/@react-types+shared@3.22.1_react@18.2.0/node_modules/@react-types/shared/src/dom.d.ts",
+        "name": "LinkDOMProps"
+      },
+      "declarations": [
+        {
+          "fileName": "apps-platform/node_modules/.pnpm/@react-types+shared@3.22.1_react@18.2.0/node_modules/@react-types/shared/src/dom.d.ts",
+          "name": "LinkDOMProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "HTMLAttributeReferrerPolicy"
+      }
+    }
+  },
+  "MenuTrigger": {
+    "trigger": {
+      "defaultValue": {
+        "value": "'press'"
+      },
+      "description": "How the menu is triggered.",
+      "name": "trigger",
+      "parent": {
+        "fileName": "apps-platform/node_modules/.pnpm/@react-types+menu@3.9.7_react@18.2.0/node_modules/@react-types/menu/src/index.d.ts",
+        "name": "MenuTriggerProps"
+      },
+      "declarations": [
+        {
+          "fileName": "apps-platform/node_modules/.pnpm/@react-types+menu@3.9.7_react@18.2.0/node_modules/@react-types/menu/src/index.d.ts",
+          "name": "MenuTriggerProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "MenuTriggerType"
+      }
+    },
+    "isOpen": {
+      "defaultValue": null,
+      "description": "Whether the overlay is open by default (controlled).",
+      "name": "isOpen",
+      "parent": {
+        "fileName": "apps-platform/node_modules/.pnpm/@react-types+overlays@3.8.5_react@18.2.0/node_modules/@react-types/overlays/src/index.d.ts",
+        "name": "OverlayTriggerProps"
+      },
+      "declarations": [
+        {
+          "fileName": "apps-platform/node_modules/.pnpm/@react-types+overlays@3.8.5_react@18.2.0/node_modules/@react-types/overlays/src/index.d.ts",
+          "name": "OverlayTriggerProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "boolean"
+      }
+    },
+    "defaultOpen": {
+      "defaultValue": null,
+      "description": "Whether the overlay is open by default (uncontrolled).",
+      "name": "defaultOpen",
+      "parent": {
+        "fileName": "apps-platform/node_modules/.pnpm/@react-types+overlays@3.8.5_react@18.2.0/node_modules/@react-types/overlays/src/index.d.ts",
+        "name": "OverlayTriggerProps"
+      },
+      "declarations": [
+        {
+          "fileName": "apps-platform/node_modules/.pnpm/@react-types+overlays@3.8.5_react@18.2.0/node_modules/@react-types/overlays/src/index.d.ts",
+          "name": "OverlayTriggerProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "boolean"
+      }
+    },
+    "onOpenChange": {
+      "defaultValue": null,
+      "description": "Handler that is called when the overlay's open state changes.",
+      "name": "onOpenChange",
+      "parent": {
+        "fileName": "apps-platform/node_modules/.pnpm/@react-types+overlays@3.8.5_react@18.2.0/node_modules/@react-types/overlays/src/index.d.ts",
+        "name": "OverlayTriggerProps"
+      },
+      "declarations": [
+        {
+          "fileName": "apps-platform/node_modules/.pnpm/@react-types+overlays@3.8.5_react@18.2.0/node_modules/@react-types/overlays/src/index.d.ts",
+          "name": "OverlayTriggerProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "(isOpen: boolean) => void"
+      }
+    }
+  },
   "NumberField": {
     "decrementAriaLabel": {
       "defaultValue": null,
@@ -3603,6 +4090,25 @@
     }
   },
   "TextField": {
+    "align": {
+      "defaultValue": null,
+      "description": "Change the alignment of the input text.",
+      "name": "align",
+      "parent": {
+        "fileName": "ui-kit-react/lib/components/text-field/text-field.tsx",
+        "name": "TextFieldProps"
+      },
+      "declarations": [
+        {
+          "fileName": "ui-kit-react/lib/components/text-field/text-field.tsx",
+          "name": "TextFieldProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "\"left\" | \"right\" | null"
+      }
+    },
     "label": {
       "defaultValue": null,
       "description": "The label for the input.",
@@ -3679,6 +4185,25 @@
         "name": "string"
       }
     },
+    "prefix": {
+      "defaultValue": null,
+      "description": "Render the input with a prefix.",
+      "name": "prefix",
+      "parent": {
+        "fileName": "ui-kit-react/lib/components/text-field/text-field.tsx",
+        "name": "TextFieldProps"
+      },
+      "declarations": [
+        {
+          "fileName": "ui-kit-react/lib/components/text-field/text-field.tsx",
+          "name": "TextFieldProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
     "validationMessage": {
       "defaultValue": null,
       "description": "Shows a validation message under the input.",
@@ -3773,7 +4298,7 @@
       ],
       "required": false,
       "type": {
-        "name": "\"none\" | \"inline\" | \"list\" | \"both\""
+        "name": "\"list\" | \"none\" | \"inline\" | \"both\""
       }
     },
     "aria-haspopup": {
@@ -3792,7 +4317,7 @@
       ],
       "required": false,
       "type": {
-        "name": "boolean | \"false\" | \"true\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\""
+        "name": "boolean | \"true\" | \"false\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\""
       }
     },
     "isReadOnly": {