Skip to main content

Interface: CustomFormComponent

Custom Form Component.

Hierarchy

Properties

attributes

Readonly attributes: Object

Type declaration

NameTypeDescription
componentstring-
props{ bubble?: (value: string | object) => void ; formValues: string[] }Props will be used for communication with the component.
props.bubble?(value: string | object) => voidThe bubble prop is for communication with the host application. internally, the host application will be listening for this function to be called.
props.formValuesstring[]The solution developer should pass the form field names they will be using as props to the custom component.

components

Optional Readonly components: FormComponent[]

Sub components

Inherited from

FormComponent.components


conditional

Optional Readonly conditional: object

A json-logic conditional that upon evaluation, will show or hide the component.

Other fields in the form will be addressable by name as variables to the conditional.

Example

    { "!!": { "var": "show_something_toggle" } }
```;

**`Link`**

https://jsonlogic.com/

#### Inherited from

[FormComponent](/api/interfaces/FormComponent).[conditional](/api/interfaces/FormComponent#conditional)

___

### defaultValue

• `Optional` `Readonly` **defaultValue**: `string` \| `number` \| `boolean`

The default value of the component

#### Inherited from

[FormComponent](/api/interfaces/FormComponent).[defaultValue](/api/interfaces/FormComponent#defaultvalue)

___

### label

• `Optional` `Readonly` **label**: `string` \| `MessageDescriptor`

The label for the component

#### Inherited from

[FormComponent](/api/interfaces/FormComponent).[label](/api/interfaces/FormComponent#label)

___

### name

• `Readonly` **name**: `string`

The name of the component

#### Inherited from

[FormComponent](/api/interfaces/FormComponent).[name](/api/interfaces/FormComponent#name)

___

### prefix

• `Optional` `Readonly` **prefix**: `string`

Optional markdown prefix.

#### Inherited from

[FormComponent](/api/interfaces/FormComponent).[prefix](/api/interfaces/FormComponent#prefix)

___

### suffix

• `Optional` `Readonly` **suffix**: `string`

Optional markdown suffix.

#### Inherited from

[FormComponent](/api/interfaces/FormComponent).[suffix](/api/interfaces/FormComponent#suffix)

___

### type

• `Readonly` **type**: [`Custom`](/api/enums/FormComponentType#custom)

The type of component (e.g. text, number, select, etc.)

#### Overrides

[FormComponent](/api/interfaces/FormComponent).[type](/api/interfaces/FormComponent#type)

___

### validate

• `Optional` `Readonly` **validate**: [`ValidationSchema`](/api/interfaces/ValidationSchema)

Validations

#### Inherited from

[FormComponent](/api/interfaces/FormComponent).[validate](/api/interfaces/FormComponent#validate)