@tanstack/table-core 9.0.0-beta.36 → 9.0.0-beta.38

package/dist/features/column-pinning/columnPinningFeature.utils.d.ts

@@ -25,12 +25,16 @@ declare function getDefaultColumnPinningState(): ColumnPinningState;
  * Moves this column's leaf column ids into a pinning region.
  *
  * Pinning a group column pins all of its leaves. The leaf ids are first removed
- * from both regions, then appended to the requested `'left'` or `'right'`
+ * from both regions, then appended to the requested `'start'` or `'end'`
  * region. Passing `false` unpins them back to the center.
  *
+ * `start` and `end` are logical positions. In LTR languages/layouts, `start`
+ * usually corresponds to left and `end` to right. In RTL languages/layouts,
+ * `start` usually corresponds to right and `end` to left.
+ *
  * @example
  * ```ts
- * column_pin(column, 'left')
+ * column_pin(column, 'start')
  * ```
  */
 declare function column_pin<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column<TFeatures, TData, TValue>, position: ColumnPinningPosition): void;
@@ -49,9 +53,13 @@ declare function column_getCanPin<TFeatures extends TableFeatures, TData extends
 /**
  * Reads this column's current pinning region.
  *
- * Group columns report `'left'` or `'right'` when any leaf column is pinned in
+ * Group columns report `'start'` or `'end'` when any leaf column is pinned in
  * that region. Unpinned columns return `false`.
  *
+ * `start` and `end` are logical positions. In LTR languages/layouts, `start`
+ * usually corresponds to left and `end` to right. In RTL languages/layouts,
+ * `start` usually corresponds to right and `end` to left.
+ *
  * @example
  * ```ts
  * const position = column_getIsPinned(column)
@@ -62,7 +70,7 @@ declare function column_getIsPinned<TFeatures extends TableFeatures, TData exten
  * Finds this column's index within its pinned region.
  *
  * Unpinned columns return `0`; pinned columns return their position in
- * `state.columnPinning.left` or `state.columnPinning.right`.
+ * `state.columnPinning.start` or `state.columnPinning.end`.
  *
  * @example
  * ```ts
@@ -71,7 +79,7 @@ declare function column_getIsPinned<TFeatures extends TableFeatures, TData exten
  */
 declare function column_getPinnedIndex<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column<TFeatures, TData, TValue>): number;
 /**
- * Collects visible cells whose columns are not pinned left or right.
+ * Collects visible cells whose columns are not pinned start or end.
  *
  * The result preserves the row's visible-cell order for center columns.
  *
@@ -82,38 +90,38 @@ declare function column_getPinnedIndex<TFeatures extends TableFeatures, TData ex
  */
 declare function row_getCenterVisibleCells<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): Cell<TFeatures, TData, unknown>[];
 /**
- * Collects visible cells for columns pinned to the left region.
+ * Collects visible cells for columns pinned to the start region.
  *
- * Cells are returned in `state.columnPinning.left` order and are marked with
- * `cell.position = 'left'`.
+ * Cells are returned in `state.columnPinning.start` order and are marked with
+ * `cell.position = 'start'`.
  *
  * @example
  * ```ts
- * const leftCells = row_getLeftVisibleCells(row)
+ * const startCells = row_getStartVisibleCells(row)
  * ```
  */
-declare function row_getLeftVisibleCells<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): Array<Cell<TFeatures, TData, unknown>>;
+declare function row_getStartVisibleCells<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): Array<Cell<TFeatures, TData, unknown>>;
 /**
- * Collects visible cells for columns pinned to the right region.
+ * Collects visible cells for columns pinned to the end region.
  *
- * Cells are returned in `state.columnPinning.right` order and are marked with
- * `cell.position = 'right'`.
+ * Cells are returned in `state.columnPinning.end` order and are marked with
+ * `cell.position = 'end'`.
  *
  * @example
  * ```ts
- * const rightCells = row_getRightVisibleCells(row)
+ * const endCells = row_getEndVisibleCells(row)
  * ```
  */
-declare function row_getRightVisibleCells<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): Cell<TFeatures, TData, unknown>[];
+declare function row_getEndVisibleCells<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): Cell<TFeatures, TData, unknown>[];
 /**
  * Routes a column pinning updater through the table's pinning change handler.
  *
- * The updater may be a next `{ left, right }` state or a function of the
+ * The updater may be a next `{ start, end }` state or a function of the
  * previous state, matching the instance `table.setColumnPinning` behavior.
  *
  * @example
  * ```ts
- * table_setColumnPinning(table, (old) => ({ ...old, left: ['select'] }))
+ * table_setColumnPinning(table, (old) => ({ ...old, start: ['select'] }))
  * ```
  */
 declare function table_setColumnPinning<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>, updater: Updater<ColumnPinningState>): void;
