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

@genesislcap/grid-tabulator 14.408.0 → 14.409.0

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.actionsmenuformatterparams.md DELETED Viewed

@@ -1,168 +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; [ActionsMenuFormatterParams](./grid-tabulator.actionsmenuformatterparams.md)
-## ActionsMenuFormatterParams 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 actions menu formatter
-`actions`<!-- -->: The array of actions to display in the menu.
-`prefix`<!-- -->: The prefix to use for the actions-menu element, e.g., 'foundation', 'zero', 'rapid'.
-`menuName`<!-- -->: Custom name for the menu button (if not set, will use foundation: '⋮' or other: '+')
-`isVertical`<!-- -->: Optional flag to display the menu vertically. Default is false.
-`buttonAppearance`<!-- -->: Optional appearance for the button that opens the menu.
-`dataTestId`<!-- -->: Data test ID for testing
-**Signature:**
-```typescript
-export interface ActionsMenuFormatterParams<T = any>
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[actions?](./grid-tabulator.actionsmenuformatterparams.actions.md)
-</td><td>
-</td><td>
-Array&lt;{ name: string; callback: (rowData: T) =&gt; void; isDisabled?: (rowData: T) =&gt; boolean; }&gt;
-</td><td>
-**_(ALPHA)_** _(Optional)_
-</td></tr>
-<tr><td>
-[buttonAppearance?](./grid-tabulator.actionsmenuformatterparams.buttonappearance.md)
-</td><td>
-</td><td>
-string
-</td><td>
-**_(ALPHA)_** _(Optional)_
-</td></tr>
-<tr><td>
-[dataTestId?](./grid-tabulator.actionsmenuformatterparams.datatestid.md)
-</td><td>
-</td><td>
-((rowData: T) =&gt; string) \| string
-</td><td>
-**_(ALPHA)_** _(Optional)_
-</td></tr>
-<tr><td>
-[isVertical?](./grid-tabulator.actionsmenuformatterparams.isvertical.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-**_(ALPHA)_** _(Optional)_
-</td></tr>
-<tr><td>
-[menuName?](./grid-tabulator.actionsmenuformatterparams.menuname.md)
-</td><td>
-</td><td>
-string
-</td><td>
-**_(ALPHA)_** _(Optional)_
-</td></tr>
-<tr><td>
-[prefix?](./grid-tabulator.actionsmenuformatterparams.prefix.md)
-</td><td>
-</td><td>
-string
-</td><td>
-**_(ALPHA)_** _(Optional)_
-</td></tr>
-</tbody></table>

package/docs/api/grid-tabulator.actionsmenuformatterparams.menuname.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; [ActionsMenuFormatterParams](./grid-tabulator.actionsmenuformatterparams.md) &gt; [menuName](./grid-tabulator.actionsmenuformatterparams.menuname.md)
-## ActionsMenuFormatterParams.menuName 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
-menuName?: string;
-```

package/docs/api/grid-tabulator.actionsmenuformatterparams.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; [ActionsMenuFormatterParams](./grid-tabulator.actionsmenuformatterparams.md) &gt; [prefix](./grid-tabulator.actionsmenuformatterparams.prefix.md)
-## ActionsMenuFormatterParams.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.booleanformatter.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; [booleanFormatter](./grid-tabulator.booleanformatter.md)
-## booleanFormatter() function
-Formatter that displays boolean values using a checkbox component. Styled to match grid-pro boolean renderer.
-**Signature:**
-```typescript
-export declare function booleanFormatter<T = any>(cell: any, formatterParams?: BooleanFormatterParams<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>
-[BooleanFormatterParams](./grid-tabulator.booleanformatterparams.md)<!-- -->&lt;T&gt;
-</td><td>
-_(Optional)_ Boolean formatter parameters
-</td></tr>
-</tbody></table>
-**Returns:**
-string
-HTML content for the boolean value

package/docs/api/grid-tabulator.booleanformatterparams.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; [BooleanFormatterParams](./grid-tabulator.booleanformatterparams.md) &gt; [dataTestId](./grid-tabulator.booleanformatterparams.datatestid.md)
-## BooleanFormatterParams.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.booleanformatterparams.isdisabled.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; [BooleanFormatterParams](./grid-tabulator.booleanformatterparams.md) &gt; [isDisabled](./grid-tabulator.booleanformatterparams.isdisabled.md)
-## BooleanFormatterParams.isDisabled 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
-isDisabled?: (rowData: T) => boolean;
-```

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

