Ligantic
Knowledge Base
Tutorials
Updates
Search Articles
Login
Free Sign Up
Home
Get Started
Tutorials
How-to guides
Reference
Explanation
Spaces
Schemas
Flows
Experiences
Endpoints
SDK and CLI
Browse documentation
Home
Get Started
Spaces
Schemas
Flows
Experiences
Endpoints
SDK and CLI
Docs
/

Input

Type identifier: input Category: Experience Blocks

Description

Interactive data-entry block with component variants for text/date input and optional Flow triggers.

Schema Summary

The Input block has the fields below, plus component-specific fields.

Required core fields:

  • type: "input"
  • input: datumReference

Optional core fields:

  • color
  • variant: "soft"
  • lookupFilter
  • states

Component-specific fields are discriminated by component.

Component Variants

Component

Variant-specific fields

TextField

placeholder?, flowTriggerOnSubmit?, clearOnSubmit?

TextArea

placeholder?, flowTriggerOnSubmit?, clearOnSubmit?

DateField

no additional fields

InlineCalendar

min?, max?, default?, firstDayOfWeek? (0-6), activeColor?, activeBorderRadius?, flowTriggerOnChange?

Not set (omitted)

placeholder?, flowTriggerOnSubmit?, clearOnSubmit?

Properties

Property

Type

Required

Notes

id

string

Yes

Shared block identifier.

type

"input"

Yes

Block discriminator.

input

datumReference

Yes

Bound datum target: an entity context, or a For Each item that is a Record (see Editable Rows).

component

"TextField" | "TextArea" | "DateField" | "InlineCalendar"

No

Variant discriminator.

color

string

No

Input colour override.

variant

"soft"

No

Input style variant.

lookupFilter

filter

No

For an input bound to a relationship field: further limits which Records can be picked. See Lookup Filter.

states

Array of states

No

Optional state-specific overrides.

The Input block also supports the shared style/layout/data props.

Lookup Filter

When input is bound to a relationship field, lookupFilter limits which Records the lookup offers, on top of the field's own lookup filter. Both apply.

Condition values can be literals, page datums (datumReference, e.g. a Region chosen elsewhere on the page), or the bound Record's fields (path, relative to the bound field when it starts with @). Relative paths start from the bound field's place in the datum, so an input bound to lines.0.product reaches the invoice's customer with @^^^.customer.

While a value it reads is empty, the lookup offers no Records and asks for it first, such as Select Customer first, or Select a value first for a page datum.

In Studio, set it under Lookup filter in the Input settings. It is shown when the input is bound to a relationship field.

States

State entries follow the shared state shape and support partial input overrides.

Pseudo states for TextField, TextArea, and InlineCalendar:

  • hover
  • focus
  • disabled
  • readonly

DateField has no pseudo states.

Custom states:

  • InlineCalendar: dateSelected
  • other input components: none

Minimal Valid Example

{
  "id": "input-1",
  "type": "input",
  "input": {
    "type": "datumReference",
    "referenceId": "currentEntity"
  }
}

Related pages

Button
Interactive block that renders Text and Image children and triggers configured actions.
Page not found. It may have moved or may not be published.
Browse documentation