@payfit/unity-components 2.46.13 → 2.46.14

package/dist/esm/components/date-range-picker/DateRangePicker.js

@@ -0,0 +1,175 @@
+import { jsxs as f, jsx as a } from "react/jsx-runtime";
+import { forwardRef as I } from "react";
+import { uyTv as b } from "@payfit/unity-themes";
+import { DateRangePicker as U, Group as B, Button as j, Popover as E } from "react-aria-components/DateRangePicker";
+import { Dialog as M } from "react-aria-components/Dialog";
+import { useIntl as G } from "react-intl";
+import { DateRangeCalendar as T } from "../date-range-calendar/DateRangeCalendar.js";
+import { Icon as $ } from "../icon/Icon.js";
+import { DateRangeInput as q } from "./parts/DateRangeInput.js";
+const z = b({
+  slots: {
+    base: [
+      "uy:group uy:flex uy:h-5.5 uy:sm:h-500 uy:border uy:border-solid uy:rounded-100 uy:sm:rounded-75",
+      "uy:active:border-border-form-active uy:data-[focus-visible=true]:border-border-form-active uy:data-[open=true]:border-border-form-active"
+    ],
+    inputWrapper: [
+      "uy:flex uy:grow uy:rounded-100 uy:sm:rounded-75 uy:outline-none",
+      // Show focus styles when input wrapper is focused AND button is not focused
+      "uy:focus-within:outline-2 uy:focus-within:outline-solid uy:focus-within:outline-utility-focus-ring uy:focus-within:outline-offset-3",
+      // Hide focus styles when button is focused
+      "uy:group-[:has(button:focus)]:data-[focus-within]:outline-none uy:group-[:has(button:focus)]:data-[focus-within]:outline-offset-0 uy:group-[:has(button:focus)]:data-[focus-within]:outline-transparent"
+    ],
+    suffix: [
+      "uy:flex-grow-0 uy:content-center uy:p-125 uy:border-l uy:border-solid uy:rounded-r-100 uy:sm:rounded-r-75 uy:text-content-neutral-low",
+      "uy:hover:bg-surface-neutral-hover uy:active:bg-surface-neutral-pressed uy:active:border-border-form-active uy:data-[pressed=true]:not-group-data-[open=true]:bg-surface-neutral-pressed uy:data-[pressed=true]:not-group-data-[open=true]:border-border-form-active uy:group-data-[open=true]:border-border-form-active",
+      "uy:focus-visible:outline-2 uy:focus-visible:outline-utility-focus-ring uy:focus-visible:outline-offset-3"
+    ]
+  },
+  variants: {
+    isInvalid: {
+      true: {
+        base: "uy:border-border-form-error uy:bg-surface-form-error",
+        suffix: "uy:bg-surface-form-error uy:border-border-form-error"
+      }
+    },
+    isReadOnly: {
+      true: {
+        base: "uy:border-border-form-disabled uy:bg-surface-form-disabled",
+        inputWrapper: "uy:border-border-form-disabled uy:bg-surface-form-disabled",
+        suffix: "uy:bg-surface-form-disabled uy:border-border-form-disabled uy:text-content-form-disabled"
+      }
+    },
+    isDisabled: {
+      true: {
+        base: "uy:border-border-form-disabled uy:bg-surface-form-disabled",
+        inputWrapper: "uy:bg-surface-form-disabled uy:text-content-form-disabled",
+        suffix: "uy:bg-surface-form-disabled uy:border-border-form-disabled uy:text-content-form-disabled"
+      }
+    }
+  },
+  compoundVariants: [
+    {
+      isInvalid: !1,
+      isDisabled: !1,
+      isReadOnly: !1,
+      className: {
+        base: "uy:border-border-form-enabled uy:bg-surface-form-enabled",
+        suffix: "uy:border-border-form-enabled uy:bg-surface-neutral uy:text-content-neutral-low"
+      }
+    }
+  ]
+}), A = b({
+  base: "uy:w-[356px] uy:overflow-auto uy:shadow-300 uy:border uy:border-solid uy:border-border-neutral uy:bg-surface-neutral uy:rounded-md uy:sm:rounded-75",
+  variants: {
+    isEntering: {
+      true: "uy:animate-in uy:fade-in uy:data-[placement-bottom]:slide-in-from-top-1 uy:data-[placement-top]:slide-out-to-bottom-1 uy:duration-200 uy:ease-out"
+    },
+    isExiting: {
+      true: "uy:animate-out uy:fade-out uy:data-[placement-bottom]:slide-out-to-top-1 uy:data-[placement-top]:slide-out-to-bottom-1 uy:duration-150 uy:ease-in"
+    }
+  }
+}), H = I(
+  ({
+    value: i,
+    defaultValue: n,
+    isInvalid: t,
+    isLoading: y,
+    isDisabled: o,
+    isReadOnly: u,
+    onClearButtonPress: c,
+    onBlur: d,
+    onFocus: s,
+    onChange: m,
+    onOpenChange: p,
+    id: g,
+    "aria-label": h,
+    "aria-labelledby": v,
+    "aria-describedby": x,
+    "aria-details": D,
+    ...e
+  }, w) => {
+    const k = G(), { base: C, inputWrapper: R, suffix: P } = z({
+      isInvalid: !!t,
+      isReadOnly: !!u,
+      isDisabled: !!o
+    }), l = (r) => {
+      m?.(r);
+    }, V = (r) => {
+      p?.(r), r ? s?.() : d?.();
+    }, N = (r) => e.isDateUnavailable ? e.isDateUnavailable(r) : !1, O = () => {
+      c?.();
+    };
+    return /* @__PURE__ */ f(
+      U,
+      {
+        ref: w,
+        "data-dd-privacy": "mask",
+        ...e,
+        className: C(),
+        value: i,
+        defaultValue: n,
+        minValue: e.minValue,
+        maxValue: e.maxValue,
+        isReadOnly: !!u,
+        isDisabled: !!o,
+        onChange: l,
+        onFocus: s,
+        onBlur: d,
+        onOpenChange: V,
+        isInvalid: !!t,
+        isDateUnavailable: N,
+        "aria-label": h,
+        "aria-labelledby": v,
+        "aria-describedby": x,
+        "aria-details": D,
+        children: [
+          /* @__PURE__ */ f(B, { className: R(), id: g, children: [
+            /* @__PURE__ */ a(
+              q,
+              {
+                isLoading: y,
+                isDisabled: o,
+                isReadOnly: u,
+                isInvalid: t,
+                onClearButtonPress: O
+              }
+            ),
+            /* @__PURE__ */ a(j, { className: P(), isDisabled: u || o, children: /* @__PURE__ */ a(
+              $,
+              {
+                src: "CalendarBlankOutlined",
+                color: "inherit",
+                alt: k.formatMessage({
+                  id: "unity:component:form-field:date-range-picker:calendar-button",
+                  defaultMessage: "Open Calendar"
+                })
+              }
+            ) })
+          ] }),
+          /* @__PURE__ */ a(
+            E,
+            {
+              className: ({ isEntering: r, isExiting: W }) => A({ isEntering: r, isExiting: W }),
+              children: /* @__PURE__ */ a(M, { className: "uy:p-150", "data-dd-privacy": "mask", children: /* @__PURE__ */ a(
+                T,
+                {
+                  value: i,
+                  defaultValue: n,
+                  minValue: e.minValue,
+                  maxValue: e.maxValue,
+                  onChange: l,
+                  firstDayOfWeek: e.firstDayOfWeek
+                }
+              ) })
+            }
+          )
+        ]
+      }
+    );
+  }
+);
+H.displayName = "DateRangePicker";
+export {
+  H as DateRangePicker
+};