@@ -121,7 +129,7 @@ declare function table_setColumnPinning<TFeatures extends TableFeatures, TData e
  * Resets `columnPinning` to the configured initial state or feature default.
  *
  * With no argument, the reset clones `table.initialState.columnPinning` when it
- * exists. Passing `true` ignores initial state and resets to empty left/right
+ * exists. Passing `true` ignores initial state and resets to empty start/end
  * arrays.
  *
  * @example
@@ -134,7 +142,7 @@ declare function table_resetColumnPinning<TFeatures extends TableFeatures, TData
 /**
  * Checks whether any columns are pinned.
  *
- * Omit `position` to check both sides, or pass `'left'`/`'right'` to inspect a
+ * Omit `position` to check both sides, or pass `'start'`/`'end'` to inspect a
  * single pinning region.
  *
  * @example
@@ -144,33 +152,33 @@ declare function table_resetColumnPinning<TFeatures extends TableFeatures, TData
  */
 declare function table_getIsSomeColumnsPinned<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>, position?: ColumnPinningPosition): boolean;
 /**
- * Builds header groups for visible columns pinned to the left region.
+ * Builds header groups for visible columns pinned to the start region.
  *
- * The leaf columns are read in `state.columnPinning.left` order and then passed
+ * The leaf columns are read in `state.columnPinning.start` order and then passed
  * through the same header-group builder as the unpinned table.
  *
  * @example
  * ```ts
- * const headerGroups = table_getLeftHeaderGroups(table)
+ * const headerGroups = table_getStartHeaderGroups(table)
  * ```
  */
-declare function table_getLeftHeaderGroups<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): HeaderGroup<TFeatures, TData>[];
+declare function table_getStartHeaderGroups<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): HeaderGroup<TFeatures, TData>[];
 /**
- * Builds header groups for visible columns pinned to the right region.
+ * Builds header groups for visible columns pinned to the end region.
  *
- * The leaf columns are read in `state.columnPinning.right` order and then
+ * The leaf columns are read in `state.columnPinning.end` order and then
  * passed through the same header-group builder as the unpinned table.
  *
  * @example
  * ```ts
- * const headerGroups = table_getRightHeaderGroups(table)
+ * const headerGroups = table_getEndHeaderGroups(table)
  * ```
  */
-declare function table_getRightHeaderGroups<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): HeaderGroup<TFeatures, TData>[];
+declare function table_getEndHeaderGroups<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): HeaderGroup<TFeatures, TData>[];
 /**
  * Builds header groups for visible columns that are not pinned.
  *
- * Left- and right-pinned column ids are removed from the visible leaf column
+ * Start- and end-pinned column ids are removed from the visible leaf column
  * list before header groups are built for the center region.
  *
  * @example
@@ -180,27 +188,27 @@ declare function table_getRightHeaderGroups<TFeatures extends TableFeatures, TDa
  */
 declare function table_getCenterHeaderGroups<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): Array<HeaderGroup<TFeatures, TData>>;
 /**
- * Builds footer groups for the left pinned region.
+ * Builds footer groups for the start pinned region.
  *
- * Footer groups reuse the left header groups in reverse order.
+ * Footer groups reuse the start header groups in reverse order.
  *
  * @example
  * ```ts
- * const footerGroups = table_getLeftFooterGroups(table)
+ * const footerGroups = table_getStartFooterGroups(table)
  * ```
  */
-declare function table_getLeftFooterGroups<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): HeaderGroup<TFeatures, TData>[];
+declare function table_getStartFooterGroups<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): HeaderGroup<TFeatures, TData>[];
 /**
- * Builds footer groups for the right pinned region.
+ * Builds footer groups for the end pinned region.
  *
- * Footer groups reuse the right header groups in reverse order.
+ * Footer groups reuse the end header groups in reverse order.
  *
  * @example
  * ```ts
- * const footerGroups = table_getRightFooterGroups(table)
+ * const footerGroups = table_getEndFooterGroups(table)
  * ```
  */
-declare function table_getRightFooterGroups<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): HeaderGroup<TFeatures, TData>[];
+declare function table_getEndFooterGroups<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): HeaderGroup<TFeatures, TData>[];
 /**
  * Builds footer groups for the center, unpinned region.
  *
@@ -213,27 +221,27 @@ declare function table_getRightFooterGroups<TFeatures extends TableFeatures, TDa
  */
 declare function table_getCenterFooterGroups<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): HeaderGroup<TFeatures, TData>[];
 /**
- * Flattens every header from the left pinned header groups.
+ * Flattens every header from the start pinned header groups.
  *
  * Parent headers and placeholder headers are included.
  *
  * @example
  * ```ts
- * const headers = table_getLeftFlatHeaders(table)
+ * const headers = table_getStartFlatHeaders(table)
  * ```
  */
