Interface StaticComponentOptions<ComponentType, DBSchema>

The options for StaticComponent.

Type parameters

ComponentType: React.ElementType
DBSchema: NamedSchema<string, number, Schema>

Hierarchy

StaticComponentOptions

Index

Properties

Methods

renderWhen

Properties

Component

Component: ComponentType

The component class, function, or tag name to render.

key

key: string

A unique identifier for this component.

props

props: ComponentType extends React.ElementType<infer Props> ? Props : {}

The props to pass to StaticComponentOptions.Component.

Methods

Optional renderWhen

renderWhen(stepValues: {}): boolean

- Defined in src/component-wrapper/StaticComponent.ts:41
A callback to determine when the component should be rendered.

If this is not specified, the component will always be rendered.
```
const renderWhen = values => values["my-radio-buttons"] === "Yes"
```
Parameters
- stepValues: {}
  
  A map of the keys to the current values for all of the components in the currently rendered StepDefinition.
  - [key: string]: ComponentValue<DBSchema, StoreNames<DBSchema["schema"]>> | undefined
Returns boolean

Generated using TypeDoc