package/dist/esm/components/date-range-picker/TanstackDateRangePicker.d.ts

@@ -0,0 +1,22 @@
+import { DateRangePickerProps } from './DateRangePicker.js';
+export type TanstackDateRangePickerProps = Omit<DateRangePickerProps, 'value' | 'defaultValue' | 'isInvalid'>;
+/**
+ * `TanstackDateRangePicker` is a controlled date range picker wired to the TanStack Form field context.
+ * It is based on the Unity `DateRangePicker` component.
+ *
+ * Example:
+ * ```tsx
+ * function ExampleField() {
+ *   const form = useTanstackUnityForm<{ period: DateRange | null }>({ validators: {} })
+ *   return (
+ *     <form>
+ *       <form.AppField name="period">
+ *         {() => <TanstackDateRangePicker />}
+ *       </form.AppField>
+ *     </form>
+ *   )
+ * }
+ * ```
+ */
+declare const TanstackDateRangePicker: import('react').ForwardRefExoticComponent<TanstackDateRangePickerProps & import('react').RefAttributes<HTMLDivElement>>;
+export { TanstackDateRangePicker };

package/dist/esm/components/date-range-picker/TanstackDateRangePicker.js

@@ -0,0 +1,53 @@
+import { jsx as p } from "react/jsx-runtime";
+import { forwardRef as h } from "react";
+import { useFieldContext as b } from "../../hooks/tanstack-form-context.js";
+import { useFieldA11yContext as g } from "../form-field/TanstackFormField.context.js";
+import { DateRangePicker as k } from "./DateRangePicker.js";
+const x = h(
+  ({
+    onClearButtonPress: o,
+    onBlur: i,
+    onFocus: r,
+    onChange: l,
+    onOpenChange: s,
+    isReadOnly: d,
+    isDisabled: c,
+    ...m
+  }, u) => {
+    const e = b(), a = g(), f = e.state.meta.isTouched && !e.state.meta.isValid, n = [a.helperTextId, a.feedbackTextId].filter(Boolean).join(" ");
+    return /* @__PURE__ */ p(
+      k,
+      {
+        ...m,
+        ref: u,
+        id: a.inputId,
+        value: e.state.value,
+        onChange: (t) => {
+          e.handleChange(t), l?.(t);
+        },
+        onBlur: () => {
+          e.handleBlur(), i?.();
+        },
+        onFocus: () => {
+          r?.();
+        },
+        onOpenChange: (t) => {
+          s?.(t);
+        },
+        onClearButtonPress: () => {
+          e.setValue(null), o?.();
+        },
+        isReadOnly: d,
+        isDisabled: c,
+        isInvalid: f,
+        "aria-labelledby": a.labelId,
+        "aria-describedby": n.length > 0 ? n : void 0,
+        "aria-details": a.contextualLinkId
+      }
+    );
+  }
+);
+x.displayName = "TanstackDateRangePicker";
+export {
+  x as TanstackDateRangePicker
+};

