@genesislcap/foundation-forms 14.116.1 → 14.117.0

package/dist/foundation-forms.api.json

@@ -172,6 +172,111 @@
       "name": "",
       "preserveMemberOrder": false,
       "members": [
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-forms!ArrayRendererOptions:type",
+          "docComment": "/**\n * Configuration options available for array renderer.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type ArrayRendererOptions = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    childUiSchema?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "UiSchema",
+              "canonicalReference": "@genesislcap/foundation-forms!UiSchema:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "ArrayRendererOptions",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 4
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-forms!CategorizationRendererOptions:type",
+          "docComment": "/**\n * Configuration options available for categorization renderer.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type CategorizationRendererOptions = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    childElements?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "UiSchema",
+              "canonicalReference": "@genesislcap/foundation-forms!UiSchema:type"
+            },
+            {
+              "kind": "Content",
+              "text": "[];\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "CategorizationRendererOptions",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 4
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-forms!ConnectedRenderersOptions:type",
+          "docComment": "/**\n * Available configuration options for connected combobox/multiselect.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type ConnectedRenderersOptions = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    async?: boolean;\n    allOptionsResourceName?: string;\n    datasourceConfig?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "DatasourceOptions",
+              "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    valueField?: string;\n    labelField?: string;\n    data?: any[];\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "ConnectedRenderersOptions",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 4
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-forms!createExpressions:var",
@@ -917,6 +1022,33 @@
             "endIndex": 2
           }
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-forms!GroupRendererOptions:type",
+          "docComment": "/**\n * Configuration options available for group renderer.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type GroupRendererOptions = "
+            },
+            {
+              "kind": "Reference",
+              "text": "CategorizationRendererOptions",
+              "canonicalReference": "@genesislcap/foundation-forms!CategorizationRendererOptions:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "GroupRendererOptions",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-forms!mustMatch:var",
@@ -1043,10 +1175,80 @@
             "endIndex": 2
           }
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-forms!StandardRendererOptions:type",
+          "docComment": "/**\n * Standard configuration options available for all renderers.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type StandardRendererOptions = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    hidden?: boolean;\n    validateFn?: (data: any, path: string, label: string) => "
+            },
+            {
+              "kind": "Reference",
+              "text": "ErrorObject",
+              "canonicalReference": "ajv!ErrorObject:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "[];\n    i18n?: {\n        [key: string]: any;\n    };\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "StandardRendererOptions",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 4
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-forms!StepperOrientationOptions:type",
+          "docComment": "/**\n * Orientation options available for stepper renderer.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type StepperOrientationOptions = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    orientation?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "StepperOrientationType",
+              "canonicalReference": "@genesislcap/foundation-forms!StepperOrientationType:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "StepperOrientationOptions",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 4
+          }
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/foundation-forms!StepperOrientationType:type",
-          "docComment": "/**\n * @public\n */\n",
+          "docComment": "/**\n * Available orientation for stepper renderer.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1069,10 +1271,63 @@
             "endIndex": 2
           }
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-forms!StepperRendererOptions:type",
+          "docComment": "/**\n * Configuration options available for stepper renderer.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type StepperRendererOptions = "
+            },
+            {
+              "kind": "Reference",
+              "text": "CategorizationRendererOptions",
+              "canonicalReference": "@genesislcap/foundation-forms!CategorizationRendererOptions:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "StepperRendererOptions",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-forms!StringRendererOptions:type",
+          "docComment": "/**\n * Configuration options available for string renderer.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type StringRendererOptions = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    isPassword?: boolean;\n    textarea?: boolean;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "StringRendererOptions",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/foundation-forms!UiSchema:type",
-          "docComment": "/**\n * @public\n */\n",
+          "docComment": "/**\n * 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.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1102,8 +1357,8 @@
             },
             {
               "kind": "Reference",
-              "text": "UiSchemaElementOptions",
-              "canonicalReference": "@genesislcap/foundation-forms!UiSchemaElementOptions:type"
+              "text": "StepperOrientationOptions",
+              "canonicalReference": "@genesislcap/foundation-forms!StepperOrientationOptions:type"
             },
             {
               "kind": "Content",
@@ -1125,7 +1380,7 @@
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/foundation-forms!UiSchemaElement:type",
-          "docComment": "/**\n * @public\n */\n",
+          "docComment": "/**\n * A UiSchemaElement that displays property values in a user interface element.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1169,60 +1424,70 @@
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/foundation-forms!UiSchemaElementOptions:type",
-          "docComment": "/**\n * @public\n */\n",
+          "docComment": "/**\n * All configuration options that are available.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
               "text": "export type UiSchemaElementOptions = "
             },
