compote-ui/dist/components/field/types.d.ts

An opinionated UI component library for Svelte, built on top of [Ark UI](https://ark-ui.com) with additional components and features not available in the core Ark UI library.

import type { Snippet } from 'svelte';
import type { FieldRootBaseProps, FieldLabelBaseProps, FieldInputProps as ArkFieldInputProps, FieldTextareaProps as ArkFieldTextareaProps, FieldHelperTextBaseProps, FieldErrorTextBaseProps } from '@ark-ui/svelte/field';
import type { ClassValue } from 'svelte/elements';
export interface FormAdapter {
    invalid(field: string): boolean;
    isRequired(field: string): boolean;
    errors: Record<string, string[]>;
}
export interface FieldRootProps extends FieldRootBaseProps {
    class?: ClassValue;
    form?: FormAdapter;
    field?: string;
    helperText?: string;
    /**
     * Error to render below the control, for validation that does not go through
     * a {@link FormAdapter} (e.g. a SvelteKit remote form's `field.issues()`).
     * Passing it also marks the field invalid unless `invalid` is set explicitly.
     * Ignored when `form` and `field` are given — the adapter wins, as it does
     * for `invalid` and `required`.
     */
    errorText?: string | null;
    /**
     * Whether to drop the spacer that otherwise holds the message line open
     * when there is no error or helper text to show. Defaults to `false`. Set
     * to `true` for a field that never surfaces validation (a toolbar search
     * box, say), so it doesn't reserve height it will never use.
     */
    hideMessageLine?: boolean;
}
export interface FieldLabelProps extends FieldLabelBaseProps {
    class?: ClassValue;
}
export interface FieldInputProps extends ArkFieldInputProps {
    class?: ClassValue;
    startIcon?: Snippet;
    endIcon?: Snippet;
}
export interface FieldTextareaProps extends ArkFieldTextareaProps {
    class?: ClassValue;
}
export interface FieldHelperTextProps extends FieldHelperTextBaseProps {
    class?: ClassValue;
}
export interface FieldErrorTextProps extends FieldErrorTextBaseProps {
    class?: ClassValue;
}