@formisch/solid 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,102 @@
+export * from '@formisch/methods/solid';
+import { Schema, RequiredPath, ValidPath, PartialValues, PathValue, FieldElement, ValidArrayPath, BaseFormStore, SubmitHandler, FormConfig } from '@formisch/core/solid';
+import { JSX } from 'solid-js';
+import * as v from 'valibot';
+
+/**
+ * Value type of the field element props.
+ */
+interface FieldElementProps {
+    readonly name: string;
+    readonly autofocus: boolean;
+    readonly ref: (element: FieldElement) => void;
+    readonly onFocus: JSX.EventHandler<FieldElement, FocusEvent>;
+    readonly onInput: JSX.EventHandler<FieldElement, InputEvent>;
+    readonly onChange: JSX.EventHandler<FieldElement, Event>;
+    readonly onBlur: JSX.EventHandler<FieldElement, FocusEvent>;
+}
+/**
+ * Value type of the field store.
+ */
+interface FieldStore<TSchema extends Schema = Schema, TFieldPath extends RequiredPath = RequiredPath> {
+    readonly path: ValidPath<v.InferInput<TSchema>, TFieldPath>;
+    readonly input: PartialValues<PathValue<v.InferInput<TSchema>, TFieldPath>>;
+    readonly errors: [string, ...string[]] | null;
+    readonly isTouched: boolean;
+    readonly isDirty: boolean;
+    readonly isValid: boolean;
+    readonly props: FieldElementProps;
+}
+/**
+ * Value type of the field array store.
+ */
+interface FieldArrayStore<TSchema extends Schema = Schema, TFieldArrayPath extends RequiredPath = RequiredPath> {
+    readonly path: ValidArrayPath<v.InferInput<TSchema>, TFieldArrayPath>;
+    readonly items: string[];
+    readonly errors: [string, ...string[]] | null;
+    readonly isTouched: boolean;
+    readonly isDirty: boolean;
+    readonly isValid: boolean;
+}
+
+interface FormStore<TSchema extends Schema = Schema> extends BaseFormStore<TSchema> {
+    readonly isSubmitting: boolean;
+    readonly isSubmitted: boolean;
+    readonly isValidating: boolean;
+    readonly isTouched: boolean;
+    readonly isDirty: boolean;
+    readonly isValid: boolean;
+    readonly errors: [string, ...string[]] | null;
+}
+
+/**
+ * Constructs a type that is maybe a getter function.
+ */
+type MaybeGetter<TValue> = TValue | (() => TValue);
+
+/**
+ * Properties of the `Field` component.
+ */
+interface FieldProps<TSchema extends Schema = Schema, TFieldPath extends RequiredPath = RequiredPath> {
+    readonly of: FormStore<TSchema>;
+    readonly path: ValidPath<v.InferInput<TSchema>, TFieldPath>;
+    readonly render: (store: FieldStore<TSchema, TFieldPath>) => JSX.Element;
+}
+/**
+ * Headless form field that provides reactive properties and state.
+ */
+declare function Field<TSchema extends Schema, TFieldPath extends RequiredPath>(props: FieldProps<TSchema, TFieldPath>): JSX.Element;
+
+/**
+ * Properties of the `FieldArray` component.
+ */
+interface FieldArrayProps<TSchema extends Schema = Schema, TFieldArrayPath extends RequiredPath = RequiredPath> {
+    readonly of: FormStore<TSchema>;
+    readonly path: ValidArrayPath<v.InferInput<TSchema>, TFieldArrayPath>;
+    readonly render: (store: FieldArrayStore<TSchema, TFieldArrayPath>) => JSX.Element;
+}
+/**
+ * Headless field array that provides reactive properties and state.
+ */
+declare function FieldArray<TSchema extends Schema, TFieldArrayPath extends RequiredPath>(props: FieldArrayProps<TSchema, TFieldArrayPath>): JSX.Element;
+
+type FormProps<TSchema extends Schema = Schema> = Omit<JSX.FormHTMLAttributes<HTMLFormElement>, 'onSubmit'> & {
+    of: FormStore<TSchema>;
+    children: JSX.Element;
+    onSubmit: SubmitHandler<TSchema>;
+};
+declare function Form<TSchema extends Schema>(props: FormProps<TSchema>): JSX.Element;
+
+declare function createForm<TSchema extends Schema>(config: FormConfig<TSchema>): FormStore<TSchema>;
+
+interface UseFieldConfig<TSchema extends Schema = Schema, TFieldPath extends RequiredPath = RequiredPath> {
+    readonly path: ValidPath<v.InferInput<TSchema>, TFieldPath>;
+}
+declare function useField<TSchema extends Schema, TFieldPath extends RequiredPath>(form: MaybeGetter<FormStore<TSchema>>, config: MaybeGetter<UseFieldConfig<TSchema, TFieldPath>>): FieldStore<TSchema, TFieldPath>;
+
+interface UseFieldArrayConfig<TSchema extends Schema = Schema, TFieldArrayPath extends RequiredPath = RequiredPath> {
+    readonly path: ValidArrayPath<v.InferInput<TSchema>, TFieldArrayPath>;
+}
+declare function useFieldArray<TSchema extends Schema, TFieldArrayPath extends RequiredPath>(form: MaybeGetter<FormStore<TSchema>>, config: MaybeGetter<UseFieldArrayConfig<TSchema, TFieldArrayPath>>): FieldArrayStore<TSchema, TFieldArrayPath>;
+
+export { Field, FieldArray, type FieldArrayProps, type FieldArrayStore, type FieldElementProps, type FieldProps, type FieldStore, Form, type FormProps, type FormStore, type MaybeGetter, type UseFieldArrayConfig, type UseFieldConfig, createForm, useField, useFieldArray };