package/dist/esm/components/date-range-picker/parts/DateRangeInput.d.ts

@@ -0,0 +1,16 @@
+export interface DateRangeInputProps {
+    /** Whether the field is in an invalid state */
+    isInvalid?: boolean;
+    /** Whether the field is in a loading state */
+    isLoading?: boolean;
+    /** Whether the field is disabled */
+    isDisabled?: boolean;
+    /** Whether the field is read-only */
+    isReadOnly?: boolean;
+    /** Clear button click handler */
+    onClearButtonPress?: () => void;
+}
+export declare function DateRangeInput({ isLoading, isInvalid, isReadOnly, isDisabled, onClearButtonPress, }: DateRangeInputProps): import("react/jsx-runtime").JSX.Element;
+export declare namespace DateRangeInput {
+    var displayName: string;
+}

package/dist/esm/components/date-range-picker/parts/DateRangeInput.js

@@ -0,0 +1,103 @@
+import { jsxs as n, jsx as e } from "react/jsx-runtime";
+import { useContext as x } from "react";
+import { uyTv as N } from "@payfit/unity-themes";
+import { DateRangePickerStateContext as b, DateInput as m, DateSegment as u } from "react-aria-components/DateRangePicker";
+import { useIntl as I } from "react-intl";
+import { dateInput as v, dateSegment as d } from "../../date-picker/parts/DateInput.js";
+import { CircularIconButton as C } from "../../icon-button/CircularIconButton.js";
+import { Icon as P } from "../../icon/Icon.js";
+import { Spinner as D } from "../../spinner/Spinner.js";
+const M = N({
+  base: "uy:px-50 uy:flex uy:items-center",
+  variants: {
+    isDisabled: {
+      true: "uy:text-content-form-disabled",
+      false: [
+        //theme: legacy
+        "uy:theme-legacy:text-content-neutral-lowest-enabled",
+        //theme: rebrand
+        "uy:theme-rebrand:text-content-neutral-lowest"
+      ]
+    }
+  }
+});
+function S({
+  isLoading: o,
+  isInvalid: r,
+  isReadOnly: s,
+  isDisabled: a,
+  onClearButtonPress: p
+}) {
+  const l = I(), i = x(b), { value: c } = i, { base: f, input: y, state: h } = v({
+    isInvalid: !!r,
+    isReadOnly: !!s,
+    isDisabled: !!a
+  }), g = c?.start && c?.end && !o && !s && !a;
+  return /* @__PURE__ */ n("div", { className: f(), children: [
+    /* @__PURE__ */ n("div", { className: y(), children: [
+      /* @__PURE__ */ e(m, { slot: "start", className: "uy:flex uy:gap-25", children: (t) => /* @__PURE__ */ e(
+        u,
+        {
+          segment: t,
+          className: d({
+            isPlaceholder: t.isPlaceholder,
+            isLiteral: t.type === "literal"
+          })
+        }
+      ) }),
+      /* @__PURE__ */ e("span", { className: M({ isDisabled: !!a }), children: "→" }),
+      /* @__PURE__ */ e(m, { slot: "end", className: "uy:flex uy:gap-25", children: (t) => /* @__PURE__ */ e(
+        u,
+        {
+          segment: t,
+          className: d({
+            isPlaceholder: t.isPlaceholder,
+            isLiteral: t.type === "literal"
+          })
+        }
+      ) })
+    ] }),
+    /* @__PURE__ */ n("div", { className: h(), children: [
+      o && /* @__PURE__ */ e(
+        D,
+        {
+          color: "inherit",
+          size: "small",
+          label: l.formatMessage({
+            id: "unity:component:common:loading:label",
+            defaultMessage: "Loading..."
+          })
+        }
+      ),
+      r && /* @__PURE__ */ e(
+        P,
+        {
+          src: "WarningCircleOutlined",
+          color: "content.form.invalid",
+          alt: l.formatMessage({
+            id: "unity:component:form-field:form-input:error:alt",
+            defaultMessage: "Error"
+          })
+        }
+      ),
+      g && /* @__PURE__ */ e(
+        C,
+        {
+          slot: null,
+          title: l.formatMessage({
+            id: "unity:component:common:clear:title",
+            defaultMessage: "Clear"
+          }),
+          icon: "CloseOutlined",
+          onPress: () => {
+            i?.setValue(null), p?.();
+          }
+        }
+      )
+    ] })
+  ] });
+}
+S.displayName = "DateRangeInput";
+export {
+  S as DateRangeInput
+};

