handleInputChange

API / @publicodes/forms / handleInputChange

function handleInputChange<RuleName>(params): FormState<RuleName>

Defined in: form.ts:233

Updates the form state when a user changes an input value.

Type Parameters

Type Parameter	Description
`RuleName` extends `string`	The existing rule names

Parameters

Parameter	Type	Description
`params`	{ `engine`: `Engine`<`RuleName`>; `formState`: `FormState`<`RuleName`>; `id`: `RuleName`; `pageBuilder`: `PageBuilder`<`RuleName`>; `value`: `undefined` \| `string` \| `number` \| `boolean`; }	-
`params.engine`	`Engine`<`RuleName`>	The Publicodes engine instance
`params.formState`	`FormState`<`RuleName`>	The current state of the form
`params.id`	`RuleName`	The rule name identifier of the field being updated
`params.pageBuilder`?	`PageBuilder`<`RuleName`>	Function to split fields into pages
`params.value`	`undefined` \| `string` \| `number` \| `boolean`	The new value for the field

Returns

FormState<RuleName>

A new form state with updated values and potentially new pages

Example

const newState = handleInputChange({
  id: 'usager . age',
  value: 25,
  formState,
  engine
})
// The engine's situation is updated and new pages may be computed