ErlangFormDocs v1.0.0
Referensi

Tipe TypeScript

Daftar seluruh tipe ekspor dan pola konfigurasi bertipe.

import { z } from "zod";
import type { FieldConfig, ComponentRegistry } from "erlangform";
const schema = z.object({ profile: z.object({ name: z.string() }) });
type Values = z.infer<typeof schema>;
const config = {
  profile: { name: { label: "Nama" } },
} satisfies FieldConfig<Values>;
const registry = {} satisfies ComponentRegistry<Values>;

Gunakan satisfies untuk memeriksa konfigurasi tanpa menghilangkan inferensi spesifik. Child object dan array diletakkan pada induknya; item mengatur elemen array dan posisi tuple memakai indeks angka.

Ekspor tipeTujuan
FieldConfigKonfigurasi root dengan fallback key nested lama
NestedFieldConfigKonfigurasi child langsung, termasuk key semua cabang union
FieldOptionsMemilih opsi input/container sesuai tipe nilai
InputFieldOptionsOpsi field tunggal
ResolvedFieldOptionsOpsi setelah resolver label/placeholder/description/options
ResolvedInputFieldOptionsOpsi input dengan resolver sudah dievaluasi
ArrayItemTipe elemen array setelah null/undefined dikeluarkan
DeepFieldKeysNama key rekursif untuk kompatibilitas, bukan union dotted path
FieldContextScope object untuk nama key tertentu
FieldValueTipe nilai yang ditemukan berdasarkan nama key
ComponentRegistryPemetaan metadata jenis ke komponen
FieldComponentPropsfield, config, dan state untuk custom input
FieldComponentApiname, state.value/meta, handleChange, handleBlur opsional
ContainerComponentPropsfield/config/state/values dan children opsional
FieldStatevisible, disabled, readOnly, required
SectionConfig / SectionConfigsKonfigurasi satu section / peta section
FormStep / FormWizardOptionsStruktur langkah dan callback navigasi
ServerErrorsRecord string ke string atau readonly string[]
FieldMetaMetadata dari infer

FieldOptions membedakan Date/File sebagai input, array dinamis, tuple, object, dan record. Opsi input seperti label/placeholder tidak otomatis tersedia pada container. Array memiliki item, array, inputType, dan options; tuple memakai indeks posisi.

FieldLayout, Resolver, SelectOption, dan AutoFormProps adalah tipe internal yang tidak diekspor. Untuk opsi select, gunakan bentuk { label: string, value: string }. Lihat API publik untuk komponen dan helper runtime.