package/dist/esm/components/date-range-picker-field/TanstackDateRangePickerField.d.ts

@@ -0,0 +1,64 @@
+import { ReactNode } from 'react';
+import { TanstackDateRangePickerProps } from '../date-range-picker/TanstackDateRangePicker.js';
+import { LabelProps } from '../label/Label.js';
+export type TanstackDateRangePickerFieldProps = TanstackDateRangePickerProps & Pick<LabelProps, 'isRequired' | 'requiredVariant'> & {
+    /** The label for the date range picker field. */
+    label: string;
+    /** Helper text to display below the date range picker field. */
+    helperText?: ReactNode;
+    /** A contextual link to display below the date range picker field. */
+    contextualLink?: ReactNode;
+};
+/**
+ * The `TanstackDateRangePickerField` component renders a full field (label, date range picker)
+ * wired to the TanStack Form context. It manages state and accessibility via the
+ * context provided by `useTanstackUnityForm` and `<form.AppField name="…">`.
+ *
+ * Behavior:
+ * - Renders `TanstackDateRangePicker` with calendar overlay for date range selection.
+ * - Displays the label (`TanstackFormLabel`), helper text (`TanstackFormHelperText`),
+ *   feedback messages (`TanstackFormFeedbackText`), and an optional contextual link.
+ *
+ * Accessibility:
+ * - Automatically wires `aria-labelledby`, `aria-describedby` (helper/feedback), and
+ *   `aria-details` using identifiers from the `a11y` context.
+ *
+ * Example:
+ * ```tsx
+ * import { TanstackDateRangePickerField } from "@payfit/unity-components"
+ * import { useTanstackUnityForm } from "@payfit/unity-components"
+ * import { CalendarDate } from '@internationalized/date'
+ *
+ * function Example() {
+ *   const schema = z.object({
+ *     period: z.custom<{ start: CalendarDate; end: CalendarDate } | null>()
+ *       .refine(range => range !== null, 'Date range is required'),
+ *   })
+ *
+ *   const form = useTanstackUnityForm({ validators: {
+ *     onBlur: schema,
+ *   } })
+ *   return (
+ *     <form>
+ *       <form.AppField name="period">
+ *         {() => (
+ *           <TanstackDateRangePickerField
+ *             label="Period"
+ *             helperText="Select a date range"
+ *           />
+ *         )}
+ *       </form.AppField>
+ *     </form>
+ *   )
+ * }
+ * ```
+ */
+declare const TanstackDateRangePickerField: import('react').ForwardRefExoticComponent<TanstackDateRangePickerProps & Pick<LabelProps, "isRequired" | "requiredVariant"> & {
+    /** The label for the date range picker field. */
+    label: string;
+    /** Helper text to display below the date range picker field. */
+    helperText?: ReactNode;
+    /** A contextual link to display below the date range picker field. */
+    contextualLink?: ReactNode;
+} & import('react').RefAttributes<HTMLDivElement>>;
+export { TanstackDateRangePickerField };

