Skip to main content

FormCardInput

Stentor API Reference

Stentor API Reference / stentor-models/src / FormCardInput

Interface: FormCardInput

Defined in: packages/stentor-models/src/Form/FormField.ts:264

Card display field for showing text and/or images.

Provides a rich card-based display component with optional header, media content, and body text.

Extends​

Properties​

name​

name: string

Defined in: packages/stentor-models/src/Form/FormField.ts:79

Name of the form input, this is not human readable and is used to identify the field.

For example: "SERVICE" or "FULL_NAME"

Inherited from​

FormInput.name

title?​

optional title?: string

Defined in: packages/stentor-models/src/Form/FormField.ts:83

Optional title used to display on the input

Inherited from​

FormInput.title

type​

type: "CARD" | "TEXT" | "DROPDOWN" | "CHECK" | "CHIPS" | "DATE" | "DATERANGE"

Defined in: packages/stentor-models/src/Form/FormField.ts:87

Type of the input

Inherited from​

FormInput.type

shape?​

optional shape?: "ROUND" | "SQUARE"

Defined in: packages/stentor-models/src/Form/FormField.ts:91

Optional, used to shape the input. Not applicable to all inputs.

Inherited from​

FormInput.shape

condition?​

optional condition?: string

Defined in: packages/stentor-models/src/Form/FormField.ts:98

A condition that must be met for the field to be shown.

For example: "issue === 'service_repair'" - issue is a field name in this example

Inherited from​

FormInput.condition

mandatory?​

optional mandatory?: boolean

Defined in: packages/stentor-models/src/Form/FormField.ts:102

Is the field required.

Inherited from​

FormInput.mandatory

mandatoryError?​

optional mandatoryError?: string

Defined in: packages/stentor-models/src/Form/FormField.ts:106

Error message to show when the field is required but not filled out.

Inherited from​

FormInput.mandatoryError

mandatoryGroup?​

optional mandatoryGroup?: string

Defined in: packages/stentor-models/src/Form/FormField.ts:110

Group fields together where one of the fields in the group is required.

Inherited from​

FormInput.mandatoryGroup

style?​

optional style?: object

Defined in: packages/stentor-models/src/Form/FormField.ts:116

React.CSSProperties style object to apply to the field.

For example: {{ width: '300px', height: '150px' }}

Inherited from​

FormInput.style

optional header?: object

Defined in: packages/stentor-models/src/Form/FormField.ts:268

Optional header section with title and subheader

title​

title: string

Main title text for the card header

subheader?​

optional subheader?: string

Optional subtitle or secondary text

media?​

optional media?: object

Defined in: packages/stentor-models/src/Form/FormField.ts:281

Optional media section for displaying images

height?​

optional height?: number

Height of the media in pixels

width?​

optional width?: number

Width of the media in pixels

imageUrl​

imageUrl: string

URL of the image to display

alt?​

optional alt?: string

Alternative text for accessibility

text?​

optional text?: string

Defined in: packages/stentor-models/src/Form/FormField.ts:302

Body text content for the card

variant?​

optional variant?: string

Defined in: packages/stentor-models/src/Form/FormField.ts:306

Visual variant style for the card

color?​

optional color?: string

Defined in: packages/stentor-models/src/Form/FormField.ts:310

Color scheme for the card

align?​

optional align?: string

Defined in: packages/stentor-models/src/Form/FormField.ts:314

Text alignment: "left", "center", "right", or "justify"