@soybeanjs/headless 0.16.0 → 0.17.0

package/dist/components/form/core/types.d.ts

@@ -4,154 +4,537 @@ import { ComputedRef, Ref, ShallowRef, WritableComputedRef } from "vue";
 import { StandardSchemaV1 } from "@standard-schema/spec";
 
 //#region src/components/form/core/types.d.ts
+/**
+ * Type information for the infer standard schema input component.
+ */
 type InferStandardSchemaInput<S extends StandardSchemaV1<FormValues, FormValues>> = NonNullable<S['~standard']['types']>['input'];
+/**
+ * Type information for the infer standard schema output component.
+ */
 type InferStandardSchemaOutput<S extends StandardSchemaV1<FormValues, FormValues>> = NonNullable<S['~standard']['types']>['output'];
+/**
+ * Type information for the form validate mode component.
+ */
 type FormValidateMode = 'blur' | 'input' | 'change' | 'submit';
+/**
+ * Type information for the form values component.
+ */
 type FormValues = Record<string, any>;
+/**
+ * Type information for the form errors component.
+ */
 type FormErrors<Values extends FormValues> = { [K in keyof Path<Values>]?: string };
+/**
+ * Type information for the form touched component.
+ */
 type FormTouched<Values extends FormValues> = { [K in keyof Path<Values>]?: boolean };
+/**
+ * Type information for the form field meta component.
+ */
 type FormFieldMeta = {
+  /**
+   * Whether dirty.
+   */
   dirty: boolean;
+  /**
+   * Error.
+   */
   error: string | undefined;
+  /**
+   * Touched.
+   */
   touched: boolean | undefined;
 };
+/**
+ * Type information for the form submit helper component.
+ */
 interface FormSubmitHelper<Values extends FormValues> {
+  /**
+   * Set submitting.
+   */
   setSubmitting: (isSubmitting: boolean) => void;
+  /**
+   * Initial values.
+   */
   readonly initialValues: Values;
 }
+/**
+ * State values for the form core component.
+ */
 interface FormResetState<Values extends FormValues = FormValues> {
+  /**
+   * Values.
+   */
   values: Values;
+  /**
+   * Touched.
+   */
   touched: FormTouched<Values>;
+  /**
+   * Errors.
+   */
   errors: FormErrors<Values>;
+  /**
+   * Submit count.
+   */
   submitCount: number;
 }