package/dist/esm/components/date-range-picker-field/TanstackDateRangePickerField.js

@@ -0,0 +1,41 @@
+import { jsxs as p, jsx as r } from "react/jsx-runtime";
+import { forwardRef as d } from "react";
+import { TanstackDateRangePicker as f } from "../date-range-picker/TanstackDateRangePicker.js";
+import { TanstackFormFeedbackText as l } from "../form-field/parts/TanstackFormFeedbackText.js";
+import { TanstackFormHelperText as F } from "../form-field/parts/TanstackFormHelperText.js";
+import { TanstackFormLabel as T } from "../form-field/parts/TanstackFormLabel.js";
+import { TanstackFormField as P } from "../form-field/TanstackFormField.js";
+const x = d(
+  ({
+    label: a,
+    helperText: o,
+    contextualLink: e,
+    isRequired: m,
+    isLoading: t,
+    isDisabled: c,
+    isReadOnly: n,
+    requiredVariant: i,
+    ...s
+  }, k) => /* @__PURE__ */ p(P, { children: [
+    /* @__PURE__ */ r(
+      T,
+      {
+        requiredVariant: i,
+        isRequired: m,
+        children: a
+      }
+    ),
+    o && /* @__PURE__ */ r(F, { children: o }),
+    /* @__PURE__ */ r(f, { ref: k, ...{
+      isLoading: t,
+      isDisabled: c,
+      isReadOnly: n
+    }, ...s }),
+    /* @__PURE__ */ r(l, {}),
+    e
+  ] })
+);
+x.displayName = "TanstackDateRangePickerField";
+export {
+  x as TanstackDateRangePickerField
+};

