@payfit/unity-components 0.0.0-alpha.11

package/dist/esm/components/checkbox-field/CheckboxField.d.ts

@@ -0,0 +1,74 @@
+import { ForwardedRef, JSX, ReactNode } from 'react';
+import { FieldPath, FieldValues } from 'react-hook-form';
+import { infer as ZodInfer } from 'zod';
+import { Schema } from '../../hooks/use-form.types.js';
+import { LabelProps } from '../label/Label.js';
+interface FieldProps<TFieldValues extends FieldValues = FieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>> extends Pick<LabelProps, 'isRequired' | 'requiredVariant'> {
+    /** The name of the field, which should match the form schema. */
+    name: TName;
+    /** The label for the checkbox. */
+    children: ReactNode;
+    /** Helper text to display below the checkbox. */
+    helperText?: ReactNode;
+    /** A contextual link to display below the checkbox. */
+    contextualLink?: ReactNode;
+    /** The default selected value of the checkbox. */
+    defaultSelected?: boolean;
+    /** Whether the checkbox is disabled. */
+    isDisabled?: boolean;
+    /** Whether the checkbox is read-only. */
+    isReadOnly?: boolean;
+    /** Whether the checkbox is invalid. */
+    isInvalid?: boolean;
+    /** Whether the checkbox is loading. */
+    isLoading?: boolean;
+}
+export type CheckboxFieldProps<TFieldValues extends FieldValues = FieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>> = FieldProps<TFieldValues, TName>;
+type CheckboxFieldComponent = (<TSchema extends Schema>(props: CheckboxFieldProps<ZodInfer<TSchema>> & {
+    ref?: ForwardedRef<HTMLLabelElement>;
+}) => JSX.Element) & {
+    displayName?: string;
+};
+/**
+ * The `CheckboxField` component enhances the base Checkbox with form integration capabilities,
+ * making it easy to handle boolean values in forms with proper validation and feedback.
+ *
+ * It provides form validation, helper text, and error feedback while maintaining the same
+ * API as the base Checkbox component. The component automatically integrates with Unity's
+ * form context and handles value updates through the form's state management.
+ * @param {CheckboxFieldProps} props - Props for the CheckboxField component
+ * @see {@link CheckboxFieldProps} for all available props
+ * @example
+ * ```tsx
+ * import { useUnityForm, CheckboxField } from '@payfit/unity-components'
+ * import * as z from 'zod'
+ *
+ * function Example() {
+ *   const schema = z.object({
+ *     acceptTerms: z.boolean().refine(Boolean, {
+ *       message: 'You must accept the terms',
+ *     }),
+ *   })
+ *
+ *   const { Form } = useUnityForm(schema)
+ *
+ *   return (
+ *     <Form action={handleSubmit}>
+ *       <CheckboxField<typeof schema>
+ *         name="acceptTerms"
+ *         helperText="Please read our terms carefully"
+ *       >
+ *         Accept terms and conditions
+ *       </CheckboxField>
+ *     </Form>
+ *   )
+ * }
+ * ```
+ * @remarks
+ * [API](/?path=/docs/forms-checkboxfield--docs) • [Demo](/?path=/story/forms-checkboxfield--primary)
+ * @note The schema type parameter is needed to ensure type safety with the form's
+ schema.
+ * If you omit it, the `name` prop will not be type-safe.
+ */
+declare const CheckboxField: CheckboxFieldComponent;
+export { CheckboxField };

package/dist/esm/components/checkbox-field/CheckboxField.js