@@ -1,105 +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; [BooleanFormatterParams](./grid-tabulator.booleanformatterparams.md)
-## BooleanFormatterParams 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 boolean formatter
-`isDisabled`<!-- -->: Function to determine whether the checkbox should be disabled for a specific row
-`dataTestId`<!-- -->: Data test ID for testing
-`prefix`<!-- -->: The prefix to use for the checkbox element, e.g., 'foundation', 'zero', 'rapid'. Defaults to 'foundation' if not specified.
-**Signature:**
-```typescript
-export interface BooleanFormatterParams<T = any>
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[dataTestId?](./grid-tabulator.booleanformatterparams.datatestid.md)
-</td><td>
-</td><td>
-((rowData: T) =&gt; string) \| string
-</td><td>
-**_(ALPHA)_** _(Optional)_
-</td></tr>
-<tr><td>
-[isDisabled?](./grid-tabulator.booleanformatterparams.isdisabled.md)
-</td><td>
-</td><td>
-(rowData: T) =&gt; boolean
-</td><td>
-**_(ALPHA)_** _(Optional)_
-</td></tr>
-<tr><td>
-[prefix?](./grid-tabulator.booleanformatterparams.prefix.md)
-</td><td>
-</td><td>
-string
-</td><td>
-**_(ALPHA)_** _(Optional)_
-</td></tr>
-</tbody></table>

package/docs/api/grid-tabulator.booleanformatterparams.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; [BooleanFormatterParams](./grid-tabulator.booleanformatterparams.md) &gt; [prefix](./grid-tabulator.booleanformatterparams.prefix.md)
-## BooleanFormatterParams.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.cellrendererfunc.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; [CellRendererFunc](./grid-tabulator.cellrendererfunc.md)
-## CellRendererFunc type
-Function type for cell renderer
-**Signature:**
-```typescript
-export type CellRendererFunc = (params: CellRendererParams) => HTMLElement | string;
-```
-**References:** [CellRendererParams](./grid-tabulator.cellrendererparams.md)

package/docs/api/grid-tabulator.cellrendererparams.cell.md DELETED Viewed

@@ -1,13 +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; [CellRendererParams](./grid-tabulator.cellrendererparams.md) &gt; [cell](./grid-tabulator.cellrendererparams.cell.md)
-## CellRendererParams.cell property
-The cell component
-**Signature:**
-```typescript
-cell?: CellComponent;
-```

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

@@ -1,13 +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; [CellRendererParams](./grid-tabulator.cellrendererparams.md) &gt; [data](./grid-tabulator.cellrendererparams.data.md)
-## CellRendererParams.data property
-The row data
-**Signature:**
-```typescript
-data?: any;
-```

package/docs/api/grid-tabulator.cellrendererparams.formatterparams.md DELETED Viewed

@@ -1,13 +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; [CellRendererParams](./grid-tabulator.cellrendererparams.md) &gt; [formatterParams](./grid-tabulator.cellrendererparams.formatterparams.md)
-## CellRendererParams.formatterParams property
-Additional formatter parameters
-**Signature:**
-```typescript
-formatterParams?: FormatterParams;
-```

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

@@ -1,115 +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; [CellRendererParams](./grid-tabulator.cellrendererparams.md)
-## CellRendererParams interface
-Parameters for custom cell renderers
-**Signature:**
-```typescript
-export interface CellRendererParams
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[cell?](./grid-tabulator.cellrendererparams.cell.md)
-</td><td>
-</td><td>
-CellComponent
-</td><td>
-_(Optional)_ The cell component
-</td></tr>
-<tr><td>
-[data?](./grid-tabulator.cellrendererparams.data.md)
-</td><td>
-</td><td>
-any
-</td><td>
-_(Optional)_ The row data
-</td></tr>
-<tr><td>
-[formatterParams?](./grid-tabulator.cellrendererparams.formatterparams.md)
-</td><td>
-</td><td>
-FormatterParams
-</td><td>
-_(Optional)_ Additional formatter parameters
-</td></tr>
-<tr><td>
-[value?](./grid-tabulator.cellrendererparams.value.md)
-</td><td>
-</td><td>
-any
-</td><td>
-_(Optional)_ The cell value
-</td></tr>
-</tbody></table>

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

@@ -1,13 +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; [CellRendererParams](./grid-tabulator.cellrendererparams.md) &gt; [value](./grid-tabulator.cellrendererparams.value.md)
-## CellRendererParams.value property
-The cell value
-**Signature:**
-```typescript
-value?: any;
-```

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

@@ -1,21 +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; [ColumnDefinition](./grid-tabulator.columndefinition.md)
-## ColumnDefinition type
-> 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.
->
-Extended Tabulator Column Definition with tweaked formatter type and formatterParams
-**Signature:**
-```typescript
-export type ColumnDefinition = {
-    formatter?: Formatter | FormatterTypes;
-    formatterParams?: FormatterParams;
-} & Omit<TabulatorColumnDefinition, 'formatter' | 'formatterParams'>;
-```
-**References:** [FormatterTypes](./grid-tabulator.formattertypes.md)<!-- -->, [FormatterParams](./grid-tabulator.formatterparams.md)

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

@@ -1,59 +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; [convertToKebabCase](./grid-tabulator.converttokebabcase.md)
-## convertToKebabCase() function
-> 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.
->
-Convert a string to kebab case Example: convertToKebabCase('helloWorld') // 'hello-world'
-**Signature:**
-```typescript
-export declare function convertToKebabCase(str: string): string;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-str
-</td><td>
-string
-</td><td>
-The string to convert
-</td></tr>
-</tbody></table>
-**Returns:**
-string
-The converted string