npm - @genesislcap/grid-tabulator - Versions diffs - 14.408.0 → 14.409.0-FUI-2495.2 - Mend

@genesislcap/grid-tabulator 14.408.0 → 14.409.0-FUI-2495.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (168) hide show

package/docs/api/grid-tabulator.criteriadelimiter.md DELETED Viewed

@@ -1,16 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [criteriaDelimiter](./grid-tabulator.criteriadelimiter.md)
-## criteriaDelimiter variable
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-Delimiter for criteria in the datasource
-**Signature:**
-```typescript
-criteriaDelimiter = ";"
-```

package/docs/api/grid-tabulator.criteriajoin.md DELETED Viewed

@@ -1,16 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [criteriaJoin](./grid-tabulator.criteriajoin.md)
-## criteriaJoin variable
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-Join operator for criteria in the datasource
-**Signature:**
-```typescript
-criteriaJoin = " && "
-```

package/docs/api/grid-tabulator.datetimevalueformatter.md DELETED Viewed

@@ -1,58 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [dateTimeValueFormatter](./grid-tabulator.datetimevalueformatter.md)
-## dateTimeValueFormatter() function
-Format a date time value to a readable string.
-**Signature:**
-```typescript
-export declare function dateTimeValueFormatter({ value }: any): string;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-{ value }
-</td><td>
-any
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-string
-The filter params.
-## Remarks
-Formats \[DATETIME\] UNIX Timestamps (with time) to readable strings

package/docs/api/grid-tabulator.datevalueformatter.md DELETED Viewed

@@ -1,58 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [dateValueFormatter](./grid-tabulator.datevalueformatter.md)
-## dateValueFormatter() function
-Format a date value.
-**Signature:**
-```typescript
-export declare function dateValueFormatter({ value }: any): string;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-{ value }
-</td><td>
-any
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-string
-The filter params.
-## Remarks
-Formats \[DATE\] UNIX Timestamps (with time) to readable strings

package/docs/api/grid-tabulator.debounced_resize_time.md DELETED Viewed

@@ -1,16 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [DEBOUNCED\_RESIZE\_TIME](./grid-tabulator.debounced_resize_time.md)
-## DEBOUNCED\_RESIZE\_TIME variable
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-Time in milliseconds to debounce resize events
-**Signature:**
-```typescript
-DEBOUNCED_RESIZE_TIME = 400
-```

package/docs/api/grid-tabulator.defaultgridtabulatorconfig.md DELETED Viewed

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [defaultGridTabulatorConfig](./grid-tabulator.defaultgridtabulatorconfig.md)
-## defaultGridTabulatorConfig variable
-The default grid-tabulator configuration.
-**Signature:**
-```typescript
-defaultGridTabulatorConfig: {
-    shadowOptions: any;
-}
-```

package/docs/api/grid-tabulator.editableformatter.md DELETED Viewed

@@ -1,72 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [editableFormatter](./grid-tabulator.editableformatter.md)
-## editableFormatter() function
-Formatter that displays an editable cell with validation state
-**Signature:**
-```typescript
-export declare function editableFormatter<T = any>(cell: any, formatterParams?: EditableFormatterParams<T>): string;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-cell
-</td><td>
-any
-</td><td>
-The cell component provided by Tabulator
-</td></tr>
-<tr><td>
-formatterParams
-</td><td>
-[EditableFormatterParams](./grid-tabulator.editableformatterparams.md)<!-- -->&lt;T&gt;
-</td><td>
-_(Optional)_ Editable formatter parameters
-</td></tr>
-</tbody></table>
-**Returns:**
-string
-HTML content for the editable cell

package/docs/api/grid-tabulator.editableformatterparams.cssclass.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [EditableFormatterParams](./grid-tabulator.editableformatterparams.md) &gt; [cssClass](./grid-tabulator.editableformatterparams.cssclass.md)
-## EditableFormatterParams.cssClass property
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-cssClass?: string;
-```

package/docs/api/grid-tabulator.editableformatterparams.data.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [EditableFormatterParams](./grid-tabulator.editableformatterparams.md) &gt; [data](./grid-tabulator.editableformatterparams.data.md)
-## EditableFormatterParams.data property
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-data?: T;
-```

package/docs/api/grid-tabulator.editableformatterparams.datatestid.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [EditableFormatterParams](./grid-tabulator.editableformatterparams.md) &gt; [dataTestId](./grid-tabulator.editableformatterparams.datatestid.md)
-## EditableFormatterParams.dataTestId property
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-dataTestId?: ((rowData: T) => string) | string;
-```

package/docs/api/grid-tabulator.editableformatterparams.field.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [EditableFormatterParams](./grid-tabulator.editableformatterparams.md) &gt; [field](./grid-tabulator.editableformatterparams.field.md)
-## EditableFormatterParams.field property
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-field?: string;
-```

package/docs/api/grid-tabulator.editableformatterparams.icon.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [EditableFormatterParams](./grid-tabulator.editableformatterparams.md) &gt; [icon](./grid-tabulator.editableformatterparams.icon.md)
-## EditableFormatterParams.icon property
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-icon?: string;
-```