-declare function table_getLeftFlatHeaders<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): Header<TFeatures, TData, unknown>[];
+declare function table_getStartFlatHeaders<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): Header<TFeatures, TData, unknown>[];
 /**
- * Flattens every header from the right pinned header groups.
+ * Flattens every header from the end pinned header groups.
  *
  * Parent headers and placeholder headers are included.
  *
  * @example
  * ```ts
- * const headers = table_getRightFlatHeaders(table)
+ * const headers = table_getEndFlatHeaders(table)
  * ```
  */
-declare function table_getRightFlatHeaders<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): Header<TFeatures, TData, unknown>[];
+declare function table_getEndFlatHeaders<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): Header<TFeatures, TData, unknown>[];
 /**
  * Flattens every header from the center header groups.
  *
@@ -246,27 +254,27 @@ declare function table_getRightFlatHeaders<TFeatures extends TableFeatures, TDat
  */
 declare function table_getCenterFlatHeaders<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): Header<TFeatures, TData, unknown>[];
 /**
- * Collects leaf headers for the left pinned region.
+ * Collects leaf headers for the start pinned region.
  *
- * Parent headers are filtered out from the left flat header list.
+ * Parent headers are filtered out from the start flat header list.
  *
  * @example
  * ```ts
- * const headers = table_getLeftLeafHeaders(table)
+ * const headers = table_getStartLeafHeaders(table)
  * ```
  */
-declare function table_getLeftLeafHeaders<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): Header<TFeatures, TData, unknown>[];
+declare function table_getStartLeafHeaders<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): Header<TFeatures, TData, unknown>[];
 /**
- * Collects leaf headers for the right pinned region.
+ * Collects leaf headers for the end pinned region.
  *
- * Parent headers are filtered out from the right flat header list.
+ * Parent headers are filtered out from the end flat header list.
  *
  * @example
  * ```ts
- * const headers = table_getRightLeafHeaders(table)
+ * const headers = table_getEndLeafHeaders(table)
  * ```
  */
-declare function table_getRightLeafHeaders<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): Header<TFeatures, TData, unknown>[];
+declare function table_getEndLeafHeaders<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): Header<TFeatures, TData, unknown>[];
 /**
  * Collects leaf headers for the center, unpinned region.
  *
@@ -279,33 +287,33 @@ declare function table_getRightLeafHeaders<TFeatures extends TableFeatures, TDat
  */
 declare function table_getCenterLeafHeaders<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): Header<TFeatures, TData, unknown>[];
 /**
- * Resolves leaf columns pinned to the left region.
+ * Resolves leaf columns pinned to the start region.
  *
- * The result follows `state.columnPinning.left` order and skips stale ids that
+ * The result follows `state.columnPinning.start` order and skips stale ids that
  * no longer correspond to a leaf column.
  *
  * @example
  * ```ts
- * const columns = table_getLeftLeafColumns(table)
+ * const columns = table_getStartLeafColumns(table)
  * ```
  */
-declare function table_getLeftLeafColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): Column<TFeatures, TData, unknown>[];
+declare function table_getStartLeafColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): Column<TFeatures, TData, unknown>[];
 /**
- * Resolves leaf columns pinned to the right region.
+ * Resolves leaf columns pinned to the end region.
  *
- * The result follows `state.columnPinning.right` order and skips stale ids that
+ * The result follows `state.columnPinning.end` order and skips stale ids that
  * no longer correspond to a leaf column.
  *
  * @example
  * ```ts
- * const columns = table_getRightLeafColumns(table)
+ * const columns = table_getEndLeafColumns(table)
  * ```
  */
-declare function table_getRightLeafColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): Column<TFeatures, TData, unknown>[];
+declare function table_getEndLeafColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): Column<TFeatures, TData, unknown>[];
 /**
- * Resolves leaf columns that are not pinned to either side.
+ * Resolves leaf columns that are not pinned to either logical side.
  *
- * Left- and right-pinned ids are removed from `table.getAllLeafColumns()`.
+ * Start- and end-pinned ids are removed from `table.getAllLeafColumns()`.
  *
  * @example
  * ```ts
@@ -316,7 +324,7 @@ declare function table_getCenterLeafColumns<TFeatures extends TableFeatures, TDa
 /**
  * Resolves leaf columns for a requested pinning region.
  *
- * Pass `'left'`, `'center'`, or `'right'` for a partition, or pass `false` to
+ * Pass `'start'`, `'center'`, or `'end'` for a partition, or pass `false` to
  * read all leaf columns without partitioning.
  *
  * @example
@@ -326,27 +334,27 @@ declare function table_getCenterLeafColumns<TFeatures extends TableFeatures, TDa
  */
 declare function table_getPinnedLeafColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>, position: ColumnPinningPosition | 'center'): Column<TFeatures, TData, unknown>[] | Column<TFeatures, TData, unknown>[];
 /**
- * Resolves visible leaf columns pinned to the left region.
+ * Resolves visible leaf columns pinned to the start region.
  *
- * Hidden pinned columns are filtered out after the left pin order is applied.
+ * Hidden pinned columns are filtered out after the start pin order is applied.
  *
  * @example
  * ```ts
- * const columns = table_getLeftVisibleLeafColumns(table)
+ * const columns = table_getStartVisibleLeafColumns(table)
  * ```
  */
