Interface IFormRendererRegistry

A registry for rendering fields used in the FormEditor component.

interface IFormRendererRegistry {
    addRenderer: (id: string, renderer: IFormRenderer) => void;
    getRenderer: (id: string) => IFormRenderer;
    renderers: { [id: string]: IFormRenderer };
}

Implemented by

FormRendererRegistry

Index

Properties

addRenderer getRenderer renderers

Properties

addRenderer

addRenderer: (id: string, renderer: IFormRenderer) => void

Adds a renderer for a given property of a given settings plugin.

The id must follow that structure <ISettingRegistry.IPlugin.id>.<propertyName>

Type declaration

- (id: string, renderer: IFormRenderer): void
- Parameters
  - id: string
    Unique ID for the given renderer.
  - renderer: IFormRenderer
    A renderer interfacing IFormRenderer.
  Returns void

getRenderer

getRenderer: (id: string) => IFormRenderer

Returns the component for the given id

Type declaration

- (id: string): IFormRenderer
- Parameters
  - id: string
    The unique id for the component.
  Returns IFormRenderer
  - A component interfacing IFormComponent.

renderers

renderers: { [id: string]: IFormRenderer }

Returns all registered renderers in dictionary form.

Returns

A dictionary that maps an id to a renderer.