@jmruthers/pace-core 0.6.1 → 0.6.3

package/docs/api/interfaces/DataTableColumn.md

@@ -1,504 +0,0 @@
-[@jmruthers/pace-core - v0.5.192](../README.md) / [Exports](../modules.md) / DataTableColumn
-
-# Interface: DataTableColumn\<TData\>
-
-Enhanced column definition that extends TanStack's ColumnDef
-
-## Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `TData` | extends [`DataRecord`](DataRecord.md) = [`DataRecord`](DataRecord.md) |
-
-## Hierarchy
-
-- `Omit`\<`ColumnDef`\<`TData`\>, ``"id"`` \| ``"accessorKey"``\>
-
-  ↳ **`DataTableColumn`**
-
-## Table of contents
-
-### Properties
-
-- [id](DataTableColumn.md#id)
-- [accessorKey](DataTableColumn.md#accessorkey)
-- [editAccessorKey](DataTableColumn.md#editaccessorkey)
-- [header](DataTableColumn.md#header)
-- [searchable](DataTableColumn.md#searchable)
-- [sortable](DataTableColumn.md#sortable)
-- [enableColumnFilter](DataTableColumn.md#enablecolumnfilter)
-- [enableGrouping](DataTableColumn.md#enablegrouping)
-- [enableHiding](DataTableColumn.md#enablehiding)
-- [aggregate](DataTableColumn.md#aggregate)
-- [virtualizable](DataTableColumn.md#virtualizable)
-- [memoizedCell](DataTableColumn.md#memoizedcell)
-- [fieldType](DataTableColumn.md#fieldtype)
-- [fieldOptions](DataTableColumn.md#fieldoptions)
-- [selectSearchable](DataTableColumn.md#selectsearchable)
-- [creatable](DataTableColumn.md#creatable)
-- [onCreateNew](DataTableColumn.md#oncreatenew)
-- [selectMaxHeight](DataTableColumn.md#selectmaxheight)
-- [selectContentClassName](DataTableColumn.md#selectcontentclassname)
-- [selectContentStyle](DataTableColumn.md#selectcontentstyle)
-- [hideNumberSpinners](DataTableColumn.md#hidenumberspinners)
-- [filterType](DataTableColumn.md#filtertype)
-- [filterSelectOptions](DataTableColumn.md#filterselectoptions)
-- [editable](DataTableColumn.md#editable)
-- [renderForParent](DataTableColumn.md#renderforparent)
-- [renderForChild](DataTableColumn.md#renderforchild)
-- [hideForParent](DataTableColumn.md#hideforparent)
-- [hideForChild](DataTableColumn.md#hideforchild)
-- [aggregateFn](DataTableColumn.md#aggregatefn)
-- [aggregateCell](DataTableColumn.md#aggregatecell)
-
-## Properties
-
-### id
-
-• `Optional` **id**: `string`
-
-Column identifier
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:270](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L270)
-
-___
-
-### accessorKey
-
-• `Optional` **accessorKey**: `string`
-
-Accessor key for data
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:272](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L272)
-
-___
-
-### editAccessorKey
-
-• `Optional` **editAccessorKey**: `string`
-
-Alternative accessor key used while editing
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:274](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L274)
-
-___
-
-### header
-
-• **header**: `string`
-
-Custom header label for the column
-
-#### Overrides
-
-Omit.header
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:276](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L276)
-
-___
-
-### searchable
-
-• `Optional` **searchable**: `boolean`
-
-Whether this column should be searchable in global filter
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:278](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L278)
-
-___
-
-### sortable
-
-• `Optional` **sortable**: `boolean`
-
-Enable sorting
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:280](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L280)
-
-___
-
-### enableColumnFilter
-
-• `Optional` **enableColumnFilter**: `boolean`
-
-Enable column filter (inherits from ColumnDef)
-
-#### Overrides
-
-Omit.enableColumnFilter
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:282](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L282)
-
-___
-
-### enableGrouping
-
-• `Optional` **enableGrouping**: `boolean`
-
-Enable grouping (inherits from ColumnDef)
-
-#### Overrides
-
-Omit.enableGrouping
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:284](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L284)
-
-___
-
-### enableHiding
-
-• `Optional` **enableHiding**: `boolean`
-
-Enable hiding (inherits from ColumnDef)
-
-#### Overrides
-
-Omit.enableHiding
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:286](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L286)
-
-___
-
-### aggregate
-
-• `Optional` **aggregate**: [`AggregateConfig`](AggregateConfig.md)
-
-Aggregate configuration for this column
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:288](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L288)
-
-___
-
-### virtualizable
-
-• `Optional` **virtualizable**: `boolean`
-
-Enable virtual scrolling for this column
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:290](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L290)
-
-___
-
-### memoizedCell
-
-• `Optional` **memoizedCell**: `ComponentType`\<\{ `row`: `TData`  }\>
-
-Custom cell renderer with memoization
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:292](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L292)
-
-___
-
-### fieldType
-
-• `Optional` **fieldType**: ``"number"`` \| ``"boolean"`` \| ``"date"`` \| ``"text"`` \| ``"select"``
-
-Field type for editing (text, select, date, etc.)
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:294](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L294)
-
-___
-
-### fieldOptions
-
-• `Optional` **fieldOptions**: (\{ `value`: `string` \| `number` ; `label`: `string`  } \| \{ `type`: ``"group"`` ; `label`: `string` ; `items`: \{ `value`: `string` \| `number` ; `label`: `string`  }[]  } \| \{ `type`: ``"separator"``  })[]
-
-Options for select fields - can be simple items or grouped with labels and separators
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:296](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L296)
-
-___
-
-### selectSearchable
-
-• `Optional` **selectSearchable**: `boolean`
-
-Enable keyboard search/filtering in select dropdowns within editable columns (default: true). When fieldType is 'select', this controls dropdown searchability, not global search.
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:302](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L302)
-
-___
-
-### creatable
-
-• `Optional` **creatable**: `boolean`
-
-Enable creating new items in select dropdowns (default: false)
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:304](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L304)
-
-___
-
-### onCreateNew
-
-• `Optional` **onCreateNew**: (`inputValue`: `string`) => `string` \| `number` \| `Promise`\<`string` \| `number`\>
-
-Callback to create a new item when user types non-matching text in select dropdown
-
-#### Type declaration
-
-▸ (`inputValue`): `string` \| `number` \| `Promise`\<`string` \| `number`\>
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `inputValue` | `string` |
-
-##### Returns
-
-`string` \| `number` \| `Promise`\<`string` \| `number`\>
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:306](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L306)
-
-___
-
-### selectMaxHeight
-
-• `Optional` **selectMaxHeight**: `string`
-
-Maximum height for select dropdown content (default: "20rem")
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:308](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L308)
-
-___
-
-### selectContentClassName
-
-• `Optional` **selectContentClassName**: `string`
-
-Custom className for select content dropdown
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:310](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L310)
-
-___
-
-### selectContentStyle
-
-• `Optional` **selectContentStyle**: `CSSProperties`
-
-Custom style for select content dropdown
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:312](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L312)
-
-___
-
-### hideNumberSpinners
-
-• `Optional` **hideNumberSpinners**: `boolean`
-
-Hide spinner arrows on number input fields (default: true for DataTable)
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:314](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L314)
-
-___
-
-### filterType
-
-• `Optional` **filterType**: ``"number"`` \| ``"date"`` \| ``"text"`` \| ``"select"``
-
-Filter type for column filtering (text, select, number, date)
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:316](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L316)
-
-___
-
-### filterSelectOptions
-
-• `Optional` **filterSelectOptions**: \{ `value`: `string` \| `number` ; `label`: `string`  }[]
-
-Options for select filters (alternative to fieldOptions)
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:318](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L318)
-
-___
-
-### editable
-
-• `Optional` **editable**: `boolean`
-
-Whether this column is editable in edit mode (default: true)
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:320](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L320)
-
-___
-
-### renderForParent
-
-• `Optional` **renderForParent**: (`row`: `TData`) => `ReactNode`
-
-Custom renderer for parent rows
-
-#### Type declaration
-
-▸ (`row`): `ReactNode`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `row` | `TData` |
-
-##### Returns
-
-`ReactNode`
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:324](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L324)
-
-___
-
-### renderForChild
-
-• `Optional` **renderForChild**: (`row`: `TData`) => `ReactNode`
-
-Custom renderer for child rows
-
-#### Type declaration
-
-▸ (`row`): `ReactNode`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `row` | `TData` |
-
-##### Returns
-
-`ReactNode`
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:326](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L326)
-
-___
-
-### hideForParent
-
-• `Optional` **hideForParent**: `boolean`
-
-Hide this column for parent rows
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:328](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L328)
-
-___
-
-### hideForChild
-
-• `Optional` **hideForChild**: `boolean`
-
-Hide this column for child rows
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:330](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L330)
-
-___
-
-### aggregateFn
-
-• `Optional` **aggregateFn**: (`rows`: `TData`[], `column`: [`DataTableColumn`](DataTableColumn.md)\<`TData`\>) => `unknown`
-
-Aggregation function for grouped rows.
-Receives all rows in the group and returns the aggregated value.
-If not provided, grouped rows will show empty/undefined for this column.
-
-#### Type declaration
-
-▸ (`rows`, `column`): `unknown`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `rows` | `TData`[] |
-| `column` | [`DataTableColumn`](DataTableColumn.md)\<`TData`\> |
-
-##### Returns
-
-`unknown`
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:338](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L338)
-
-___
-
-### aggregateCell
-
-• `Optional` **aggregateCell**: (`value`: `unknown`, `rows`: `TData`[], `column`: [`DataTableColumn`](DataTableColumn.md)\<`TData`\>) => `ReactNode`
-
-Optional: Custom cell renderer for aggregated values in grouped rows.
-If not provided, uses the column's regular cell renderer.
-
-#### Type declaration
-
-▸ (`value`, `rows`, `column`): `ReactNode`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `value` | `unknown` |
-| `rows` | `TData`[] |
-| `column` | [`DataTableColumn`](DataTableColumn.md)\<`TData`\> |
-
-##### Returns
-
-`ReactNode`
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:343](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L343)