Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 0 additions & 1 deletion docs/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -733,7 +733,6 @@
{ "label": "passiveEventSupported", "to": "reference/static-functions/functions/passiveEventSupported" },
{ "label": "row_getAllCells", "to": "reference/static-functions/functions/row_getAllCells" },
{ "label": "row_getAllCellsByColumnId", "to": "reference/static-functions/functions/row_getAllCellsByColumnId" },
{ "label": "row_getAllVisibleCells", "to": "reference/static-functions/functions/row_getAllVisibleCells" },
{ "label": "row_getCanExpand", "to": "reference/static-functions/functions/row_getCanExpand" },
{ "label": "row_getCanMultiSelect", "to": "reference/static-functions/functions/row_getCanMultiSelect" },
{ "label": "row_getCanPin", "to": "reference/static-functions/functions/row_getCanPin" },
Expand Down
10 changes: 5 additions & 5 deletions docs/framework/angular/reference/classes/FlexRenderCell.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: FlexRenderCell

# Class: FlexRenderCell\<TFeatures, TData, TValue\>

Defined in: [helpers/flexRenderCell.ts:62](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/flexRenderCell.ts#L62)
Defined in: [packages/angular-table/src/helpers/flexRenderCell.ts:62](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/flexRenderCell.ts#L62)

Simplified directive wrapper of `*flexRender`.

Expand Down Expand Up @@ -64,7 +64,7 @@ import {FlexRender} from '@tanstack/angular-table
new FlexRenderCell<TFeatures, TData, TValue>(): FlexRenderCell<TFeatures, TData, TValue>;
```

Defined in: [helpers/flexRenderCell.ts:118](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/flexRenderCell.ts#L118)
Defined in: [packages/angular-table/src/helpers/flexRenderCell.ts:118](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/flexRenderCell.ts#L118)

#### Returns

Expand All @@ -78,7 +78,7 @@ Defined in: [helpers/flexRenderCell.ts:118](https://github.com/TanStack/table/bl
readonly cell: InputSignal<Cell<TFeatures, TData, TValue> | undefined>;
```

Defined in: [helpers/flexRenderCell.ts:67](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/flexRenderCell.ts#L67)
Defined in: [packages/angular-table/src/helpers/flexRenderCell.ts:67](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/flexRenderCell.ts#L67)

***

Expand All @@ -88,7 +88,7 @@ Defined in: [helpers/flexRenderCell.ts:67](https://github.com/TanStack/table/blo
readonly footer: InputSignal<Header<TFeatures, TData, TValue> | undefined>;
```

Defined in: [helpers/flexRenderCell.ts:75](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/flexRenderCell.ts#L75)
Defined in: [packages/angular-table/src/helpers/flexRenderCell.ts:75](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/flexRenderCell.ts#L75)

***

Expand All @@ -98,4 +98,4 @@ Defined in: [helpers/flexRenderCell.ts:75](https://github.com/TanStack/table/blo
readonly header: InputSignal<Header<TFeatures, TData, TValue> | undefined>;
```

Defined in: [helpers/flexRenderCell.ts:71](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/flexRenderCell.ts#L71)
Defined in: [packages/angular-table/src/helpers/flexRenderCell.ts:71](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/flexRenderCell.ts#L71)
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: FlexRenderComponentInstance

# Class: FlexRenderComponentInstance\<TComponent\>

Defined in: [flex-render/flexRenderComponent.ts:259](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L259)
Defined in: [packages/angular-table/src/flex-render/flexRenderComponent.ts:259](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L259)

Wrapper class for a component that will be used as content for [FlexRenderDirective](FlexRenderDirective.md)

Expand All @@ -27,15 +27,15 @@ Prefer [flexRenderComponent](../functions/flexRenderComponent.md) helper for bet

```ts
new FlexRenderComponentInstance<TComponent>(
component,
inputs?,
injector?,
outputs?,
directives?,
component,
inputs?,
injector?,
outputs?,
directives?,
bindings?): FlexRenderComponentInstance<TComponent>;
```

Defined in: [flex-render/flexRenderComponent.ts:266](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L266)
Defined in: [packages/angular-table/src/flex-render/flexRenderComponent.ts:266](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L266)

#### Parameters

Expand Down Expand Up @@ -75,7 +75,7 @@ Defined in: [flex-render/flexRenderComponent.ts:266](https://github.com/TanStack
readonly allowedInputNames: string[] = [];
```

Defined in: [flex-render/flexRenderComponent.ts:263](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L263)
Defined in: [packages/angular-table/src/flex-render/flexRenderComponent.ts:263](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L263)

List of allowed input names.

Expand All @@ -91,7 +91,7 @@ List of allowed input names.
readonly allowedOutputNames: string[] = [];
```

Defined in: [flex-render/flexRenderComponent.ts:264](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L264)
Defined in: [packages/angular-table/src/flex-render/flexRenderComponent.ts:264](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L264)

List of allowed output names.

Expand All @@ -107,7 +107,7 @@ List of allowed output names.
readonly optional bindings: Binding[];
```

Defined in: [flex-render/flexRenderComponent.ts:272](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L272)
Defined in: [packages/angular-table/src/flex-render/flexRenderComponent.ts:272](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L272)

Bindings to apply to the root component

Expand All @@ -127,7 +127,7 @@ FlexRenderOptions#bindings
readonly component: Type<TComponent>;
```

Defined in: [flex-render/flexRenderComponent.ts:267](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L267)
Defined in: [packages/angular-table/src/flex-render/flexRenderComponent.ts:267](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L267)

The component type

Expand All @@ -143,7 +143,7 @@ The component type
readonly optional directives: (Type<unknown> | DirectiveWithBindings<unknown>)[];
```

Defined in: [flex-render/flexRenderComponent.ts:271](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L271)
Defined in: [packages/angular-table/src/flex-render/flexRenderComponent.ts:271](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L271)

Directives that should be applied to the component.

Expand All @@ -161,7 +161,7 @@ Directives that should be applied to the component.
readonly optional injector: Injector;
```

Defined in: [flex-render/flexRenderComponent.ts:269](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L269)
Defined in: [packages/angular-table/src/flex-render/flexRenderComponent.ts:269](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L269)

Optional Injector that will be used when rendering the component.

Expand All @@ -181,7 +181,7 @@ FlexRenderOptions#injector
readonly optional inputs: Inputs<TComponent>;
```

Defined in: [flex-render/flexRenderComponent.ts:268](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L268)
Defined in: [packages/angular-table/src/flex-render/flexRenderComponent.ts:268](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L268)

Component instance inputs. Set via [componentRef.setInput API](https://angular.dev/api/core/ComponentRef#setInput))

Expand All @@ -201,7 +201,7 @@ FlexRenderOptions#inputs
readonly mirror: ComponentMirror<TComponent>;
```

Defined in: [flex-render/flexRenderComponent.ts:262](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L262)
Defined in: [packages/angular-table/src/flex-render/flexRenderComponent.ts:262](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L262)

Reflected metadata about the component.

Expand All @@ -217,7 +217,7 @@ Reflected metadata about the component.
readonly optional outputs: Outputs<TComponent>;
```

Defined in: [flex-render/flexRenderComponent.ts:270](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L270)
Defined in: [packages/angular-table/src/flex-render/flexRenderComponent.ts:270](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L270)

Component instance outputs. Subscribed via OutputEmitterRef#subscribe

Expand Down
12 changes: 6 additions & 6 deletions docs/framework/angular/reference/classes/FlexRenderDirective.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: FlexRenderDirective

# Class: FlexRenderDirective\<TFeatures, TRowData, TValue, TProps\>

Defined in: [flexRender.ts:84](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flexRender.ts#L84)
Defined in: [packages/angular-table/src/flexRender.ts:84](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flexRender.ts#L84)

Use this utility directive to render headers, cells, or footers with custom markup.

Expand Down Expand Up @@ -71,7 +71,7 @@ which the latter is preferred.

### TProps

`TProps` *extends*
`TProps` *extends*
\| `NonNullable`\<`unknown`\>
\| `CellContext`\<`TFeatures`, `TRowData`, `TValue`\>
\| `HeaderContext`\<`TFeatures`, `TRowData`, `TValue`\>
Expand All @@ -84,7 +84,7 @@ which the latter is preferred.
new FlexRenderDirective<TFeatures, TRowData, TValue, TProps>(): FlexRenderDirective<TFeatures, TRowData, TValue, TProps>;
```

Defined in: [flexRender.ts:109](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flexRender.ts#L109)
Defined in: [packages/angular-table/src/flexRender.ts:109](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flexRender.ts#L109)

#### Returns

Expand All @@ -98,7 +98,7 @@ Defined in: [flexRender.ts:109](https://github.com/TanStack/table/blob/main/pack
readonly content: InputSignal<FlexRenderInputContent<TProps>>;
```

Defined in: [flexRender.ts:93](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flexRender.ts#L93)
Defined in: [packages/angular-table/src/flexRender.ts:93](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flexRender.ts#L93)

***

Expand All @@ -108,7 +108,7 @@ Defined in: [flexRender.ts:93](https://github.com/TanStack/table/blob/main/packa
readonly injector: InputSignal<Injector>;
```

Defined in: [flexRender.ts:102](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flexRender.ts#L102)
Defined in: [packages/angular-table/src/flexRender.ts:102](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flexRender.ts#L102)

***

Expand All @@ -118,4 +118,4 @@ Defined in: [flexRender.ts:102](https://github.com/TanStack/table/blob/main/pack
readonly props: InputSignal<TProps>;
```

Defined in: [flexRender.ts:98](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flexRender.ts#L98)
Defined in: [packages/angular-table/src/flexRender.ts:98](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flexRender.ts#L98)
4 changes: 2 additions & 2 deletions docs/framework/angular/reference/classes/TanStackTable.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: TanStackTable

# Class: TanStackTable\<TFeatures, TData\>

Defined in: [helpers/table.ts:59](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/table.ts#L59)
Defined in: [packages/angular-table/src/helpers/table.ts:59](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/table.ts#L59)

Provides a TanStack Table instance (`AngularTable`) in Angular DI.

Expand Down Expand Up @@ -71,7 +71,7 @@ new TanStackTable<TFeatures, TData>(): TanStackTable<TFeatures, TData>;
readonly table: InputSignal<AngularTable<TFeatures, TData>>;
```

Defined in: [helpers/table.ts:68](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/table.ts#L68)
Defined in: [packages/angular-table/src/helpers/table.ts:68](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/table.ts#L68)

The current TanStack Table instance.

Expand Down
4 changes: 2 additions & 2 deletions docs/framework/angular/reference/classes/TanStackTableCell.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: TanStackTableCell

# Class: TanStackTableCell\<TFeatures, TData, TValue\>

Defined in: [helpers/cell.ts:76](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/cell.ts#L76)
Defined in: [packages/angular-table/src/helpers/cell.ts:76](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/cell.ts#L76)

Provides a TanStack Table `Cell` instance in Angular DI.

Expand Down Expand Up @@ -81,7 +81,7 @@ new TanStackTableCell<TFeatures, TData, TValue>(): TanStackTableCell<TFeatures,
readonly cell: InputSignal<Cell<TFeatures, TData, TValue>>;
```

Defined in: [helpers/cell.ts:86](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/cell.ts#L86)
Defined in: [packages/angular-table/src/helpers/cell.ts:86](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/cell.ts#L86)

The current TanStack Table cell.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: TanStackTableHeader

# Class: TanStackTableHeader\<TFeatures, TData, TValue\>

Defined in: [helpers/header.ts:71](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/header.ts#L71)
Defined in: [packages/angular-table/src/helpers/header.ts:71](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/header.ts#L71)

Provides a TanStack Table `Header` instance in Angular DI.

Expand Down Expand Up @@ -77,7 +77,7 @@ new TanStackTableHeader<TFeatures, TData, TValue>(): TanStackTableHeader<TFeatur
readonly header: InputSignal<Header<TFeatures, TData, TValue>>;
```

Defined in: [helpers/header.ts:81](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/header.ts#L81)
Defined in: [packages/angular-table/src/helpers/header.ts:81](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/header.ts#L81)

The current TanStack Table header.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: createTableHook
function createTableHook<TFeatures, TTableComponents, TCellComponents, THeaderComponents>(__namedParameters): CreateTableHookResult<TFeatures, TTableComponents, TCellComponents, THeaderComponents>;
```

Defined in: [helpers/createTableHook.ts:368](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/createTableHook.ts#L368)
Defined in: [packages/angular-table/src/helpers/createTableHook.ts:368](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/createTableHook.ts#L368)

Creates app-scoped Angular table helpers with features, row models, and
renderable component maps pre-bound.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: flexRenderComponent
function flexRenderComponent<TComponent>(component, options?): FlexRenderComponent<TComponent>;
```

Defined in: [flex-render/flexRenderComponent.ts:150](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L150)
Defined in: [packages/angular-table/src/flex-render/flexRenderComponent.ts:150](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L150)

Helper function to create a [FlexRenderComponent](../interfaces/FlexRenderComponent.md) instance, with better type-safety.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: injectFlexRenderContext
function injectFlexRenderContext<T>(): T;
```

Defined in: [flex-render/context.ts:12](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/context.ts#L12)
Defined in: [packages/angular-table/src/flex-render/context.ts:12](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/context.ts#L12)

Inject the flex render context props.

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/angular/reference/functions/injectTable.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: injectTable
function injectTable<TFeatures, TData>(options): AngularTable<TFeatures, TData>;
```

Defined in: [injectTable.ts:91](https://github.com/TanStack/table/blob/main/packages/angular-table/src/injectTable.ts#L91)
Defined in: [packages/angular-table/src/injectTable.ts:91](https://github.com/TanStack/table/blob/main/packages/angular-table/src/injectTable.ts#L91)

Creates and returns an Angular-reactive table instance.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: injectTableCellContext
function injectTableCellContext<TFeatures, TData, TValue>(): Signal<Cell<TFeatures, TData, TValue>>;
```

Defined in: [helpers/cell.ts:98](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/cell.ts#L98)
Defined in: [packages/angular-table/src/helpers/cell.ts:98](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/cell.ts#L98)

Injects the current TanStack Table cell signal.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: injectTableContext
function injectTableContext<TFeatures, TData>(): Signal<AngularTable<TFeatures, TData>>;
```

Defined in: [helpers/table.ts:80](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/table.ts#L80)
Defined in: [packages/angular-table/src/helpers/table.ts:80](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/table.ts#L80)

Injects the current TanStack Table instance signal.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: injectTableHeaderContext
function injectTableHeaderContext<TFeatures, TData, TValue>(): Signal<Header<TFeatures, TData, TValue>>;
```

Defined in: [helpers/header.ts:93](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/header.ts#L93)
Defined in: [packages/angular-table/src/helpers/header.ts:93](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/header.ts#L93)

Injects the current TanStack Table header signal.

Expand Down
Loading
Loading