ionbase-ui 0.16.0 → 0.18.0

package/dist/meta/Tooltip.json

@@ -0,0 +1,78 @@
+{
+  "name": "Tooltip",
+  "source": "src/components/Tooltip.tsx",
+  "propsType": "TooltipProps",
+  "description": "Tooltip — Figma `Tooltip` (801:1568).\n\nWraps its trigger rather than taking a ref, so the common case is one\nelement deep: `<Tooltip label=\"...\"><Button/></Tooltip>`.\n\nFOCUS OPENS IT, NOT JUST HOVER. A hover-only tooltip is invisible to keyboard\nand switch users, and `useTooltipTrigger` wires both plus Escape to dismiss.\nIt also enforces one open tooltip at a time and a shared warmup, so moving\nalong a row of icon buttons does not flash a tooltip per button.\n\nThe trigger is cloned with the interaction props and a ref, which means it\nmust forward both. Every component in this library does; a bare `<div>` does\ntoo. A function component that drops its ref will render, but the tooltip\nwill have nothing to position against.",
+  "import": "import { Tooltip } from 'ionbase-ui';",
+  "stylesheet": "src/styles/tooltip.css",
+  "tokens": [
+    "--font-family-sans",
+    "--font-weight-medium",
+    "--font-weight-regular",
+    "--ion-shadow-shadow-md",
+    "--ion-tooltip-arrow",
+    "--radius-sm",
+    "--spacing-12",
+    "--spacing-4",
+    "--spacing-8",
+    "--surface-inverse",
+    "--text-inverse",
+    "--type-body-sm",
+    "--type-body-sm-line-height"
+  ],
+  "props": {
+    "label": {
+      "type": "React.ReactNode",
+      "required": true,
+      "origin": "own",
+      "description": "The hint. A tooltip is text only — anything interactive or focusable\nbelongs in a popover, because a tooltip cannot be focused, cannot be\nscrolled, and closes the moment the pointer leaves."
+    },
+    "title": {
+      "type": "React.ReactNode",
+      "required": false,
+      "origin": "own",
+      "description": "Optional heading above the label."
+    },
+    "placement": {
+      "type": "TooltipPlacement | undefined",
+      "required": false,
+      "origin": "own",
+      "description": "Matches the Figma `Placement` variant, and names where the TOOLTIP sits —\nnot where the arrow points. `top` is above the trigger, with the arrow on\nthe tooltip's bottom edge.\n\nTreated as a preference, not a guarantee: it flips to the opposite side\nwhen there is no room, which is the behaviour Figma cannot draw.",
+      "values": [
+        "right",
+        "left",
+        "top",
+        "bottom"
+      ]
+    },
+    "delay": {
+      "type": "number | undefined",
+      "required": false,
+      "origin": "own",
+      "description": "Milliseconds before it opens on hover. Focus always opens immediately."
+    },
+    "isDisabled": {
+      "type": "boolean | undefined",
+      "required": false,
+      "origin": "own",
+      "description": "Disable the tooltip without unmounting the trigger."
+    },
+    "children": {
+      "type": "React.ReactElement<unknown, string | React.JSXElementConstructor<any>>",
+      "required": true,
+      "origin": "own",
+      "description": "The element the tooltip describes. Must accept a ref and DOM props."
+    },
+    "className": {
+      "type": "string | undefined",
+      "required": false,
+      "origin": "own"
+    }
+  },
+  "propCounts": {
+    "own": 7,
+    "aria": 0,
+    "dom": 0,
+    "other": 0
+  }
+}