+            {
+              "kind": "Reference",
+              "text": "ConnectedRenderersOptions",
+              "canonicalReference": "@genesislcap/foundation-forms!ConnectedRenderersOptions:type"
+            },
             {
               "kind": "Content",
-              "text": "{\n    async?: boolean;\n    orientation?: "
+              "text": " | "
             },
             {
               "kind": "Reference",
-              "text": "StepperOrientationType",
-              "canonicalReference": "@genesislcap/foundation-forms!StepperOrientationType:type"
+              "text": "ArrayRendererOptions",
+              "canonicalReference": "@genesislcap/foundation-forms!ArrayRendererOptions:type"
             },
             {
               "kind": "Content",
-              "text": ";\n    allOptionsResourceName?: string;\n    datasourceConfig?: "
+              "text": " | "
             },
             {
               "kind": "Reference",
-              "text": "DatasourceOptions",
-              "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions:interface"
+              "text": "CategorizationRendererOptions",
+              "canonicalReference": "@genesislcap/foundation-forms!CategorizationRendererOptions:type"
             },
             {
               "kind": "Content",
-              "text": ";\n    hidden?: boolean;\n    isPassword?: boolean;\n    validateFn?: (data: any, path: string, label: string) => "
+              "text": " | "
             },
             {
               "kind": "Reference",
-              "text": "ErrorObject",
-              "canonicalReference": "ajv!ErrorObject:interface"
+              "text": "GroupRendererOptions",
+              "canonicalReference": "@genesislcap/foundation-forms!GroupRendererOptions:type"
             },
             {
               "kind": "Content",
-              "text": "[];\n    valueField?: string;\n    labelField?: string;\n    textarea?: boolean;\n    data?: any[];\n    childUiSchema?: "
+              "text": " | "
             },
             {
               "kind": "Reference",
-              "text": "UiSchema",
-              "canonicalReference": "@genesislcap/foundation-forms!UiSchema:type"
+              "text": "StepperRendererOptions",
+              "canonicalReference": "@genesislcap/foundation-forms!StepperRendererOptions:type"
             },
             {
               "kind": "Content",
-              "text": ";\n    childElements?: "
+              "text": " | "
             },
             {
               "kind": "Reference",
-              "text": "UiSchema",
-              "canonicalReference": "@genesislcap/foundation-forms!UiSchema:type"
+              "text": "StringRendererOptions",
+              "canonicalReference": "@genesislcap/foundation-forms!StringRendererOptions:type"
             },
             {
               "kind": "Content",
-              "text": "[];\n    i18n?: {\n        [key: string]: any;\n    };\n}"
+              "text": " | "
+            },
+            {
+              "kind": "Reference",
+              "text": "StandardRendererOptions",
+              "canonicalReference": "@genesislcap/foundation-forms!StandardRendererOptions:type"
             },
             {
               "kind": "Content",
@@ -1234,13 +1499,13 @@
           "name": "UiSchemaElementOptions",
           "typeTokenRange": {
             "startIndex": 1,
-            "endIndex": 12
+            "endIndex": 14
           }
         },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/foundation-forms!UiSchemaElementType:type",