@@ -0,0 +1,61 @@
+import { jsxs as h, jsx as t } from "react/jsx-runtime";
+import { forwardRef as b } from "react";
+import { useFormContext as k } from "react-hook-form";
+import { Checkbox as C } from "../checkbox/Checkbox.js";
+import { FormField as y } from "../form-field/FormField.js";
+import { FormControl as j } from "../form-field/parts/FormControl.js";
+import { FormFeedbackText as w } from "../form-field/parts/FormFeedbackText.js";
+function N({
+  name: o,
+  children: e,
+  defaultSelected: r,
+  helperText: m,
+  contextualLink: c,
+  isRequired: i,
+  isInvalid: l,
+  isLoading: n,
+  isDisabled: f,
+  isReadOnly: s,
+  requiredVariant: p,
+  ...x
+}, d) {
+  const { control: F, watch: a } = k(), u = a(o);
+  return /* @__PURE__ */ h(
+    y,
+    {
+      control: F,
+      name: o,
+      className: "uy-flex uy-flex-col uy-gap-100",
+      ...{
+        isRequired: i,
+        isInvalid: l,
+        isLoading: n,
+        isDisabled: f,
+        isReadOnly: s
+      },
+      children: [
+        /* @__PURE__ */ t(j, { children: /* @__PURE__ */ t(
+          C,
+          {
+            ref: d,
+            defaultSelected: r,
+            isSelected: u,
+            requiredVariant: p,
+            helperText: m,
+            feedbackText: /* @__PURE__ */ t(w, {}),
+            ...x,
+            children: e
+          }
+        ) }),
+        c
+      ]
+    }
+  );
+}
+const P = b(function(e, r) {
+  return N(e, r);
+});
+P.displayName = "CheckboxField";
+export {
+  P as CheckboxField
+};

package/dist/esm/components/checkbox-group/CheckboxGroup.d.ts

@@ -0,0 +1,65 @@
+import { ReactNode } from 'react';
+import { CheckboxGroupProps as AriaCheckboxGroupProps } from 'react-aria-components';
+import { VariantProps } from 'tailwind-variants';
+export declare const checkboxGroup: import('tailwind-variants').TVReturnType<{} | {} | {}, undefined, "uy-flex uy-flex-col uy-gap-50", import('tailwind-variants/dist/config.js').TVConfig<unknown, {} | {}>, {} | {}, undefined, import('tailwind-variants').TVReturnType<unknown, undefined, "uy-flex uy-flex-col uy-gap-50", import('tailwind-variants/dist/config.js').TVConfig<unknown, {} | {}>, unknown, unknown, undefined>>;
+export interface CheckboxGroupProps extends VariantProps<typeof checkboxGroup>, Omit<AriaCheckboxGroupProps, 'className' | 'class'> {
+    /** The label for the checkbox group. */
+    label: string;
+    /** Helper text to display below the checkbox group. */
+    helperText?: ReactNode;
+    /** Feedback text to display below the checkbox group. */
+    feedbackText?: ReactNode;
+    /** The default selected values of the checkbox group. */
+    defaultValue?: string[];
+    /** The current selected values of the checkbox group (controlled). */
+    value?: string[];
+    /** Whether the checkbox group is disabled. */
+    isDisabled?: boolean;
+    /** Whether the checkbox group is read-only. */
+    isReadOnly?: boolean;
+    /** Whether the checkbox group is invalid. */
+    isInvalid?: boolean;
+    /** Whether the checkbox group is required. */
+    isRequired?: boolean;
+    /** Whether the checkbox group is loading. */
+    isLoading?: boolean;
+    /** The variant of the required indicator. */
+    requiredVariant?: 'required' | 'optional';
+    /** Callback when the selection changes. */
+    onChange?: (value: string[]) => void;
+    /**
+     * Handler called when the checkbox receives focus.
+     */
+    onFocus?: AriaCheckboxGroupProps['onFocus'];
+    /**
+     * Handler called when the checkbox loses focus.
+     */
+    onBlur?: AriaCheckboxGroupProps['onBlur'];
+    /**
+     * Handler that is called when the element's focus status changes.
+     * @param isFocused
+     */
+    onFocusChange?: (isFocused: boolean) => void;
+    children: ReactNode;
+}
+/**
+ * The `CheckboxGroup` component is an accessible group of related checkboxes.
+ * It provides a way to select multiple options from a list of choices.
+ * @param {CheckboxGroupProps} props - The props for the `CheckboxGroup` component
+ * @example
+ * ```tsx
+ * import { CheckboxGroup, Checkbox } from '@payfit/unity-components'
+ *
+ * <CheckboxGroup
+ *   label="Notification preferences"
+ *   helperText="Choose how you want to receive notifications"
+ * >
+ *   <Checkbox value="email">Email notifications</Checkbox>
+ *   <Checkbox value="sms">SMS notifications</Checkbox>
+ *   <Checkbox value="push">Push notifications</Checkbox>
+ * </CheckboxGroup>
+ * ```
+ * @see {@link CheckboxProps} for all available props
+ */
+declare const CheckboxGroup: import('react').ForwardRefExoticComponent<CheckboxGroupProps & import('react').RefAttributes<HTMLDivElement>>;
+export { CheckboxGroup };

