@hirobius/design-system 0.8.1

package/dist/types/src/app/lib/navLevels.d.ts

@@ -0,0 +1,4 @@
+export type NavLevel = 'root' | 'section' | 'nested' | 'deep';
+export declare function getNavLevelInset(level: NavLevel): string;
+export declare function getNavLevelLeadingPadding(level: NavLevel): string;
+export declare function getNextNavLevel(level: NavLevel): NavLevel;

package/dist/types/src/app/pages/hds/HdsSystemDocLayout.d.ts

@@ -0,0 +1,7 @@
+import type { ReactNode } from 'react';
+import { type DocLayoutContentMaxWidth } from '../../layouts/DocLayout';
+/** @public */
+export declare function HdsSystemDocLayout({ contentSlot, contentMaxWidth, }: {
+    contentSlot: ReactNode;
+    contentMaxWidth?: DocLayoutContentMaxWidth;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/types/src/form/hds-form.d.ts

@@ -0,0 +1,61 @@
+import * as React from 'react';
+import { type UseFormReturn, type FieldValues, type FieldPath } from 'react-hook-form';
+/** @public */
+export interface HdsFormProps<TFieldValues extends FieldValues> extends Omit<React.FormHTMLAttributes<HTMLFormElement>, 'onSubmit'> {
+    /** The form object returned by `useHdsForm`. */
+    form: UseFormReturn<TFieldValues>;
+    /** Called with the parsed, validated values once the schema passes. */
+    onSubmit: (values: TFieldValues) => void | Promise<void>;
+    children: React.ReactNode;
+}
+/**
+ * Wraps the presentational `Form` in RHF's `FormProvider` and routes submission
+ * through `handleSubmit` so `onSubmit` only fires with schema-valid values.
+ * @public
+ */
+export declare function HdsForm<TFieldValues extends FieldValues>({ form, onSubmit, children, ...formProps }: HdsFormProps<TFieldValues>): import("react/jsx-runtime").JSX.Element;
+/**
+ * Props handed to `HdsFormField`'s render function — spread them onto your
+ * control. They combine RHF's field binding (`name`/`value`/`onChange`/`onBlur`/
+ * `ref`) with HDS's a11y wiring (`id`/`aria-invalid`/`aria-describedby`).
+ * @public
+ */
+export interface HdsFieldRenderProps {
+    name: string;
+    value: unknown;
+    onChange: (...args: unknown[]) => void;
+    onBlur: (...args: unknown[]) => void;
+    ref: React.Ref<unknown>;
+    id: string;
+    required?: boolean;
+    'aria-invalid'?: boolean;
+    'aria-describedby'?: string;
+}
+/** @public */
+export interface HdsFormFieldProps<TFieldValues extends FieldValues = FieldValues> {
+    /** Field name — a typed path into the form's values. */
+    name: FieldPath<TFieldValues>;
+    /** Field label, associated to the control via htmlFor/id. */
+    label: string;
+    /** Render the control, spreading the supplied props (binding + a11y) onto it. */
+    children: (props: HdsFieldRenderProps) => React.ReactElement;
+    /** Helper text below the control; linked via aria-describedby. */
+    description?: string;
+    /** Adds the required marker + sets `required` on the control. */
+    required?: boolean;
+    className?: string;
+}
+/**
+ * Binds a control to RHF by `name` and renders it inside the presentational
+ * field markup. The control is supplied via a render function so RHF's callback
+ * ref attaches directly (no clone). The field's validation error (its `message`
+ * from the Zod schema) is shown through the same label/error/aria markup the
+ * core `FormField` uses.
+ *
+ *   <HdsFormField name="email" label="Email">
+ *     {(props) => <input type="email" className="…" {...props} />}
+ *   </HdsFormField>
+ *
+ * @public
+ */
+export declare function HdsFormField<TFieldValues extends FieldValues = FieldValues>({ name, label, children, description, required, className, }: HdsFormFieldProps<TFieldValues>): import("react/jsx-runtime").JSX.Element;

package/dist/types/src/form/index.d.ts

@@ -0,0 +1,30 @@
+/**
+ * `@hirobius/design-system/form`
+ *
+ * OPTIONAL React Hook Form + Zod adapter for HDS forms. Kept on its own subpath
+ * so the main barrel stays validation-agnostic and zero-dependency — only apps
+ * that import this entry pull in `react-hook-form`, `zod`, and
+ * `@hookform/resolvers` (all declared as optional peer dependencies).
+ *
+ *   import { z } from 'zod';
+ *   import { useHdsForm, HdsForm, HdsFormField } from '@hirobius/design-system/form';
+ *
+ *   const schema = z.object({ email: z.string().email('Enter a valid email') });
+ *
+ *   function SignUp() {
+ *     const form = useHdsForm(schema, { defaultValues: { email: '' } });
+ *     return (
+ *       <HdsForm form={form} onSubmit={(values) => save(values)}>
+ *         <HdsFormField name="email" label="Email">
+ *           {(props) => <input type="email" className="…" {...props} />}
+ *         </HdsFormField>
+ *         <Button type="submit">Save</Button>
+ *       </HdsForm>
+ *     );
+ *   }
+ *
+ * @doc-ignore  subpath barrel, not an HDS component
+ */
+export { useHdsForm } from './use-hds-form';
+export { HdsForm, HdsFormField } from './hds-form';
+export type { HdsFormProps, HdsFormFieldProps, HdsFieldRenderProps } from './hds-form';

package/dist/types/src/form/use-hds-form.d.ts

@@ -0,0 +1,23 @@
+/**
+ * useHdsForm — React Hook Form pre-wired with a Zod resolver.
+ *
+ * Part of the OPTIONAL `@hirobius/design-system/form` subpath. RHF + Zod are
+ * optional peer dependencies, so consumers that never import this subpath pay
+ * nothing for them (the main barrel stays validation-agnostic).
+ *
+ *   const schema = z.object({ email: z.string().email() });
+ *   const form = useHdsForm(schema, { defaultValues: { email: '' } });
+ *
+ * @doc-ignore  adapter for the ./form subpath, not an HDS component
+ */
+import { type UseFormProps, type UseFormReturn, type FieldValues } from 'react-hook-form';
+import type { ZodType } from 'zod';
+/**
+ * Thin wrapper over RHF's `useForm` that pre-wires `zodResolver(schema)` and
+ * defaults validation to `onTouched` (errors surface after a field blurs, not on
+ * every keystroke). The schema's parsed output type drives the form's field
+ * types, so `form.handleSubmit` hands you a fully-typed, validated value object.
+ *
+ * @public
+ */
+export declare function useHdsForm<TFieldValues extends FieldValues>(schema: ZodType<TFieldValues>, options?: Omit<UseFormProps<TFieldValues>, 'resolver'>): UseFormReturn<TFieldValues>;