@genesislcap/foundation-forms 14.408.0 → 14.409.0

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

@@ -1,335 +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; [Filters](./foundation-forms.filters.md)
-
-## Filters class
-
-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
-
-**Signature:**
-
-```typescript
-export declare class Filters extends Filters_base 
-```
-**Extends:** Filters\_base
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[allSavedFilters](./foundation-forms.filters.allsavedfilters.md)
-
-
-</td><td>
-
-
-</td><td>
-
-any\[\]
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[data](./foundation-forms.filters.data.md)
-
-
-</td><td>
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-Initial data for the filters.
-
-
-</td></tr>
-<tr><td>
-
-[filterName](./foundation-forms.filters.filtername.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[jsonSchema](./foundation-forms.filters.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>
-
-[kvStorage](./foundation-forms.filters.kvstorage.md)
-
-
-</td><td>
-
-
-</td><td>
-
-KVStorage
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[prefix](./foundation-forms.filters.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>
-
-[renderers](./foundation-forms.filters.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.filters.resourcename.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-Name of the backend resource which will provide metadata used to generate filters.
-
-
-</td></tr>
-<tr><td>
-
-[showFilterPersistenceControls](./foundation-forms.filters.showfilterpersistencecontrols.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-Controls the visibility of the filter persistence controls UI.
-
-
-</td></tr>
-<tr><td>
-
-[uischema](./foundation-forms.filters.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 filters Check [UiSchema](./foundation-forms.uischema.md) for possible options.
-
-
-</td></tr>
-<tr><td>
-
-[value](./foundation-forms.filters.value.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-Created criteria based on the given data that can be used to filter the data.
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[connectedCallback()](./foundation-forms.filters.connectedcallback.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[deleteFilter()](./foundation-forms.filters.deletefilter.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[filterNameChanged(oldValue, newValue)](./foundation-forms.filters.filternamechanged.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[loadAllSavedFilters()](./foundation-forms.filters.loadallsavedfilters.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[loadFilterData(filterKey)](./foundation-forms.filters.loadfilterdata.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[saveFilter()](./foundation-forms.filters.savefilter.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-forms.filters.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; [Filters](./foundation-forms.filters.md) &gt; [prefix](./foundation-forms.filters.prefix.md)
-
-## Filters.prefix property
-
-Name of the design system prefix that will be used in renderers.
-
-**Signature:**
-
-```typescript
-prefix: string;
-```

package/docs/api/foundation-forms.filters.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; [Filters](./foundation-forms.filters.md) &gt; [renderers](./foundation-forms.filters.renderers.md)
-
-## Filters.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.filters.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; [Filters](./foundation-forms.filters.md) &gt; [resourceName](./foundation-forms.filters.resourcename.md)
-
-## Filters.resourceName property
-
-Name of the backend resource which will provide metadata used to generate filters.
-
-**Signature:**
-
-```typescript
-resourceName: string;
-```

package/docs/api/foundation-forms.filters.savefilter.md

@@ -1,15 +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; [Filters](./foundation-forms.filters.md) &gt; [saveFilter](./foundation-forms.filters.savefilter.md)
-
-## Filters.saveFilter() method
-
-**Signature:**
-
-```typescript
-saveFilter(): Promise<void>;
-```
-**Returns:**
-
-Promise&lt;void&gt;
-

package/docs/api/foundation-forms.filters.showfilterpersistencecontrols.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; [Filters](./foundation-forms.filters.md) &gt; [showFilterPersistenceControls](./foundation-forms.filters.showfilterpersistencecontrols.md)
-
-## Filters.showFilterPersistenceControls property
-
-Controls the visibility of the filter persistence controls UI.
-
-**Signature:**
-
-```typescript
-showFilterPersistenceControls: boolean;
-```

package/docs/api/foundation-forms.filters.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; [Filters](./foundation-forms.filters.md) &gt; [uischema](./foundation-forms.filters.uischema.md)
-
-## Filters.uischema property
-
-UI schema used to define configuration of the layout and elements in the filters 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',
-    },
-  ],
-};
-```
-

package/docs/api/foundation-forms.filters.value.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; [Filters](./foundation-forms.filters.md) &gt; [value](./foundation-forms.filters.value.md)
-
-## Filters.value property
-
-Created criteria based on the given data that can be used to filter the data.
-
-**Signature:**
-
-```typescript
-value: string;
-```

package/docs/api/foundation-forms.filtersrenderers.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; [filtersRenderers](./foundation-forms.filtersrenderers.md)
-
-## filtersRenderers variable
-
-Set of default renderers used by the foundation-filters.
-
-**Signature:**
-
-```typescript
-filtersRenderers: any[]
-```

package/docs/api/foundation-forms.form.additionalrenderers.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; [additionalRenderers](./foundation-forms.form.additionalrenderers.md)
-
-## Form.additionalRenderers property
-
-Allows to provide set of additional renderers used by the form.
-
-**Signature:**
-
-```typescript
-additionalRenderers: RendererEntry[];
-```

package/docs/api/foundation-forms.form.approvalmessagelabel.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; [approvalMessageLabel](./foundation-forms.form.approvalmessagelabel.md)
-
-## Form.approvalMessageLabel property
-
-Label for the approval message field in the approval dialog.
-
-**Signature:**
-
-```typescript
-approvalMessageLabel: string;
-```

package/docs/api/foundation-forms.form.bulkinsert.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; [bulkInsert](./foundation-forms.form.bulkinsert.md)
-
-## Form.bulkInsert property
-
-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.
-
-**Signature:**
-
-```typescript
-bulkInsert: boolean;
-```

package/docs/api/foundation-forms.form.bulkinsertmaxitems.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; [bulkInsertMaxItems](./foundation-forms.form.bulkinsertmaxitems.md)
-
-## Form.bulkInsertMaxItems property
-
-Maximum number of items allowed in bulk insert mode. If not set, no maximum is enforced.
-
-**Signature:**
-
-```typescript
-bulkInsertMaxItems: number | undefined;
-```

package/docs/api/foundation-forms.form.bulkinsertminitems.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; [bulkInsertMinItems](./foundation-forms.form.bulkinsertminitems.md)
-
-## Form.bulkInsertMinItems property
-
-Minimum number of items required in bulk insert mode.
-
-**Signature:**
-
-```typescript
-bulkInsertMinItems: number;
-```

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

@@ -1,17 +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; [clearRowSubmitStatuses](./foundation-forms.form.clearrowsubmitstatuses.md)
-
-## Form.clearRowSubmitStatuses() method
-
-Clears all row submit statuses, typically called when resetting the form.
-
-**Signature:**
-
-```typescript
-clearRowSubmitStatuses(): void;
-```
-**Returns:**
-
-void
-

package/docs/api/foundation-forms.form.confirmationmessage.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; [confirmationMessage](./foundation-forms.form.confirmationmessage.md)
-
-## Form.confirmationMessage property
-
-Optional confirmation message to display before form submission. If set, a confirmation dialog will be shown when the user clicks submit.
-
-**Signature:**
-
-```typescript
-confirmationMessage: string;
-```

package/docs/api/foundation-forms.form.data.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; [data](./foundation-forms.form.data.md)
-
-## Form.data property
-
-Initial data for the form.
-
-**Signature:**
-
-```typescript
-data: any;
-```

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

@@ -1,17 +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; [downloadCsvTemplate](./foundation-forms.form.downloadcsvtemplate.md)
-
-## Form.downloadCsvTemplate() method
-
-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.
-
-**Signature:**
-
-```typescript
-downloadCsvTemplate(): void;
-```
-**Returns:**
-
-void
-

package/docs/api/foundation-forms.form.handlecsvfileselected.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; [handleCsvFileSelected](./foundation-forms.form.handlecsvfileselected.md)
-
-## Form.handleCsvFileSelected() method
-
-Handles CSV file selection for bulk import. Parses the CSV content and appends it to existing form items.
-
-**Signature:**
-
-```typescript
-handleCsvFileSelected(event: Event): Promise<void>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-event
-
-
-</td><td>
-
-Event
-
-
-</td><td>
-
-The file input change event
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;void&gt;
-

package/docs/api/foundation-forms.form.hidesubmit.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; [hideSubmit](./foundation-forms.form.hidesubmit.md)
-
-## Form.hideSubmit property
-
-Controls the visibility of the submit button.
-
-**Signature:**
-
-```typescript
-hideSubmit: boolean;
-```