package/dist/esm/components/checkbox-group/CheckboxGroup.js

@@ -0,0 +1,73 @@
+import { jsxs as f, jsx as r } from "react/jsx-runtime";
+import { forwardRef as d, isValidElement as x, cloneElement as h } from "react";
+import { CheckboxGroup as g } from "react-aria-components";
+import { tv as b } from "tailwind-variants";
+import { Label as v } from "../label/Label.js";
+import { Text as c } from "../text/Text.js";
+const G = b({
+  base: "uy-flex uy-flex-col uy-gap-50"
+}), C = d(
+  ({
+    label: t,
+    helperText: l,
+    feedbackText: o,
+    isDisabled: e,
+    isReadOnly: n,
+    isInvalid: m,
+    isRequired: s,
+    isLoading: a,
+    children: p,
+    requiredVariant: i,
+    ...u
+  }, y) => /* @__PURE__ */ f(
+    g,
+    {
+      ...{
+        isDisabled: e,
+        isReadOnly: n,
+        isInvalid: m,
+        isRequired: s,
+        isLoading: a
+      },
+      ...u,
+      ref: y,
+      className: G(),
+      children: [
+        t && /* @__PURE__ */ r(v, { isRequired: s, requiredVariant: i, children: t }),
+        l && /* @__PURE__ */ r(
+          c,
+          {
+            variant: "bodySmall",
+            color: "content.neutral.low",
+            slot: "description",
+            children: l
+          }
+        ),
+        /* @__PURE__ */ r(
+          "div",
+          {
+            className: "uy-mt-100 uy-flex uy-flex-col uy-gap-150 uy-py-25",
+            "data-dd-privacy": "mask",
+            children: p
+          }
+        ),
+        m && (typeof o == "string" ? /* @__PURE__ */ r(
+          c,
+          {
+            variant: "bodySmallStrong",
+            color: "content.form.invalid",
+            slot: "errorMessage",
+            children: o
+          }
+        ) : x(o) && h(o, {
+          slot: "errorMessage"
+        }))
+      ]
+    }
+  )
+);
+C.displayName = "CheckboxGroup";
+export {
+  C as CheckboxGroup,
+  G as checkboxGroup
+};

package/dist/esm/components/checkbox-group-field/CheckboxGroupField.d.ts