package/dist/esm/components/date-range-picker-field/test-utils.d.ts

@@ -0,0 +1,19 @@
+import { PlayCtx } from '../../types/testing.js';
+import { CalendarDate } from '@internationalized/date';
+/**
+ * Factory to get date range picker testing utils
+ * @param context the story context
+ */
+export declare const getTestingUtilsDateRangePicker: (context: PlayCtx) => {
+    fillCalendarDateRange: ({ labelText, startDate, endDate, }: {
+        labelText: string;
+        startDate: CalendarDate;
+        endDate: CalendarDate;
+    }) => Promise<void>;
+    getCalendarDateRangeValue: ({ labelText }: {
+        labelText: string;
+    }) => {
+        start: CalendarDate;
+        end: CalendarDate;
+    };
+};

package/dist/esm/components/date-range-picker-field/test-utils.js

@@ -0,0 +1,66 @@
+import { CalendarDate as l } from "@internationalized/date";
+import { within as c, userEvent as r } from "storybook/test";
+const m = (i) => {
+  const s = (e) => {
+    const t = c(i.canvasElement).getAllByLabelText(
+      e,
+      {
+        exact: !1,
+        selector: "span"
+      }
+    );
+    if (t.length !== 6)
+      throw new Error(
+        `Date range field for ${e} not found. Expected 6 segments, got ${t.length}`
+      );
+    return {
+      start: t.slice(0, 3),
+      end: t.slice(3, 6)
+    };
+  }, g = async (e, t) => {
+    await r.type(
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      e.find((a) => a.getAttribute("data-type") === "day"),
+      String(t.day)
+    ), await r.type(
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      e.find((a) => a.getAttribute("data-type") === "month"),
+      String(t.month)
+    ), await r.type(
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      e.find((a) => a.getAttribute("data-type") === "year"),
+      String(t.year)
+    );
+  }, d = (e) => {
+    const t = (a) => parseInt(
+      e.find((n) => n.getAttribute("data-type") === a)?.textContent ?? ""
+    );
+    return new l(
+      t("year"),
+      t("month"),
+      t("day")
+    );
+  };
+  return {
+    fillCalendarDateRange: async ({
+      labelText: e,
+      startDate: t,
+      endDate: a
+    }) => {
+      await i.step(`Fill date range picker ${e}`, async () => {
+        const { start: n, end: o } = s(e);
+        await g(n, t), await g(o, a);
+      });
+    },
+    getCalendarDateRangeValue: ({ labelText: e }) => {
+      const { start: t, end: a } = s(e);
+      return {
+        start: d(t),
+        end: d(a)
+      };
+    }
+  };
+};
+export {
+  m as getTestingUtilsDateRangePicker
+};

package/dist/esm/components/definition-list/DefinitionList.context.d.ts

@@ -0,0 +1,19 @@
+import { PropsWithChildren } from 'react';
+/**
+ * Valeurs du contexte de la DefinitionList.
+ */
+export interface DefinitionListContextValue {
+    /**
+     * La disposition des éléments de la liste.
+     */
+    layout: 'horizontal' | 'vertical';
+}
+/**
+ * Fournisseur de contexte pour la DefinitionList.
+ */
+export declare const DefinitionListContextProvider: ({ children, layout, }: PropsWithChildren<DefinitionListContextValue>) => import("react/jsx-runtime").JSX.Element;
+/**
+ * Hook pour accéder au contexte de la DefinitionList.
+ * Doit être utilisé à l'intérieur d'un composant DefinitionList.
+ */
+export declare const useDefinitionListContext: () => DefinitionListContextValue;