-type FormMessage<Values extends FormValues = FormValues, Name extends Path<Values> = Path<Values>> = {
+/**
+ * Type information for the form message component.
+ */
+type FormMessage<Values extends FormValues = FormValues, Name extends Path<Values> = Path<Values>> =
+/**
+ * Type.
+ */
+/**
+ * Type.
+ */
+{
   type: 'SubmitAttempt';
-} | {
+}
+/**
+ * Type.
+ */
+/**
+ * Type.
+ */
+| {
   type: 'SubmitSuccess';
-} | {
+}
+/**
+ * Type.
+ */
+/**
+ * Type.
+ */
+| {
   type: 'SubmitFailure';
-} | {
+}
+/**
+ * Payload.
+ */
+/**
+ * Type.
+ */
+/**
+ * Payload.
+ */
+/**
+ * Type.
+ */
+| {
   type: 'SetValues';
   payload: Values;
-} | {
+}
+/**
+ * Payload.
+ */
+/**
+ * Type.
+ */
+/**
+ * Payload.
+ */
+/**
+ * Type.
+ */
+| {
   type: 'SetFieldValue';
   payload: {
     name: Name;
     value: PathValue<Values, Name>;
   };
 } | {
+  /**
+   * Type.
+   */
   type: 'SetTouched';
+  /**
+   * Payload.
+   */
   payload: {
     name: Name;
     touched?: boolean;
   };
-} | {
+}
+/**
+ * Payload.
+ */
+/**
+ * Type.
+ */
+/**
+ * Payload.
+ */
+/**
+ * Type.
+ */
+| {
   type: 'SetErrors';
   payload: FormErrors<Values>;
 } | {
+  /**
+   * Type.
+   */
   type: 'SetFieldError';
+  /**
+   * Payload.
+   */
   payload: {
     name: Name;
     error: string | undefined;
   };
-} | {
+}
+/**
+ * Whether payload.
+ */
+/**
+ * Type.
+ */
+/**
+ * Whether payload.
+ */
+/**
+ * Type.
+ */
+| {
   type: 'SetIsSubmitting';
   payload: boolean;
-} | {
+}
+/**
+ * Whether payload.
+ */
+/**
+ * Type.
+ */
+/**
+ * Whether payload.
+ */
+/**
+ * Type.
+ */
+| {
   type: 'SetIsValidating';
   payload: boolean;
-} | {
+}
+/**
+ * Payload.
+ */
+/**
+ * Type.
+ */
+/**
+ * Payload.
+ */
+/**
+ * Type.
+ */
+| {
   type: 'ResetForm';
   payload: FormResetState<Values>;
 };
+/**
+ * State values for the form core component.
+ */
 interface FormState<Values extends FormValues> {
+  /**
+   * Values.
+   */
   values: Values;
+  /**
+   * Touched.
+   */
   touched: Ref<FormTouched<Values>>;
+  /**
+   * Errors.
+   */
   errors: Ref<FormErrors<Values>>;
+  /**
+   * Submit count.
+   */
   submitCount: ShallowRef<number>;
+  /**
+   * Whether a submitting.
+   */
   isSubmitting: ShallowRef<boolean>;
+  /**
+   * Whether a validating.
+   */
   isValidating: ShallowRef<boolean>;
 }
+/**
+ * Type information for the use form options component.
+ */
 interface UseFormOptions<S extends StandardSchemaV1<FormValues, FormValues>> {
+  /**
+   * Schema.
+   */
   schema: S;
+  /**
+   * Initial values.
+   */
   initialValues?: InferStandardSchemaInput<S>;
+  /**
+   * Initial errors.
+   */
   initialErrors?: FormErrors<InferStandardSchemaInput<S>>;
+  /**
+   * Initial touched.
+   */
   initialTouched?: FormTouched<InferStandardSchemaInput<S>>;
+  /**
+   * Validate mode.
+   */
   validateMode?: FormValidateMode;
+  /**
+   * Re validate mode.
+   */
   reValidateMode?: FormValidateMode;
+  /**
+   * Whether validate on mounted.
+   */
   validateOnMounted?: boolean;
+  /**
+   * Callback invoked when the submit event fires.
+   */
   onSubmit?: (values: InferStandardSchemaOutput<S>, helper: FormSubmitHelper<InferStandardSchemaOutput<S>>) => Promise<any>;
+  /**
+   * Callback invoked when the invalid event fires.
+   */
   onInvalid?: (errors: FormErrors<InferStandardSchemaOutput<S>>) => void;
 }
+/**
+ * Type information for the form field validator component.
+ */
 type FormFieldValidator<Value> = (value: Value) => MaybePromise<string | undefined>;
+/**
+ * Type information for the form register options component.
+ */
 interface FormRegisterOptions<Value> {
+  /**
+   * Validate.
+   */
   validate?: FormFieldValidator<Value>;
+  /**
+   * Reset.
+   */
   reset?: () => void;
 }
+/**
+ * Type information for the form event handler component.
+ */
 interface FormEventHandler<S = string> {
+  /**
+   * Callback invoked when the blur event fires.
+   */
   onBlur: (event: Event | S, name?: S) => void;
+  /**
+   * Callback invoked when the change event fires.
+   */
   onChange: () => void;
+  /**
+   * Callback invoked when the input event fires.
+   */
   onInput: () => void;
 }
-interface FormSubmitHelper<Values extends FormValues> {
-  setSubmitting: (isSubmitting: boolean) => void;
-  readonly initialValues: Values;
-}
+/**
+ * State values for the form core component.
+ */
 interface FormFieldState<Values extends FormValues, Name extends Path<Values>> extends FormEventHandler<Name> {
+  /**
+   * Name.
+   */
   name: Name;
+  /**
+   * Value associated with the current item.
+   */
   value: PathValue<Values, Name>;
+  /**
+   * Meta.
+   */
   meta: FormFieldMeta;
 }
+/**
+ * State values for the form core component.
+ */
 interface FormFieldArrayState<Values extends FormValues, Name extends Path<Values>> extends FormEventHandler<Name> {
+  /**
+   * Name.
+   */
   name: Name;
+  /**
+   * Value associated with the current item.
+   */
   value: ArrayElement<NonNullable<PathValue<Values, Name>>>;
+  /**
+   * Meta.
+   */
   meta: FormFieldMeta;
 }
+/**
+ * Type information for the use form state return component.
+ */
 interface UseFormStateReturn<Values extends FormValues> {
+  /**
+   * Form state.
+   */
   formState: FormState<Values>;
+  /**
+   * Whether dirty.
+   */
   dirty: ComputedRef<boolean>;
+  /**
+   * Submit helper.
+   */
   submitHelper: FormSubmitHelper<Values>;
+  /**
+   * Set submitting.
+   */
   setSubmitting: (isSubmitting: boolean) => void;
+  /**
+   * Register field.
+   */
   registerField<Name extends Path<Values>>(name: Name, opts?: FormRegisterOptions<PathValue<Values, Name>>): Ref<FormFieldState<Values, Name>>;
+  /**
+   * Register field array.
+   */
   registerFieldArray<Name extends Path<Values>>(name: Name, opts?: FormRegisterOptions<PathValue<Values, Name>>): Ref<FormFieldState<Values, Name>>;
+  /**
+   * Validate field.
+   */
   validateField<Name extends Path<Values>>(name: Name): Promise<string | undefined | void>;
+  /**
+   * Get field value.
+   */
   getFieldValue<Name extends Path<Values>>(name: Name): WritableComputedRef<PathValue<Values, Name>>;
+  /**
+   * Get field meta.
+   */
   getFieldMeta<Name extends Path<Values>>(name: Name): Ref<FormFieldMeta>;
+  /**
+   * Get field error.
+   */
   getFieldError<Name extends Path<Values>>(name: Name): string | undefined;
+  /**
+   * Get field touched.
+   */
   getFieldTouched<Name extends Path<Values>>(name: Name): boolean | undefined;
+  /**
+   * Whether get field dirty.
+   */
   getFieldDirty<Name extends Path<Values>>(name: Name): boolean;
+  /**
+   * Get field state.
+   */
   getFieldState<Name extends Path<Values>>(name: Name): Ref<FormFieldState<Values, Name>>;
+  /**
+   * Set values.
+   */
   setValues(values: Values, shouldValidate?: boolean): Promise<FormErrors<Values>> | Promise<void>;
+  /**
+   * Set errors.
+   */
   setErrors(errors: FormErrors<Values>): void;
+  /**
+   * Set field value.
+   */
   setFieldValue<Name extends Path<Values>>(name: Name, value: PathValue<Values, Name>, shouldValidate?: boolean): Promise<FormErrors<Values>> | Promise<void>;
+  /**
+   * Set field touched.
+   */
   setFieldTouched<Name extends Path<Values>>(name: Name, touched: boolean): void;
+  /**
+   * Set field error.
+   */
   setFieldError<Name extends Path<Values>>(name: Name, error: string | undefined): void;
+  /**
+   * Set field array value.
+   */
   setFieldArrayValue<Name extends Path<Values>, Method extends (...args: any) => any>(name: Name, value: PathValue<Values, Name>, method: Method, args?: Partial<{
     argA: Parameters<Method>[1];
     argB: Parameters<Method>[2];
   }>, shouldSetValue?: boolean): Promise<void> | Promise<FormErrors<Values>>;
+  /**
+   * Validate form.
+   */
   validateForm(values?: Values): Promise<FormErrors<Values>>;
+  /**
+   * Reset form.
+   */
   resetForm(nextState?: FormResetState<Values>): void;
 }
+/**
+ * Context for the form component.
+ */
 interface FormContext<Values extends FormValues> extends Omit<UseFormStateReturn<Values>, 'formState' | 'submitHelper'>, FormState<Values> {
+  /**
+   * Handle submit used by the component context.
+   */
   handleSubmit(event?: Event): void;
+  /**
+   * Handle reset used by the component context.
+   */
   handleReset(event?: Event): void;
+  /**
+   * Use field array used by the component context.
+   */
   useFieldArray<Name extends Path<Values>>(name: Name, opts?: FormRegisterOptions<PathValue<Values, Name>>): Ref<FormFieldArrayStates<Values, Name>>;
+  /**
+   * Use field used by the component context.
+   */
   useField<Name extends Path<Values>>(name: Name, opts?: FormRegisterOptions<PathValue<Values, Name>>): Ref<FormFieldState<Values, Name>>;
 }
+/**
+ * Type information for the use register field array options component.
+ */
 interface UseRegisterFieldArrayOptions<Values extends FormValues> extends Pick<UseFormStateReturn<Values>, 'getFieldState' | 'getFieldValue' | 'setFieldValue' | 'setFieldArrayValue' | 'registerFieldArray'> {}
+/**
+ * Type information for the form field array states component.
+ */
 interface FormFieldArrayStates<Values extends FormValues, Name extends Path<Values>> {
+  /**
+   * Name.
+   */
   name: Name;
+  /**
+   * Fields.
+   */
   fields: readonly FormFieldArrayState<Values, Name>[];
+  /**
+   * Meta.
+   */
   meta: FormFieldMeta;
+  /**
+   * Append.
+   */
   append: (value: ArrayElement<NonNullable<PathValue<Values, Name>>>) => void;
+  /**
+   * Prepend.
+   */
   prepend: (value: ArrayElement<NonNullable<PathValue<Values, Name>>>) => void;
+  /**
+   * Remove.
+   */
   remove: (index?: number) => void;
+  /**
+   * Swap.
+   */
   swap: (indexA: number, indexB: number) => void;
+  /**
+   * Move.
+   */
   move: (from: number, to: number) => void;
+  /**
+   * Insert.
+   */
   insert: (index: number, value: ArrayElement<NonNullable<PathValue<Values, Name>>>) => void;
+  /**
+   * Update.
+   */
   update: (index: number, value: ArrayElement<NonNullable<PathValue<Values, Name>>>) => void;
+  /**
+   * Replace.
+   */
   replace: ($values: ArrayElement<NonNullable<PathValue<Values, Name>>>[]) => void;
 }
 //#endregion

package/dist/components/form/types.d.ts

@@ -3,15 +3,42 @@ import { LabelProps } from "../label/types.js";
 import { ComputedRef, HTMLAttributes } from "vue";
 
 //#region src/components/form/types.d.ts
+/**
+ * Props for the form field component.
+ */
 interface FormFieldProps extends /** @vue-ignore */HTMLAttributes {
+  /**
+   * Error.
+   */
   error?: string;
+  /**
+   * Whether the field is an array.
+   */
   isFieldArray?: boolean;
 }
+/**
+ * Props for the form label component.
+ */
 interface FormLabelProps extends LabelProps {}
+/**
+ * Props for the form control component.
+ */
 interface FormControlProps extends /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the form description component.
+ */
 interface FormDescriptionProps extends /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the form error component.
+ */
 interface FormErrorProps extends /** @vue-ignore */HTMLAttributes {}
+/**
+ * Available UI slots for the form component.
+ */
 type FormFieldUiSlot = 'field' | 'fieldArray' | 'label' | 'control' | 'description' | 'error';
+/**
+ * UI class overrides for the form component.
+ */
 type FormFieldUi = UiClass<FormFieldUiSlot>;
 //#endregion
 export { FormControlProps, FormDescriptionProps, FormErrorProps, FormFieldProps, FormFieldUi, FormFieldUiSlot, FormLabelProps };

package/dist/components/hover-card/hover-card-positioner-impl.js

@@ -1 +1 @@
-import{useDismissableLayer as e}from"../../composables/use-dismissable-layer.js";import{useForwardElement as t}from"../../composables/use-forward-element.js";import{useGraceArea as n}from"../../composables/use-grace-area.js";import"../../composables/index.js";import r from"../popper/popper-positioner.js";import"../popper/index.js";import{useHoverCardRootContext as i}from"./context.js";import{computed as a,createBlock as o,defineComponent as s,mergeProps as c,openBlock as l,renderSlot as u,unref as d,watchPostEffect as f,withCtx as p}from"vue";import{defu as m}from"defu";const h=s({name:`HoverCardPositionerImpl`,__name:`hover-card-positioner-impl`,props:{placement:{},side:{},sideOffset:{},sideFlip:{type:Boolean},align:{},alignOffset:{},alignFlip:{type:Boolean},avoidCollisions:{type:Boolean},collisionBoundary:{},collisionPadding:{},arrowPadding:{},hideShiftedArrow:{type:Boolean},sticky:{},hideWhenDetached:{type:Boolean},positionStrategy:{},updatePositionStrategy:{},disableUpdateOnLayoutShift:{type:Boolean},prioritizePosition:{type:Boolean},reference:{}},emits:[`escapeKeyDown`,`pointerDownOutside`,`focusOutside`],setup(s,{emit:h}){let g=s,_=h,{isPointerInTransitRef:v,onClose:y,onDismiss:b,popupElement:x,triggerElement:S}=i(`HoverCardPositionerImpl`),[C,w]=t();n({triggerElement:S,areaElement:C,onPointerInTransitChange:e=>{v.value=e},onPointerExit:()=>{y()}});let{pointerEvents:T}=e(C,{disableOutsidePointerEvents:!1,onEscapeKeyDown:e=>{_(`escapeKeyDown`,e)},onPointerDownOutside:e=>{_(`pointerDownOutside`,e)},onFocusOutside:e=>{e.preventDefault(),_(`focusOutside`,e)},onDismiss:()=>{b()}}),E=a(()=>m(g,{side:`bottom`,sideOffset:4,align:`center`,avoidCollisions:!0,collisionBoundary:[],collisionPadding:0,arrowPadding:0,sticky:`partial`,hideWhenDetached:!1}));return f(()=>{x.value&&T.value&&(x.value.style.pointerEvents=T.value)}),(e,t)=>(l(),o(d(r),c(E.value,{ref:d(w)}),{default:p(()=>[u(e.$slots,`default`)]),_:3},16))}});export{h as default};
+import{useDismissableLayer as e}from"../../composables/use-dismissable-layer.js";import{useForwardElement as t}from"../../composables/use-forward-element.js";import{useGraceArea as n}from"../../composables/use-grace-area.js";import"../../composables/index.js";import r from"../popper/popper-positioner.js";import"../popper/index.js";import{useHoverCardRootContext as i}from"./context.js";import{computed as a,createBlock as o,defineComponent as s,mergeProps as c,openBlock as l,renderSlot as u,unref as d,watchPostEffect as f,withCtx as p}from"vue";import{defu as m}from"defu";const h=s({name:`HoverCardPositionerImpl`,__name:`hover-card-positioner-impl`,props:{placement:{},side:{},sideOffset:{},sideFlip:{type:Boolean},align:{},alignOffset:{},alignFlip:{type:Boolean},avoidCollisions:{type:Boolean},collisionBoundary:{},collisionPadding:{},arrowPadding:{},hideShiftedArrow:{type:Boolean},sticky:{},hideWhenDetached:{type:Boolean},positionStrategy:{},updatePositionStrategy:{},disableUpdateOnLayoutShift:{type:Boolean},prioritizePosition:{type:Boolean},reference:{}},emits:[`escapeKeyDown`,`pointerDownOutside`,`focusOutside`],setup(s,{emit:h}){let g=s,_=h,{isPointerInTransitRef:v,onClose:y,onDismiss:b,popupElement:x,triggerElement:S}=i(`HoverCardPositionerImpl`),[C,w]=t();n({triggerElement:S,areaElement:C,subAreaAttribute:`data-soybean-hover-card-sub-popup`,onPointerInTransitChange:e=>{v.value=e},onPointerExit:()=>{y()}});let{pointerEvents:T}=e(C,{disableOutsidePointerEvents:!1,onEscapeKeyDown:e=>{_(`escapeKeyDown`,e)},onPointerDownOutside:e=>{_(`pointerDownOutside`,e)},onFocusOutside:e=>{e.preventDefault(),_(`focusOutside`,e)},onDismiss:()=>{b()}}),E=a(()=>m(g,{side:`bottom`,sideOffset:4,align:`center`,avoidCollisions:!0,collisionBoundary:[],collisionPadding:0,arrowPadding:0,sticky:`partial`,hideWhenDetached:!1}));return f(()=>{x.value&&T.value&&(x.value.style.pointerEvents=T.value)}),(e,t)=>(l(),o(d(r),c(E.value,{ref:d(w)}),{default:p(()=>[u(e.$slots,`default`)]),_:3},16))}});export{h as default};

package/dist/components/hover-card/types.d.ts

@@ -4,6 +4,9 @@ import { PortalProps } from "../portal/types.js";
 import { ComputedRef, ShallowRef } from "vue";
 
 //#region src/components/hover-card/types.d.ts
+/**
+ * Props for the hover card root component.
+ */
 interface HoverCardRootProps {
   /** The open state of the hover card when it is initially rendered. Use when you do not need to control its open state. */
   defaultOpen?: boolean;
@@ -14,27 +17,81 @@ interface HoverCardRootProps {
   /** The duration from when the pointer leaves the trigger or popup until the hover card closes. */
   closeDelay?: number;
 }
+/**
+ * Emits for the hover card root component.
+ */
 interface HoverCardRootEmits {
   /** Event handler called when the open state of the hover card changes. */
   'update:open': [value: boolean];
 }
+/**
+ * Props for the hover card positioner impl component.
+ */
 interface HoverCardPositionerImplProps extends PopperPositionerProps {}
+/**
+ * Emits for the hover card positioner impl component.
+ */
 type HoverCardPositionerImplEmits = Pick<DismissableLayerEmits, 'escapeKeyDown' | 'pointerDownOutside' | 'focusOutside'>;
+/**
+ * Props for the hover card positioner component.
+ */
 interface HoverCardPositionerProps extends HoverCardPositionerImplProps, ForceMountProps {}
+/**
+ * Emits for the hover card positioner component.
+ */
 type HoverCardPositionerEmits = HoverCardPositionerImplEmits;
+/**
+ * Props for the hover card popup component.
+ */
 interface HoverCardPopupProps extends PopperPopupProps {}
+/**
+ * Props for the hover card compact component.
+ */
 interface HoverCardCompactProps extends HoverCardRootProps {
+  /**
+   * Placement.
+   */
   placement?: PopperPositionerProps['placement'];
+  /**
+   * Whether to show an arrow.
+   */
   showArrow?: boolean;
+  /**
+   * Props forwarded to the trigger element.
+   */
   triggerProps?: PopperAnchorProps;
+  /**
+   * Props forwarded to the portal element.
+   */
   portalProps?: PortalProps;
+  /**
+   * Props forwarded to the positioner element.
+   */
   positionerProps?: HoverCardPositionerProps;
+  /**
+   * Props forwarded to the popup element.
+   */
   popupProps?: HoverCardPopupProps;
+  /**
+   * Props forwarded to the arrow element.
+   */
   arrowProps?: PopperArrowProps;
 }
+/**
+ * Emits for the hover card compact component.
+ */
 type HoverCardCompactEmits = HoverCardRootEmits & HoverCardPositionerEmits;
+/**
+ * Slots for the hover card compact component.
+ */
 interface HoverCardCompactSlots {
+  /**
+   * Custom content for the default slot.
+   */
   default?: () => any;
+  /**
+   * Custom content for the trigger slot.
+   */
   trigger?: () => any;
 }
 //#endregion