@@ -0,0 +1,79 @@
+import { ForwardedRef, JSX, PropsWithChildren, ReactNode } from 'react';
+import { FieldPath, FieldValues } from 'react-hook-form';
+import { infer as ZodInfer } from 'zod';
+import { Schema } from '../../hooks/use-form.types.js';
+import { CheckboxGroupProps } from '../checkbox-group/CheckboxGroup.js';
+import { LabelProps } from '../label/Label.js';
+interface FieldProps<TFieldValues extends FieldValues = FieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>> extends PropsWithChildren<Pick<LabelProps, 'isRequired' | 'requiredVariant'>> {
+    /** The name of the field, which should match the form schema. */
+    name: TName;
+    /** The label for the checkbox group. */
+    label: string;
+    /** Helper text to display below the checkbox group. */
+    helperText?: ReactNode;
+    /** A contextual link to display below the checkbox group. */
+    contextualLink?: ReactNode;
+    /** The default selected values of the checkbox group. */
+    defaultValue?: string[];
+    /** Whether the checkbox group is disabled. */
+    isDisabled?: boolean;
+    /** Whether the checkbox group is read-only. */
+    isReadOnly?: boolean;
+    /** Whether the checkbox group is invalid. */
+    isInvalid?: boolean;
+    /** Whether the checkbox group is loading. */
+    isLoading?: boolean;
+    /** Callback when the selection changes. */
+    onChange?: (value: string[]) => void;
+    /**
+     * Handler called when the checkbox receives focus.
+     */
+    onFocus?: CheckboxGroupProps['onFocus'];
+    /**
+     * Handler called when the checkbox loses focus.
+     */
+    onBlur?: CheckboxGroupProps['onBlur'];
+    /**
+     * Handler that is called when the element's focus status changes.
+     * @param isFocused
+     */
+    onFocusChange?: (isFocused: boolean) => void;
+}
+export type CheckboxGroupFieldProps<TFieldValues extends FieldValues = FieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>> = FieldProps<TFieldValues, TName>;
+type CheckboxGroupFieldComponent = (<TSchema extends Schema>(props: CheckboxGroupFieldProps<ZodInfer<TSchema>> & {
+    ref?: ForwardedRef<HTMLDivElement>;
+}) => JSX.Element) & {
+    displayName?: string;
+};
+/**
+ * The `CheckboxGroupField` component renders a group of related checkboxes that can be used in forms.
+ * It integrates with the `Form` component automatically and provides form validation, helper text,
+ * and error feedback.
+ * @example
+ * ```tsx
+ * const schema = z.object({
+ *   preferences: z.array(z.string())
+ * })
+ *
+ * function MyForm() {
+ *   const { Form } = useUnityForm(schema)
+ *
+ *   return (
+ *     <Form action={handleSubmit}>
+ *       <CheckboxGroupField<typeof schema>
+ *         name="preferences"
+ *         label="Select your preferences"
+ *         helperText="Choose all that apply"
+ *       >
+ *         <Checkbox value="email">Email notifications</Checkbox>
+ *         <Checkbox value="sms">SMS notifications</Checkbox>
+ *       </CheckboxGroupField>
+ *     </Form>
+ *   )
+ * }
+ * ```
+ * @note The schema type parameter is needed to ensure type safety with the form's schema.
+ * If you omit it, the `name` prop will not be type-safe.
+ */
+declare const CheckboxGroupField: CheckboxGroupFieldComponent;
+export { CheckboxGroupField };

package/dist/esm/components/checkbox-group-field/CheckboxGroupField.js

@@ -0,0 +1,54 @@
+import { jsxs as k, jsx as t } from "react/jsx-runtime";
+import { forwardRef as C } from "react";
+import { useFormContext as a } from "react-hook-form";
+import { CheckboxGroup as G } from "../checkbox-group/CheckboxGroup.js";
+import { FormField as j } from "../form-field/FormField.js";
+import { FormControl as w } from "../form-field/parts/FormControl.js";
+import { FormFeedbackText as y } from "../form-field/parts/FormFeedbackText.js";
+function P({
+  name: o,
+  label: r,
+  defaultValue: e,
+  helperText: m,
+  contextualLink: c,
+  isRequired: i,
+  isInvalid: n,
+  isLoading: p,
+  isDisabled: f,
+  isReadOnly: l,
+  requiredVariant: d,
+  children: s,
+  ...u
+}, x) {
+  const { control: F, watch: h } = a(), b = h(o);
+  return /* @__PURE__ */ k(j, { control: F, name: o, ...{
+    isRequired: i,
+    isInvalid: n,
+    isLoading: p,
+    isDisabled: f,
+    isReadOnly: l
+  }, children: [
+    /* @__PURE__ */ t(w, { children: /* @__PURE__ */ t(
+      G,
+      {
+        ref: x,
+        label: r,
+        defaultValue: e,
+        value: b,
+        helperText: m,
+        feedbackText: /* @__PURE__ */ t(y, {}),
+        requiredVariant: d,
+        ...u,
+        children: s
+      }
+    ) }),
+    c
+  ] });
+}
+const T = C(function(r, e) {
+  return P(r, e);
+});
+T.displayName = "CheckboxGroupField";
+export {
+  T as CheckboxGroupField
+};

package/dist/esm/components/collapsible/Collapsible.d.ts