package/dist/esm/components/definition-list/DefinitionList.d.ts

@@ -0,0 +1,24 @@
+import { ReactNode } from 'react';
+import { DefinitionListContextValue } from './DefinitionList.context.js';
+import * as React from 'react';
+export interface DefinitionListProps {
+    /**
+     * The layout of the definition list.
+     * @default 'horizontal'
+     */
+    layout?: DefinitionListContextValue['layout'];
+    /**
+     * The content of the definition list, typically DefinitionItem components.
+     */
+    children: ReactNode;
+}
+/**
+ * DefinitionList provides a semantic HTML structure for displaying key-value pairs.
+ * It uses a `<dl>` tag and manages the layout for its `DefinitionItem` children.
+ * @example
+ * <DefinitionList layout="horizontal">
+ *   <DefinitionItem term="Last name" description="Doe" />
+ *   <DefinitionItem term="First name" description="John" />
+ * </DefinitionList>
+ */
+export declare const DefinitionList: React.ForwardRefExoticComponent<DefinitionListProps & React.RefAttributes<HTMLDListElement>>;

package/dist/esm/components/definition-list/parts/DefinitionItem.d.ts

@@ -0,0 +1,31 @@
+import { ReactNode } from 'react';
+import * as React from 'react';
+export interface DefinitionItemProps {
+    /**
+     * The term of the definition (label).
+     */
+    term: string;
+    /**
+     * Optional content displayed next to the term (e.g., an action button).
+     */
+    termSuffix?: ReactNode;
+    /**
+     * The description content associated with the term.
+     */
+    description?: ReactNode;
+    /**
+     * Children of the component.
+     */
+    children?: ReactNode;
+    /**
+     * The vertical alignment of the term.
+     * Note: Normally, you should not need to set this property, if you follow the design guidelines.
+     * @default 'undefined'
+     */
+    verticalAlign?: 'start' | 'center';
+}
+/**
+ * DefinitionItem displays a term (`dt`) and its description (`dd`) within a `DefinitionList`.
+ * It adapts its layout based on the context provided by `DefinitionList`.
+ */
+export declare const DefinitionItem: React.ForwardRefExoticComponent<Omit<DefinitionItemProps, "children"> & React.RefAttributes<HTMLDivElement>>;

package/dist/esm/components/definition-tooltip/DefinitionTooltip.d.ts

@@ -0,0 +1,23 @@
+import { ValidTextElements } from '../text/Text.js';
+import { TooltipProps } from '../tooltip/Tooltip.js';
+export interface DefinitionTooltipProps extends Omit<TooltipProps, 'children'> {
+    /** The HTML element to render the definition tooltip as. Defaults to a `<span>`. */
+    asElement?: Extract<ValidTextElements, 'abbr' | 'dfn' | 'span'>;
+    /** The text to trigger the tooltip. */
+    children: string;
+}
+/**
+ * Definition tooltips provide brief definitions for words through a tooltip on hover.
+ * They may appear within a sentence or as standalone text, and should be used only to define terms or acronyms.
+ * @param {DefinitionTooltipProps} props - The props for the `DefinitionTooltip` component.
+ * @example
+ * ```tsx
+ * import { DefinitionTooltip } from '@payfit/unity-components'
+ *
+ * <DefinitionTooltip title="I am the description of the definition tooltip">I am an definition tooltip</DefinitionTooltip>
+ * ```
+ * @see {@link DefinitionTooltipProps} for all available props
+ * @remarks {@link https://www.payfit.design/24f360409/p/05d163-info-link|Design docs}
+ */
+declare const DefinitionTooltip: import('react').ForwardRefExoticComponent<DefinitionTooltipProps & import('react').RefAttributes<HTMLDivElement>>;
+export { DefinitionTooltip };