Skip to main content

foundation-forms

Home > @genesislcap/foundation-forms

foundation-forms package

Classes

Class

Description

Filters

Foundation filters component for automatically generated filters based on json schema obtained from the api, supplied initial data or supplied JSON schema. Allowing customisable filters elements using UI schema and set of custom renderers

Form

Foundation form component for automatically generated forms based on json schema obtained from the api, supplied initial data or supplied JSON schema. Allowing customisable form elements using UI schema and set of custom renderers

Functions

Function

Description

mustMatch(target)

Ensures the value of the current field (the one the validator is on) matches the one of the target field.

Variables

Variable

Description

filtersRenderers

Set of default renderers used by the foundation-filters.

renderers

Set of default renderers used by the foundation-forms.

Type Aliases

Type Alias

Description

ArrayRendererOptions

Configuration options available for array renderer.

CategorizationRendererOptions

Configuration options available for categorization renderer.

ConnectedRenderersOptions

Available configuration options for connected combobox/multiselect.

GroupRendererOptions

Configuration options available for group renderer.

LabelPlacementOptions

Orientation options available for stepper renderer.

LabelPlacementType

Available aligment for labels.

RendererEntry

Defines a renderer configuration in JSON forms. Allows to specify the renderer component, a tester function to determine renderer applicability, and a mapper function to connect JSON forms state to renderer's props.

StandardRendererOptions

Standard configuration options available for all renderers.

StepperOrientationOptions

Orientation options available for stepper renderer.

StepperOrientationType

Available orientation for stepper renderer.

StepperRendererOptions

Configuration options available for stepper renderer.

StringRendererOptions

Configuration options available for string renderer.

UiSchema

The UI schema, which is passed to JSON Forms, describes the general layout of a form and is just a regular JSON object. It describes the form by means of different UI schema elements, which can often be categorized into either Controls or Layouts.

UiSchemaElement

A UiSchemaElement that displays property values in a user interface element.

UiSchemaElementOptions

All configuration options that are available.

UiSchemaElementType

The layouts and control types, which allow you to customize the arrangement of forms.

UiSchemaOptions

All configuration options that are available.