@@ -0,0 +1,33 @@
+import { ReactNode } from 'react';
+import { DisclosureProps } from 'react-aria-components';
+export interface CollapsibleProps extends Omit<DisclosureProps, 'isDisabled' | 'defaultExpanded' | 'className'> {
+    /**
+     * The content of the collapsible component.
+     * Typically includes a CollapsibleTitle and CollapsibleContent.
+     */
+    children: ReactNode;
+    /**
+     * Controls whether the collapsible is expanded by default.
+     * @default false
+     */
+    isExpanded?: boolean;
+}
+/**
+ * @description
+ * The Collapsible component provides an expandable/collapsible container that can show or hide content.
+ * It's typically used to organize information in a space-efficient way, allowing users to focus on relevant content.
+ * @example
+ * ```tsx
+ * <Collapsible>
+ *   <CollapsibleTitle>Section Title</CollapsibleTitle>
+ *   <CollapsibleContent>
+ *     Content that can be shown or hidden
+ *   </CollapsibleContent>
+ * </Collapsible>
+ * ```
+ * @component
+ * @see {@link CollapsibleTitle} - The clickable title component that toggles the expanded state
+ * @see {@link CollapsibleContent} - The content component that is shown/hidden based on the expanded state
+ */
+declare const Collapsible: import('react').ForwardRefExoticComponent<CollapsibleProps & import('react').RefAttributes<HTMLDivElement>>;
+export { Collapsible };

package/dist/esm/components/collapsible/Collapsible.js

@@ -0,0 +1,23 @@
+import { jsx as u } from "react/jsx-runtime";
+import { forwardRef as s } from "react";
+import { Disclosure as r } from "react-aria-components";
+import { tv as e } from "tailwind-variants";
+const f = e({
+  base: "uy-w-full uy-rounded-50 focus-within:uy-outline-2 focus-within:uy-outline focus-within:uy-outline-offset-2 focus-within:uy-outline-utility-focus-ring"
+}), a = s(
+  ({ children: o, isExpanded: i, ...l }, t) => /* @__PURE__ */ u(
+    r,
+    {
+      "data-dd-privacy": "allow",
+      ...l,
+      className: f(),
+      ref: t,
+      isExpanded: i,
+      children: o
+    }
+  )
+);
+a.displayName = "Collapsible";
+export {
+  a as Collapsible
+};

package/dist/esm/components/collapsible/parts/CollapsibleContent.d.ts

@@ -0,0 +1,36 @@
+import { ReactNode } from 'react';
+/**
+ * @description
+ * The CollapsibleContent component renders the content that is shown or hidden
+ * when the parent Collapsible component is expanded or collapsed.
+ */
+export interface CollapsibleContentProps {
+    /**
+     * The content to be shown or hidden.
+     */
+    children: ReactNode;
+}
+/**
+ * The content component for a Collapsible.
+ *
+ * This component renders a DisclosurePanel that shows or hides its content
+ * based on the expanded state of the parent Collapsible component.
+ * @example
+ * ```tsx
+ * <Collapsible>
+ *   <CollapsibleTitle>Section Title</CollapsibleTitle>
+ *   <CollapsibleContent>
+ *     This content will be shown or hidden based on the expanded state.
+ *   </CollapsibleContent>
+ * </Collapsible>
+ * ```
+ * @component
+ * @see {@link Collapsible} - The parent component
+ * @see {@link CollapsibleTitle} - The title component that toggles the expanded state
+ * @param {CollapsibleContentProps} props - The component props
+ * @param {ReactNode} props.children - The content to be shown or hidden
+ * @param {React.Ref<HTMLDivElement>} ref - A ref to the underlying HTML div element
+ * @returns {JSX.Element} The rendered CollapsibleContent component
+ */
+declare const CollapsibleContent: import('react').ForwardRefExoticComponent<CollapsibleContentProps & import('react').RefAttributes<HTMLDivElement>>;
+export { CollapsibleContent };

package/dist/esm/components/collapsible/parts/CollapsibleContent.js

