Interface UIComponentProps<Params>

interface UIComponentProps {
    b: ObjPathProxy<Static<Params>, Static<Params>>;
    credentialKey: string;
    inputParams: DeepPartial<Static<Params>>;
    setInputParams: Dispatch<SetStateAction<DeepPartial<Static<Params>>>>;
    variables: readonly Variable[];
}

Type Parameters

  • Params extends TObject = TObject

Properties

b credentialKey inputParams setInputParams variables

Properties

b

b: ObjPathProxy<Static<Params>, Static<Params>>

Proxy object used to bind inputParams properties to inputs. Can't be used to access the actual data! The following example binds value of RichTextInput to the inputParams.name param.

Example

<RichTextInput bind={b.name} />

credentialKey

credentialKey: string

Currently selected Credential key.

inputParams

inputParams: DeepPartial<Static<Params>>

Object holding currently set values for inputParams, corresponding to the inputParamsSchema.

setInputParams

setInputParams: Dispatch<SetStateAction<DeepPartial<Static<Params>>>>

Sets values of inputParams. Accepts either object representing the new values, or a callback which receives current values and returns new ones.

variables

variables: readonly Variable[]

Array of currently available Variables from Trigger Payload Schema.