Field
Fields represent controls inside of actions.
Hierarchy
- Field
Indexable
- [ k: string]: any
Fields represent controls inside of actions.
Index
Properties
Properties
name
• name: string
Defined in src/cnd/siren.ts:191
A name describing the control. Field names MUST be unique within the set of fields for an action. The behaviour of clients when parsing a Siren document that violates this constraint is undefined.
Optional title
• title? : undefined | string
Defined in src/cnd/siren.ts:218
Textual annotation of a field. Clients may use this as a label.
Optional type
• type? : "hidden" | "text" | "search" | "tel" | "url" | "email" | "password" | "datetime" | "date" | "month" | "week" | "time" | "datetime-local" | "number" | "range" | "color" | "checkbox" | "radio" | "file"
Defined in src/cnd/siren.ts:195
The input type of the field. This is a subset of the input types specified by HTML5.
Optional value
• value? : string | number | FieldValueObject[]
Defined in src/cnd/siren.ts:222
A value assigned to the field. May be a scalar value or a list of value objects.