@@ -0,0 +1,10 @@
+import { jsx as o } from "react/jsx-runtime";
+import { forwardRef as e } from "react";
+import { DisclosurePanel as t } from "react-aria-components";
+const i = e(
+  ({ children: r, ...l }, a) => /* @__PURE__ */ o(t, { ref: a, "data-dd-privacy": "allow", ...l, children: /* @__PURE__ */ o("div", { className: "uy-ml-400 uy-typography-body", children: r }) })
+);
+i.displayName = "CollapsibleContent";
+export {
+  i as CollapsibleContent
+};

package/dist/esm/components/collapsible/parts/CollapsibleTitle.d.ts

@@ -0,0 +1,39 @@
+import { ReactNode } from 'react';
+/**
+ * @description
+ * The CollapsibleTitle component renders the clickable header of a Collapsible component.
+ * It displays a title with an icon that rotates based on the expanded state.
+ * @example
+ * ```tsx
+ * <Collapsible>
+ *   <CollapsibleTitle>Section Title</CollapsibleTitle>
+ *   <CollapsibleContent>Content</CollapsibleContent>
+ * </Collapsible>
+ * ```
+ * @component
+ * @see {@link Collapsible} - The parent component
+ * @see {@link CollapsibleContent} - The content component that is shown/hidden
+ */
+interface CollapsibleTitleProps {
+    /**
+     * The content of the collapsible title.
+     */
+    children: ReactNode;
+    /**
+     * Optional content to display after the title.
+     */
+    suffix?: ReactNode;
+}
+/**
+ * The title component for a Collapsible.
+ *
+ * This component renders a heading with a button that toggles the expanded state of the parent Collapsible.
+ * It displays an icon that rotates based on the expanded state to indicate the current state.
+ * @param {CollapsibleTitleProps} props - The component props
+ * @param {ReactNode} props.children - The content of the title
+ * @param {ReactNode} [props.suffix] - Optional content to display after the title
+ * @param {React.Ref<HTMLDivElement>} ref - A ref to the underlying HTML div element
+ * @returns {JSX.Element} The rendered CollapsibleTitle component
+ */
+declare const CollapsibleTitle: import('react').ForwardRefExoticComponent<CollapsibleTitleProps & import('react').RefAttributes<HTMLDivElement>>;
+export { CollapsibleTitle };

package/dist/esm/components/collapsible/parts/CollapsibleTitle.js

@@ -0,0 +1,51 @@
+import { jsx as e, jsxs as l } from "react/jsx-runtime";
+import { forwardRef as m, useContext as p } from "react";
+import { DisclosureStateContext as y, Heading as f, Button as x } from "react-aria-components";
+import { tv as b } from "tailwind-variants";
+import { Icon as v } from "../../icon/Icon.js";
+import { Text as r } from "../../text/Text.js";
+const h = b({
+  slots: {
+    base: "uy-w-full",
+    button: "uy-flex uy-pb-100 uy-pt-100 uy-w-full hover:uy-text-content-neutral-hover focus-visible:uy-outline-none",
+    title: "uy-flex uy-grow uy-text-left uy-items-center",
+    icon: "uy-mr-100"
+  },
+  variants: {
+    isExpanded: {
+      true: {
+        icon: "uy-rotate-180"
+      },
+      false: {
+        icon: "uy-rotate-0"
+      }
+    }
+  },
+  defaultVariants: {
+    isExpanded: !1
+  }
+}), w = m(
+  ({ children: a, suffix: o, ...n }, i) => {
+    const t = p(y), { base: s, button: u, title: c, icon: d } = h({
+      isExpanded: t == null ? void 0 : t.isExpanded
+    });
+    return /* @__PURE__ */ e(f, { "data-dd-privacy": "allow", ...n, ref: i, className: s(), children: /* @__PURE__ */ l(x, { className: u(), slot: "trigger", children: [
+      /* @__PURE__ */ l(r, { variant: "bodyStrong", className: c(), children: [
+        /* @__PURE__ */ e(
+          v,
+          {
+            src: "CaretDownOutlined",
+            className: d(),
+            role: "presentation"
+          }
+        ),
+        a
+      ] }),
+      o ? /* @__PURE__ */ e(r, { variant: "body", children: o }) : null
+    ] }) });
+  }
+);
+w.displayName = "CollapsibleTitle";
+export {
+  w as CollapsibleTitle
+};