@genesislcap/foundation-forms 14.408.0 → 14.409.0

package/docs/api/foundation-forms.form.jsonschema.md

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [Form](./foundation-forms.form.md) &gt; [jsonSchema](./foundation-forms.form.jsonschema.md)
-
-## Form.jsonSchema property
-
-Alternatively to providing [Form.resourceName](./foundation-forms.form.resourcename.md) you can hardcode the JSON schema on the client.
-
-**Signature:**
-
-```typescript
-jsonSchema: JSONSchema7;
-```
-
-## Remarks
-
-Use this when you want to avoid fetching metadata from the server but be aware that it could get out of sync if metadata changes on the server.
-

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

@@ -1,434 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [Form](./foundation-forms.form.md)
-
-## Form class
-
-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
-
-**Signature:**
-
-```typescript
-export declare class Form extends Form_base 
-```
-**Extends:** Form\_base
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[additionalRenderers](./foundation-forms.form.additionalrenderers.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[RendererEntry](./foundation-forms.rendererentry.md)<!-- -->\[\]
-
-
-</td><td>
-
-Allows to provide set of additional renderers used by the form.
-
-
-</td></tr>
-<tr><td>
-
-[approvalMessageLabel](./foundation-forms.form.approvalmessagelabel.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-Label for the approval message field in the approval dialog.
-
-
-</td></tr>
-<tr><td>
-
-[bulkInsert](./foundation-forms.form.bulkinsert.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-When enabled, transforms the form into bulk insert mode where multiple records can be added. The JSON schema will be wrapped as an array, and each item will be submitted separately.
-
-
-</td></tr>
-<tr><td>
-
-[bulkInsertMaxItems](./foundation-forms.form.bulkinsertmaxitems.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number \| undefined
-
-
-</td><td>
-
-Maximum number of items allowed in bulk insert mode. If not set, no maximum is enforced.
-
-
-</td></tr>
-<tr><td>
-
-[bulkInsertMinItems](./foundation-forms.form.bulkinsertminitems.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-Minimum number of items required in bulk insert mode.
-
-
-</td></tr>
-<tr><td>
-
-[confirmationMessage](./foundation-forms.form.confirmationmessage.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-Optional confirmation message to display before form submission. If set, a confirmation dialog will be shown when the user clicks submit.
-
-
-</td></tr>
-<tr><td>
-
-[data](./foundation-forms.form.data.md)
-
-
-</td><td>
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-Initial data for the form.
-
-
-</td></tr>
-<tr><td>
-
-[hideSubmit](./foundation-forms.form.hidesubmit.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-Controls the visibility of the submit button.
-
-
-</td></tr>
-<tr><td>
-
-[jsonSchema](./foundation-forms.form.jsonschema.md)
-
-
-</td><td>
-
-
-</td><td>
-
-JSONSchema7
-
-
-</td><td>
-
-Alternatively to providing [Form.resourceName](./foundation-forms.form.resourcename.md) you can hardcode the JSON schema on the client.
-
-
-</td></tr>
-<tr><td>
-
-[prefix](./foundation-forms.form.prefix.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-Name of the design system prefix that will be used in renderers.
-
-
-</td></tr>
-<tr><td>
-
-[readonly](./foundation-forms.form.readonly.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-Allows you to enable read-only mode, which disables all input on the form and hides the submit button.
-
-
-</td></tr>
-<tr><td>
-
-[renderers](./foundation-forms.form.renderers.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[RendererEntry](./foundation-forms.rendererentry.md)<!-- -->\[\]
-
-
-</td><td>
-
-Allows to provide the main set of renderers used by the form. If not provided, the built-in renderers will be used by default.
-
-
-</td></tr>
-<tr><td>
-
-[resourceName](./foundation-forms.form.resourcename.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-Name of the backend resource which will provide metadata used to generate form and later used for submitting data
-
-
-</td></tr>
-<tr><td>
-
-[rowSubmitStatuses](./foundation-forms.form.rowsubmitstatuses.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Map&lt;number, [BulkRowStatus](./foundation-forms.bulkrowstatus.md)<!-- -->&gt;
-
-
-</td><td>
-
-Tracks the submission status for each row in bulk insert mode. Key is the row index, value is the status object.
-
-
-</td></tr>
-<tr><td>
-
-[setApprovalMessage](./foundation-forms.form.setapprovalmessage.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-When enabled, adds an APPROVAL\_MESSAGE field to the form schema. This field will be sent at root level alongside DETAILS when submitting.
-
-
-</td></tr>
-<tr><td>
-
-[uischema](./foundation-forms.form.uischema.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[UiSchema](./foundation-forms.uischema.md)
-
-
-</td><td>
-
-UI schema used to define configuration of the layout and elements in the form Check [UiSchema](./foundation-forms.uischema.md) for possible options
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[clearRowSubmitStatuses()](./foundation-forms.form.clearrowsubmitstatuses.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Clears all row submit statuses, typically called when resetting the form.
-
-
-</td></tr>
-<tr><td>
-
-[downloadCsvTemplate()](./foundation-forms.form.downloadcsvtemplate.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Downloads a CSV template file with headers and sample data based on the schema. If a UI schema is provided, it will be used to determine which fields to include and in what order. Hidden fields will be excluded from the template.
-
-
-</td></tr>
-<tr><td>
-
-[handleCsvFileSelected(event)](./foundation-forms.form.handlecsvfileselected.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Handles CSV file selection for bulk import. Parses the CSV content and appends it to existing form items.
-
-
-</td></tr>
-<tr><td>
-
-[reset(clearData)](./foundation-forms.form.reset.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Reset the form state
-
-
-</td></tr>
-<tr><td>
-
-[submitSingleRow(index)](./foundation-forms.form.submitsinglerow.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Submits a single row in bulk insert mode.
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-forms.form.prefix.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [Form](./foundation-forms.form.md) &gt; [prefix](./foundation-forms.form.prefix.md)
-
-## Form.prefix property
-
-Name of the design system prefix that will be used in renderers.
-
-**Signature:**
-
-```typescript
-prefix: string;
-```

package/docs/api/foundation-forms.form.readonly.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [Form](./foundation-forms.form.md) &gt; [readonly](./foundation-forms.form.readonly.md)
-
-## Form.readonly property
-
-Allows you to enable read-only mode, which disables all input on the form and hides the submit button.
-
-**Signature:**
-
-```typescript
-readonly: boolean;
-```

package/docs/api/foundation-forms.form.renderers.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [Form](./foundation-forms.form.md) &gt; [renderers](./foundation-forms.form.renderers.md)
-
-## Form.renderers property
-
-Allows to provide the main set of renderers used by the form. If not provided, the built-in renderers will be used by default.
-
-**Signature:**
-
-```typescript
-renderers: RendererEntry[];
-```

package/docs/api/foundation-forms.form.reset.md

@@ -1,54 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [Form](./foundation-forms.form.md) &gt; [reset](./foundation-forms.form.reset.md)
-
-## Form.reset() method
-
-Reset the form state
-
-**Signature:**
-
-```typescript
-reset(clearData?: boolean): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-clearData
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

package/docs/api/foundation-forms.form.resourcename.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [Form](./foundation-forms.form.md) &gt; [resourceName](./foundation-forms.form.resourcename.md)
-
-## Form.resourceName property
-
-Name of the backend resource which will provide metadata used to generate form and later used for submitting data
-
-**Signature:**
-
-```typescript
-resourceName: string;
-```

package/docs/api/foundation-forms.form.rowsubmitstatuses.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [Form](./foundation-forms.form.md) &gt; [rowSubmitStatuses](./foundation-forms.form.rowsubmitstatuses.md)
-
-## Form.rowSubmitStatuses property
-
-Tracks the submission status for each row in bulk insert mode. Key is the row index, value is the status object.
-
-**Signature:**
-
-```typescript
-rowSubmitStatuses: Map<number, BulkRowStatus>;
-```

package/docs/api/foundation-forms.form.setapprovalmessage.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [Form](./foundation-forms.form.md) &gt; [setApprovalMessage](./foundation-forms.form.setapprovalmessage.md)
-
-## Form.setApprovalMessage property
-
-When enabled, adds an APPROVAL\_MESSAGE field to the form schema. This field will be sent at root level alongside DETAILS when submitting.
-
-**Signature:**
-
-```typescript
-setApprovalMessage: boolean;
-```

package/docs/api/foundation-forms.form.submitsinglerow.md

@@ -1,56 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [Form](./foundation-forms.form.md) &gt; [submitSingleRow](./foundation-forms.form.submitsinglerow.md)
-
-## Form.submitSingleRow() method
-
-Submits a single row in bulk insert mode.
-
-**Signature:**
-
-```typescript
-submitSingleRow(index: number): Promise<void>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-index
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-The index of the row to submit
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;void&gt;
-
-Promise that resolves when submission is complete
-

package/docs/api/foundation-forms.form.uischema.md

@@ -1,50 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [Form](./foundation-forms.form.md) &gt; [uischema](./foundation-forms.form.uischema.md)
-
-## Form.uischema property
-
-UI schema used to define configuration of the layout and elements in the form Check [UiSchema](./foundation-forms.uischema.md) for possible options
-
-**Signature:**
-
-```typescript
-uischema: UiSchema;
-```
-
-## Remarks
-
-If not provided will be autogenerated based on json schema or initial data
-
-## Example
-
-Here's a simple example:
-
-```
-const sampleUISchema = {
-  type: 'VerticalLayout',
-  elements: [
-    {
-      type: 'Control',
-      scope: '#/properties/QUANTITY',
-      label: 'Quantity',
-    },
-    {
-      type: 'Control',
-      scope: '#/properties/INSTRUMENT_ID',
-      options: {
-        allOptionsResourceName: 'INSTRUMENT',
-        valueField: 'INSTRUMENT_ID',
-        labelField: 'INSTRUMENT_ID',
-      },
-      label: 'Instrument',
-    },
-    {
-      type: 'Control',
-      scope: '#/properties/SIDE',
-      label: 'Side',
-    },
-  ],
-};
-```
-