-declare function table_getLeftVisibleLeafColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): Column<TFeatures, TData, unknown>[];
+declare function table_getStartVisibleLeafColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): Column<TFeatures, TData, unknown>[];
 /**
- * Resolves visible leaf columns pinned to the right region.
+ * Resolves visible leaf columns pinned to the end region.
  *
- * Hidden pinned columns are filtered out after the right pin order is applied.
+ * Hidden pinned columns are filtered out after the end pin order is applied.
  *
  * @example
  * ```ts
- * const columns = table_getRightVisibleLeafColumns(table)
+ * const columns = table_getEndVisibleLeafColumns(table)
  * ```
  */
-declare function table_getRightVisibleLeafColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): Column<TFeatures, TData, unknown>[];
+declare function table_getEndVisibleLeafColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): Column<TFeatures, TData, unknown>[];
 /**
  * Resolves visible leaf columns that are not pinned.
  *
@@ -362,15 +370,15 @@ declare function table_getCenterVisibleLeafColumns<TFeatures extends TableFeatur
 /**
  * Resolves visible leaf columns for a requested pinning region.
  *
- * Omit `position` to get all visible leaf columns, or pass `'left'`, `'center'`,
- * or `'right'` to get one partition.
+ * Omit `position` to get all visible leaf columns, or pass `'start'`, `'center'`,
+ * or `'end'` to get one partition.
  *
  * @example
  * ```ts
- * const columns = table_getPinnedVisibleLeafColumns(table, 'left')
+ * const columns = table_getPinnedVisibleLeafColumns(table, 'start')
  * ```
  */
 declare function table_getPinnedVisibleLeafColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>, position?: ColumnPinningPosition | 'center'): Column<TFeatures, TData, unknown>[] | Column<TFeatures, TData, unknown>[];
 //#endregion
-export { column_getCanPin, column_getIsPinned, column_getPinnedIndex, column_pin, getDefaultColumnPinningState, row_getCenterVisibleCells, row_getLeftVisibleCells, row_getRightVisibleCells, table_getCenterFlatHeaders, table_getCenterFooterGroups, table_getCenterHeaderGroups, table_getCenterLeafColumns, table_getCenterLeafHeaders, table_getCenterVisibleLeafColumns, table_getIsSomeColumnsPinned, table_getLeftFlatHeaders, table_getLeftFooterGroups, table_getLeftHeaderGroups, table_getLeftLeafColumns, table_getLeftLeafHeaders, table_getLeftVisibleLeafColumns, table_getPinnedLeafColumns, table_getPinnedVisibleLeafColumns, table_getRightFlatHeaders, table_getRightFooterGroups, table_getRightHeaderGroups, table_getRightLeafColumns, table_getRightLeafHeaders, table_getRightVisibleLeafColumns, table_resetColumnPinning, table_setColumnPinning };
+export { column_getCanPin, column_getIsPinned, column_getPinnedIndex, column_pin, getDefaultColumnPinningState, row_getCenterVisibleCells, row_getEndVisibleCells, row_getStartVisibleCells, table_getCenterFlatHeaders, table_getCenterFooterGroups, table_getCenterHeaderGroups, table_getCenterLeafColumns, table_getCenterLeafHeaders, table_getCenterVisibleLeafColumns, table_getEndFlatHeaders, table_getEndFooterGroups, table_getEndHeaderGroups, table_getEndLeafColumns, table_getEndLeafHeaders, table_getEndVisibleLeafColumns, table_getIsSomeColumnsPinned, table_getPinnedLeafColumns, table_getPinnedVisibleLeafColumns, table_getStartFlatHeaders, table_getStartFooterGroups, table_getStartHeaderGroups, table_getStartLeafColumns, table_getStartLeafHeaders, table_getStartVisibleLeafColumns, table_resetColumnPinning, table_setColumnPinning };
 //# sourceMappingURL=columnPinningFeature.utils.d.ts.map