@eightshift/ui-components 5.3.0 → 5.3.1

package/dist/components/button/button.js

@@ -89,6 +89,27 @@ const $13c3c67164f4d5be$export$4c260019440d418f = /* @__PURE__ */ forwardRef(fun
     "data-orientation": props.orientation || "horizontal"
   }, renderProps.children);
 });
+/**
+ * @typedef {Object} ButtonProps
+ * @property {JSX.Element} [props.icon] - Icon to display within the button.
+ * @property {ButtonSize} [props.size='default'] - The size of the button.
+ * @property {ButtonType} [props.type='default'] - The type of the button.
+ * @property {boolean} [props.disabled] - If `true`, the button is disabled.
+ * @property {string} [props.className] - Classes to pass to the button.
+ * @property {string|boolean} [props.tooltip] - Tooltip text to display on hover. If set to `true` and an `aria-label` is not provided, the tooltip text will be used as the `aria-label`.
+ * @property {Function} [props.onPress] - Function to run when the button is pressed.
+ * @property {React.Ref} [props.forwardedRef] - Ref to forward to the button. Use the same as the `ref` prop.
+ * @property {string} [props.wrapperClassName] - Classes to pass to the tooltip wrapper.
+ * @property {TooltipProps} [props.tooltipProps] - Props to pass to the tooltip.
+ * @property {boolean} [props.pending] - If `true`, the button is in a pending state, which can be used to indicate that an action is being processed.
+ * @property {string} [props.pendingAriaLabel='Loading'] - ARIA label for the pending state, used for screen readers.
+ * @property {boolean} [props.hidden] - If `true`, the component is not rendered.
+ *
+ * @typedef {'small' | 'default' | 'large'} ButtonSize
+ * @typedef {'default' | 'selected' | 'selectedGhost' | 'ghost' | 'danger' | 'dangerGhost'} ButtonType
+ *
+ * @preserve
+ */
 /**
  * A simple button component.
  *

package/dist/components/popover/popover.js

@@ -3,6 +3,27 @@ import { e as $07b14b47974efb58$export$5b6b19405a83ff9d, f as $de32f1b87079253c$
 import { c as clsx } from "../../lite-DVmmD_-j.js";
 import { _ as __ } from "../../default-i18n-CN_q3KUs.js";
 import { Button } from "../button/button.js";
+/**
+ * @typedef {Object} PopoverProps
+ * @property {React.Ref} props.triggerRef - Ref of the trigger button. In uncontrolled mode, this element will be used to open the popover. In controlled mode, the popover will be anchored to this element.
+ * @property {boolean} [props.openByDefault=false] - (**Controlled mode**) If `true`, the popover is open by default.
+ * @property {boolean} props.isOpen - (**Uncontrolled mode**) If `true`, the popover is open.
+ * @property {Function} props.onOpenChange - (**Uncontrolled mode**) Function to run when the popover is opened or closed. `(isOpen: boolean) => void`.
+ * @property {PopoverPlacement} props.placement - The placement of the popover.
+ * @property {string} [props.className] - Classes to pass to the popover contents.
+ * @property {string} [props.wrapperClassName] - Classes to pass to the popover wrapper.
+ * @property {Object} props.style - Styles to pass to the popover.
+ * @property {number} props.offset - Offset from the trigger element, on the same axis as the placement of the popover (e.g. if `placement` is `left`, this controls the horizontal spacing from the element).
+ * @property {number} props.crossOffset - Offset from the trigger element, on the opposite axis as the placement of the popover (e.g. if `placement` is `left`, this controls the vertical spacing from the element).
+ * @property {number} props.containerPadding - Space that should be left between the popover and the edge of the container (the default container is browser window).
+ * @property {boolean} props.shouldFlip - If `true`, the popover should flip when there is not enough space.
+ * @property {Function} [props.shouldCloseOnInteractOutside=() => true] - Allows ignoring close events for certain elements. `(element: HTMLElement) => boolean`.
+ * @property {boolean} [props.hidden] - If `true`, the component is not rendered.
+ *
+ * @typedef {'bottom' | 'bottom left' | 'bottom right' | 'bottom start' | 'bottom end' | 'top' | 'top left' | 'top right' | 'top start' | 'top end' | 'left' | 'left top' | 'left bottom' | 'start' | 'start top' | 'start bottom' | 'right' | 'right top' | 'right bottom' | 'end' | 'end top' | 'end bottom'} PopoverPlacement
+ *
+ * @preserve
+ */
 /**
  * A popover component.
  *

package/dist/components/tooltip/tooltip.js

@@ -345,6 +345,29 @@ function $4e3b923658d69c60$var$TooltipInner(props) {
     }
   }, renderProps.children));
 }
+/**
+ * @typedef {Object} TooltipProps
+ * @property {string|JSX.Element} props.text - The text to display in the tooltip.
+ * @property {TooltipTheme} [props.theme='dark'] - The theme of the tooltip.
+ * @property {number} [props.offset=0] - Additional offset between the tooltip and the element on the main axis (same axis as element).
+ * @property {number} [props.crossOffset=0] - Additional offset between the tooltip and the element on the cross axis (opposite axis as element).
+ * @property {number} [props.containerPadding=12] - Space that should be left between the tooltip and the main containing element (usually browser window).
+ * @property {number} [props.openDelay=1500] - Duration before the tooltip is shown, in milliseconds.
+ * @property {number} [props.closeDelay=500] - Duration before the tooltip is hidden, in milliseconds.
+ * @property {boolean} [props.shouldFlip=true] - If `false`, the tooltip will not flip to the opposite side if there is not enough space.
+ * @property {boolean} [props.defaultOpen] - (**Uncontrolled mode**) Whether the tooltip is initially open.
+ * @property {boolean} [props.open] - (**Controlled mode**) Whether the tooltip is open.
+ * @property {Function} [props.onOpenChange] - (**Controlled mode**) Function to run when the tooltip is opened or closed.
+ * @property {TooltipPlacement} [props.placement] - The side of the trigger element where the tooltip will be displayed.
+ * @property {string} [props.className] - Classes to pass to the tooltip.
+ * @property {RefObject<Element>} [props.triggerRef] - Ref to anchor the tooltip to. If not provided, the tooltip will be anchored to the trigger element.
+ * @property {boolean} [props.arrow] - If `true`, an arrow is shown on the tooltip.
+ *
+ * @typedef {'light' | 'dark'} TooltipTheme
+ * @typedef {'bottom' | 'bottom left' | 'bottom right' | 'bottom start' | 'bottom end' | 'top' | 'top left' | 'top right' | 'top start' | 'top end' | 'left' | 'left top' | 'left bottom' | 'start' | 'start top' | 'start bottom' | 'right' | 'right top' | 'right bottom' | 'end' | 'end top' | 'end bottom'} TooltipPlacement
+ *
+ * @preserve
+ */
 /**
  * A simple tooltip component.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@eightshift/ui-components",
-	"version": "5.3.0",
+	"version": "5.3.1",
 	"type": "module",
 	"main": "./dist/index.js",
 	"module": "./dist/index.js",
@@ -35,7 +35,7 @@
 		"dev": "vite",
 		"start": "vite",
 		"build": "vite build",
-		"lint": "npx eslint",
+		"lint": "bun x eslint",
 		"preview": "vite preview"
 	},
 	"peerDependencies": {