Field Types

The form builder and @osforms/react support 12 field types: text inputs, choices, scale and rating, and display-only statements.

These fields only apply to forms rendered from a schema (the dashboard Builder tab or @osforms/react). A plain HTML form can post any inputs; each input’s name becomes a key in the submission.

Text inputs

text

Single-line text input.

{
  "id": "full_name",
  "type": "text",
  "label": "Full name",
  "required": true,
  "validation": {
    "minLength": 2,
    "maxLength": 100
  }
}

email

Single-line input with email format validation.

{
  "id": "email",
  "type": "email",
  "label": "Email address",
  "required": true
}

tel

Phone number input. No format enforcement: it accepts any string unless you add a pattern.

{
  "id": "phone",
  "type": "tel",
  "label": "Phone number",
  "required": false
}

url

URL input. Validated with the browser’s URL parser, so it needs a scheme (https://example.com, not example.com).

{
  "id": "website",
  "type": "url",
  "label": "Website URL",
  "required": false,
  "placeholder": "https://example.com"
}

number

Numeric input with min / max validation. The value is submitted as a string (for example "42").

{
  "id": "age",
  "type": "number",
  "label": "Age",
  "required": false,
  "validation": { "min": 18, "max": 120 }
}

textarea

Multi-line text input. Defaults to 4 rows in classic mode and 3 in conversational mode.

{
  "id": "message",
  "type": "textarea",
  "label": "Message",
  "required": false,
  "config": { "rows": 6 }
}

Choice

select

Dropdown single-select (a native <select>). Advances immediately on selection in conversational mode.

{
  "id": "country",
  "type": "select",
  "label": "Country",
  "required": true,
  "options": [
    { "id": "us", "label": "United States", "value": "US" },
    { "id": "gb", "label": "United Kingdom", "value": "GB" }
  ]
}

radio

Single choice from a visible list of options. Auto-advances in conversational mode.

{
  "id": "plan",
  "type": "radio",
  "label": "Which plan are you on?",
  "required": true,
  "options": [
    { "id": "free", "label": "Free", "value": "free" },
    { "id": "pro", "label": "Pro", "value": "pro" }
  ]
}

Options are listed vertically.

checkbox

Multi-select option list. Submitted as an array of selected values.

{
  "id": "interests",
  "type": "checkbox",
  "label": "What are you interested in?",
  "required": false,
  "options": [
    { "id": "a", "label": "API integrations", "value": "api" },
    { "id": "b", "label": "React SDK", "value": "sdk" },
    { "id": "c", "label": "Webhooks", "value": "webhooks" }
  ]
}

Scale and rating

rating

Star rating, 1 to 5 by default. Auto-advances in conversational mode.

{
  "id": "satisfaction",
  "type": "rating",
  "label": "How satisfied are you?",
  "required": true,
  "config": { "maxRating": 5 }
}

scale

NPS-style numeric scale, 1 to 10 by default. Auto-advances in conversational mode.

{
  "id": "nps",
  "type": "scale",
  "label": "How likely are you to recommend us?",
  "required": true,
  "config": {
    "scaleMin": 0,
    "scaleMax": 10,
    "scaleLowLabel": "Not likely",
    "scaleHighLabel": "Very likely"
  }
}

Display

statement

Display-only text. No input is collected. Use it for instructions or notices. Only the description is shown; label is used in the builder to identify the block.

{
  "id": "intro",
  "type": "statement",
  "label": "Privacy notice",
  "required": false,
  "description": "Please read our privacy policy before submitting."
}

Not supported yet

The schema type also lists date, file, and divider. They aren’t in the builder and @osforms/react doesn’t render them, so don’t use them yet. File uploads aren’t stored by the submission endpoint either.

Common field properties

Property	Type	Required	Description
`id`	`string`	Yes	Unique within the form. Used as the key in submissions.
`type`	`FieldType`	Yes	One of the types above.
`label`	`string`	Yes	Question text shown to the user.
`required`	`boolean`	Yes (TypeScript)	Whether an answer is needed. Treated as `false` if omitted at runtime.
`description`	`string`	No	Helper text displayed below the label.
`placeholder`	`string`	No	Input placeholder text.
`options`	`FieldOption[]`	For choice types	Array of `{ id, label, value }`.
`validation`	`FieldValidation`	No	See below.
`conditionalLogic`	`ConditionalLogic`	No	Show/hide rules. See Conditional Logic.
`config`	`FieldConfig`	No	Type-specific config.

Validation reference

Property	Description
`minLength`	Minimum character count
`maxLength`	Maximum character count
`min`	Minimum numeric value
`max`	Maximum numeric value
`pattern`	Regex string the value must match
`patternError`	Custom error message on pattern mismatch

minLength/maxLength suit text inputs and min/max suit number, scale and rating, but the validator applies whichever rules you set to any field.

Getting Started

Core Concepts

Integrations

Text inputs

text

email

tel

url

number

textarea

Choice

select

radio

checkbox

Scale and rating

rating

scale

Display

statement

Not supported yet

Common field properties

Validation reference

​Text inputs

​text

​email

​tel

​url

​number

​textarea

​Choice

​select

​radio

​checkbox

​Scale and rating

​rating

​scale

​Display

​statement

​Not supported yet

​Common field properties

​Validation reference

Text inputs

text

email

tel

url

number

textarea

Choice

select

radio

checkbox

Scale and rating

rating

scale

Display

statement

Not supported yet

Common field properties

Validation reference