package/docs/api/grid-tabulator.editableformatterparams.md DELETED Viewed

@@ -1,210 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [EditableFormatterParams](./grid-tabulator.editableformatterparams.md)
-## EditableFormatterParams interface
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-Parameters for the editable formatter
-`value`<!-- -->: The raw value to be displayed
-`data`<!-- -->: The row data containing the current cell
-`field`<!-- -->: The field name in the data object
-`cssClass`<!-- -->: Optional CSS class to apply to the text
-`nullText`<!-- -->: Text to display for null/undefined values
-`dataTestId`<!-- -->: Data test ID for testing
-`icon`<!-- -->: Icon to display for edit action
-`prefix`<!-- -->: The prefix to use for element classes and components, e.g., 'foundation', 'zero', 'rapid'.
-**Signature:**
-```typescript
-export interface EditableFormatterParams<T = any>
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[cssClass?](./grid-tabulator.editableformatterparams.cssclass.md)
-</td><td>
-</td><td>
-string
-</td><td>
-**_(ALPHA)_** _(Optional)_
-</td></tr>
-<tr><td>
-[data?](./grid-tabulator.editableformatterparams.data.md)
-</td><td>
-</td><td>
-T
-</td><td>
-**_(ALPHA)_** _(Optional)_
-</td></tr>
-<tr><td>
-[dataTestId?](./grid-tabulator.editableformatterparams.datatestid.md)
-</td><td>
-</td><td>
-((rowData: T) =&gt; string) \| string
-</td><td>
-**_(ALPHA)_** _(Optional)_
-</td></tr>
-<tr><td>
-[field?](./grid-tabulator.editableformatterparams.field.md)
-</td><td>
-</td><td>
-string
-</td><td>
-**_(ALPHA)_** _(Optional)_
-</td></tr>
-<tr><td>
-[icon?](./grid-tabulator.editableformatterparams.icon.md)
-</td><td>
-</td><td>
-string
-</td><td>
-**_(ALPHA)_** _(Optional)_
-</td></tr>
-<tr><td>
-[nullText?](./grid-tabulator.editableformatterparams.nulltext.md)
-</td><td>
-</td><td>
-string
-</td><td>
-**_(ALPHA)_** _(Optional)_
-</td></tr>
-<tr><td>
-[prefix?](./grid-tabulator.editableformatterparams.prefix.md)
-</td><td>
-</td><td>
-string
-</td><td>
-**_(ALPHA)_** _(Optional)_
-</td></tr>
-<tr><td>
-[value?](./grid-tabulator.editableformatterparams.value.md)
-</td><td>
-</td><td>
-any
-</td><td>
-**_(ALPHA)_** _(Optional)_
-</td></tr>
-</tbody></table>

package/docs/api/grid-tabulator.editableformatterparams.nulltext.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [EditableFormatterParams](./grid-tabulator.editableformatterparams.md) &gt; [nullText](./grid-tabulator.editableformatterparams.nulltext.md)
-## EditableFormatterParams.nullText property
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-nullText?: string;
-```

package/docs/api/grid-tabulator.editableformatterparams.prefix.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [EditableFormatterParams](./grid-tabulator.editableformatterparams.md) &gt; [prefix](./grid-tabulator.editableformatterparams.prefix.md)
-## EditableFormatterParams.prefix property
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-prefix?: string;
-```

package/docs/api/grid-tabulator.editableformatterparams.value.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [EditableFormatterParams](./grid-tabulator.editableformatterparams.md) &gt; [value](./grid-tabulator.editableformatterparams.value.md)
-## EditableFormatterParams.value property
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-value?: any;
-```

package/docs/api/grid-tabulator.edited_column_field.md DELETED Viewed

@@ -1,16 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [EDITED\_COLUMN\_FIELD](./grid-tabulator.edited_column_field.md)
-## EDITED\_COLUMN\_FIELD variable
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-The special column field name for marking a cell as edited
-**Signature:**
-```typescript
-EDITED_COLUMN_FIELD = "__EDITED_FIELD__"
-```

package/docs/api/grid-tabulator.error_column_field.md DELETED Viewed

@@ -1,16 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [ERROR\_COLUMN\_FIELD](./grid-tabulator.error_column_field.md)
-## ERROR\_COLUMN\_FIELD variable
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-The special column field name for marking a cell as having an error
-**Signature:**
-```typescript
-ERROR_COLUMN_FIELD = "__ERROR_FIELD__"
-```

package/docs/api/grid-tabulator.formatdateextra.md DELETED Viewed

@@ -1,56 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [formatDateExtra](./grid-tabulator.formatdateextra.md)
-## formatDateExtra() function
-Format am epoch value to a readable ISO date string.
-**Signature:**
-```typescript
-export declare function formatDateExtra(epoch: number): string;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-epoch
-</td><td>
-number
-</td><td>
-The epoch number.
-</td></tr>
-</tbody></table>
-**Returns:**
-string
-The formatted date value.