Form / foldkit-mixins-form

FieldsOptions

interface · packages/mixins-form/src/index.ts:582

interface FieldsOptions<Key extends string, Changed> {
  readonly overrides?:
    | {
        readonly [K in Key]?: FieldOverride<Key, Changed, Changed>
      }
    | undefined
  readonly styles?:
    | {
        readonly [K in Key]?: NamedStyle<typeof FieldSlots>
      }
    | undefined
  readonly attrs?:
    | {
        readonly [K in Key]?: FieldAttrs
      }
    | undefined
}

Per-key overrides for FormView.fields. overrides draw through the whole-form view; styles style one key's base field view there. Unknown keys in either are type errors. A custom layout passes its override to field itself, with its own h.

Members

FieldsOptions.overrides

property · packages/mixins-form/src/index.ts:584

readonly overrides?:
  | {
      readonly [K in Key]?: FieldOverride<Key, Changed, Changed>
    }
  | undefined

A key drawn by this instead of the base field view (or its styled one).

FieldsOptions.styles

property · packages/mixins-form/src/index.ts:586

readonly styles?:
  | {
      readonly [K in Key]?: NamedStyle<typeof FieldSlots>
    }
  | undefined

A style around a key's base field view, kept for keys with no override.

FieldsOptions.attrs

property · packages/mixins-form/src/index.ts:595

readonly attrs?:
  | {
      readonly [K in Key]?: FieldAttrs
    }
  | undefined

What one key's element takes beyond the base field view. The text, multiline, and number renderers read them for a base field view, and a per-key override is handed them as its own attrs too, so it decides what to do with them; a bundle-backed kind drawn by bundleRenderer reads none. Passing field draws through the base view directly, skipping both renderers and attrs.