-          "docComment": "/**\n * @public\n */\n",
+          "docComment": "/**\n * The layouts and control types, which allow you to customize the arrangement of forms.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1248,7 +1513,7 @@
             },
             {
               "kind": "Content",
-              "text": "'Control' | 'VerticalLayout' | any"
+              "text": "'Control' | 'VerticalLayout' | 'LayoutVertical2Columns' | 'Categorization' | 'Group' | 'Stepper' | 'HorizontalLayout'"
             },
             {
               "kind": "Content",

package/dist/foundation-forms.d.ts

@@ -14,6 +14,68 @@ import { StatePropsOfControl } from '@jsonforms/core';
 import { UISchemaElement } from '@jsonforms/core';
 import { ViewTemplate } from '@microsoft/fast-element';
 
+/**
+ * Configuration options available for array renderer.
+ * @public
+ */
+export declare type ArrayRendererOptions = {
+    /**
+     * ChildUiSchema allows you to pass a UiSchema for a particular element,
+     * which can then be multiplied many times by the renderer.
+     * @public
+     */
+    childUiSchema?: UiSchema;
+};
+
+/**
+ * Configuration options available for categorization renderer.
+ * @public
+ */
+export declare type CategorizationRendererOptions = {
+    /**
+     * childElements allows you to pass the UiSchema array in which the renderers groups will be located
+     * @public
+     */
+    childElements?: UiSchema[];
+};
+
+/**
+ * Available configuration options for connected combobox/multiselect.
+ * @public
+ */
+export declare type ConnectedRenderersOptions = {
+    /**
+     * Activates the async search by changing the criteria based on the value from the search-bar.
+     * @public
+     */
+    async?: boolean;
+    /**
+     * The name of the target Data Server query or Request Server requestReply.
+     * @public
+     */
+    allOptionsResourceName?: string;
+    /**
+     * A property that is set to configure the resource to which combobox/multiselect is connected.
+     * @public
+     */
+    datasourceConfig?: DatasourceOptions;
+    /**
+     * Specifies which field should be used as underlying data used when changing selection.
+     * @public
+     */
+    valueField?: string;
+    /**
+     * Field used to display label for the component.
+     * @public
+     */
+    labelField?: string;
+    /**
+     * Property to which we can provide the data to be used instead of data from the server.
+     * @public
+     */
+    data?: any[];
+};
+
 /**
  * Creates a expressions/criteria from given payload
  * @public
@@ -254,6 +316,12 @@ export declare const foundationFormTemplate: ViewTemplate<Form, any>;
 /** @public */
 export declare const genesisErrorTranslator: ErrorTranslator;
 
+/**
+ * Configuration options available for group renderer.
+ * @public
+ */
+export declare type GroupRendererOptions = CategorizationRendererOptions;
+
 /** @internal */
 export declare const logger: Logger;
 
@@ -281,47 +349,139 @@ export declare type RendererEntry = {
 /** @public */
 export declare const renderers: any[];
 
-/** @public */
+/**
+ * Standard configuration options available for all renderers.
+ * @public
+ */
+export declare type StandardRendererOptions = {
+    /**
+     * Setting this property allows you to hide the renderer.
+     * @public
+     */
+    hidden?: boolean;
+    /**
+     * Setting this property enables client-side validation.
+     * @public
+     */
+    validateFn?: (data: any, path: string, label: string) => ErrorObject[];
+    i18n?: {
+        [key: string]: any;
+    };
+};
+
+/**
+ * Orientation options available for stepper renderer.
+ * @public
+ */
+export declare type StepperOrientationOptions = {
+    /**
+     * Configuration options available for the stepper renderer which set the renderer horizontally or vertically.
+     * @public
+     */
+    orientation?: StepperOrientationType;
+};
+
+/**
+ * Available orientation for stepper renderer.
+ * @public
+ */
 export declare type StepperOrientationType = 'vertical' | 'horizontal';
 
-/** @public */
+/**
+ * Configuration options available for stepper renderer.
+ * @public
+ */
+export declare type StepperRendererOptions = CategorizationRendererOptions;
+
+/**
+ * Configuration options available for string renderer.
+ * @public
+ */
+export declare type StringRendererOptions = {
+    /**
+     * Changes the type attribute in the string renderer from text to password.
+     * @public
+     */
+    isPassword?: boolean;
+    /**
+     * Setting this property enables text-area instead of text-field.
+     * @public
+     */
+    textarea?: boolean;
+};
+
+/**
+ * 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.
+ * @public
+ */
 export declare type UiSchema = {
+    /**
+     * The layouts and control types, which allow you to customize the arrangement of forms.
+     * @public
+     * */
     type: UiSchemaElementType;
+    /**
+     * All layouts need to declare an elements property which contains the children which are to be arranged by the layout.
+     * It is expected to be an array of UI Schema elements, e.g. controls or other layouts.
+     * @public
+     */
     elements: UiSchemaElement[];
+    /**
+     * Allows changing the design-system for renderers.
+     * @public
+     */
     dsPrefix?: string;
-    options?: UiSchemaElementOptions;
+    /**
+     * Options for changing the orientation for the stepper renderer.
+     * @public
+     */
+    options?: StepperOrientationOptions;
 };
 
-/** @public */
+/**
+ * A UiSchemaElement that displays property values in a user interface element.
+ * @public
+ */
 export declare type UiSchemaElement = {
+    /**
+     * The layouts and control types, which allow you to customize the arrangement of forms.
+     * @public
+     * */
     type: UiSchemaElementType;
+    /**
+     * The mandatory scope property, which expects a JSON schema reference value, defines to which property of the data the control should be bound to.
+     * @public
+     */
     scope: string;
+    /**
+     * By default, controls use the name of property they point to as a label.
+     * Setting this property allows you to change the label.
+     * @public
+     */
     label?: string;
+    /**
+     * Setting this property allows you to change the placeholder in input renderers.
+     * @public
+     */
     placeholder?: string;
+    /**
+     * Optional attribute options that determine how the control is rendered.
+     * @public
+     */
     options?: UiSchemaElementOptions;
 };
 
-/** @public */
-export declare type UiSchemaElementOptions = {
-    async?: boolean;
-    orientation?: StepperOrientationType;
-    allOptionsResourceName?: string;
-    datasourceConfig?: DatasourceOptions;
-    hidden?: boolean;
-    isPassword?: boolean;
-    validateFn?: (data: any, path: string, label: string) => ErrorObject[];
-    valueField?: string;
-    labelField?: string;
-    textarea?: boolean;
-    data?: any[];
-    childUiSchema?: UiSchema;
-    childElements?: UiSchema[];
-    i18n?: {
-        [key: string]: any;
-    };
-};
+/**
+ * All configuration options that are available.
+ * @public
+ */
+export declare type UiSchemaElementOptions = ConnectedRenderersOptions | ArrayRendererOptions | CategorizationRendererOptions | GroupRendererOptions | StepperRendererOptions | StringRendererOptions | StandardRendererOptions;
 
-/** @public */
-export declare type UiSchemaElementType = 'Control' | 'VerticalLayout' | any;
+/**
+ * The layouts and control types, which allow you to customize the arrangement of forms.
+ * @public
+ * */
+export declare type UiSchemaElementType = 'Control' | 'VerticalLayout' | 'LayoutVertical2Columns' | 'Categorization' | 'Group' | 'Stepper' | 'HorizontalLayout';
 
 export { }

package/docs/api/foundation-forms.arrayrendereroptions.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [ArrayRendererOptions](./foundation-forms.arrayrendereroptions.md)
+
+## ArrayRendererOptions type
+
+Configuration options available for array renderer.
+
+**Signature:**
+
+```typescript
+export type ArrayRendererOptions = {
+    childUiSchema?: UiSchema;
+};
+```
+**References:** [UiSchema](./foundation-forms.uischema.md)
+