Skip to content

Commit 017953b

Browse files
committed
chore: package upgrades and type-doc gen
1 parent e0b876a commit 017953b

File tree

815 files changed

+35085
-3477
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

815 files changed

+35085
-3477
lines changed
Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
---
2+
id: FlexRenderCell
3+
title: FlexRenderCell
4+
---
5+
6+
# Class: FlexRenderCell\<TFeatures, TData, TValue\>
7+
8+
Defined in: [helpers/flexRenderCell.ts:62](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/flexRenderCell.ts#L62)
9+
10+
Simplified directive wrapper of `*flexRender`.
11+
12+
Use this utility component to render headers, cells, or footers with custom markup.
13+
14+
Only one prop (`cell`, `header`, or `footer`) may be passed based on the used selector.
15+
16+
## Examples
17+
18+
```html
19+
<td *flexRenderCell="cell; let cell">{{cell}}</td>
20+
<th *flexRenderHeader="header; let header">{{header}}</th>
21+
<th *flexRenderFooter="footer; let footer">{{footer}}</th>
22+
```
23+
24+
This replaces calling `*flexRender` directly like this:
25+
```html
26+
<td *flexRender="cell.column.columnDef.cell; props: cell.getContext(); let cell">{{cell}}</td>
27+
<td *flexRender="header.column.columnDef.header; props: header.getContext(); let header">{{header}}</td>
28+
<td *flexRender="footer.column.columnDef.footer; props: footer.getContext(); let footer">{{footer}}</td>
29+
```
30+
31+
Can be imported through FlexRenderCell or [FlexRender](../variables/FlexRender.md) import,
32+
which the latter is preferred.
33+
34+
```ts
35+
import {FlexRender} from '@tanstack/angular-table
36+
37+
@Component({
38+
// ...
39+
imports: [
40+
FlexRender
41+
]
42+
})
43+
```
44+
45+
## Type Parameters
46+
47+
### TFeatures
48+
49+
`TFeatures` *extends* `TableFeatures`
50+
51+
### TData
52+
53+
`TData` *extends* `RowData`
54+
55+
### TValue
56+
57+
`TValue` *extends* `CellData`
58+
59+
## Constructors
60+
61+
### Constructor
62+
63+
```ts
64+
new FlexRenderCell<TFeatures, TData, TValue>(): FlexRenderCell<TFeatures, TData, TValue>;
65+
```
66+
67+
Defined in: [helpers/flexRenderCell.ts:118](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/flexRenderCell.ts#L118)
68+
69+
#### Returns
70+
71+
`FlexRenderCell`\<`TFeatures`, `TData`, `TValue`\>
72+
73+
## Properties
74+
75+
### cell
76+
77+
```ts
78+
readonly cell: InputSignal<Cell<TFeatures, TData, TValue> | undefined>;
79+
```
80+
81+
Defined in: [helpers/flexRenderCell.ts:67](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/flexRenderCell.ts#L67)
82+
83+
***
84+
85+
### footer
86+
87+
```ts
88+
readonly footer: InputSignal<Header<TFeatures, TData, TValue> | undefined>;
89+
```
90+
91+
Defined in: [helpers/flexRenderCell.ts:75](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/flexRenderCell.ts#L75)
92+
93+
***
94+
95+
### header
96+
97+
```ts
98+
readonly header: InputSignal<Header<TFeatures, TData, TValue> | undefined>;
99+
```
100+
101+
Defined in: [helpers/flexRenderCell.ts:71](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/flexRenderCell.ts#L71)
Lines changed: 230 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,230 @@
1+
---
2+
id: FlexRenderComponentInstance
3+
title: FlexRenderComponentInstance
4+
---
5+
6+
# Class: FlexRenderComponentInstance\<TComponent\>
7+
8+
Defined in: [flex-render/flexRenderComponent.ts:259](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L259)
9+
10+
Wrapper class for a component that will be used as content for [FlexRenderDirective](FlexRenderDirective.md)
11+
12+
Prefer [flexRenderComponent](../functions/flexRenderComponent.md) helper for better type-safety
13+
14+
## Type Parameters
15+
16+
### TComponent
17+
18+
`TComponent` = `any`
19+
20+
## Implements
21+
22+
- [`FlexRenderComponent`](../interfaces/FlexRenderComponent.md)\<`TComponent`\>
23+
24+
## Constructors
25+
26+
### Constructor
27+
28+
```ts
29+
new FlexRenderComponentInstance<TComponent>(
30+
component,
31+
inputs?,
32+
injector?,
33+
outputs?,
34+
directives?,
35+
bindings?): FlexRenderComponentInstance<TComponent>;
36+
```
37+
38+
Defined in: [flex-render/flexRenderComponent.ts:266](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L266)
39+
40+
#### Parameters
41+
42+
##### component
43+
44+
`Type`\<`TComponent`\>
45+
46+
##### inputs?
47+
48+
`Inputs`\<`TComponent`\>
49+
50+
##### injector?
51+
52+
`Injector`
53+
54+
##### outputs?
55+
56+
`Outputs`\<`TComponent`\>
57+
58+
##### directives?
59+
60+
(`Type`\<`unknown`\> \| `DirectiveWithBindings`\<`unknown`\>)[]
61+
62+
##### bindings?
63+
64+
`Binding`[]
65+
66+
#### Returns
67+
68+
`FlexRenderComponentInstance`\<`TComponent`\>
69+
70+
## Properties
71+
72+
### allowedInputNames
73+
74+
```ts
75+
readonly allowedInputNames: string[] = [];
76+
```
77+
78+
Defined in: [flex-render/flexRenderComponent.ts:263](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L263)
79+
80+
List of allowed input names.
81+
82+
#### Implementation of
83+
84+
[`FlexRenderComponent`](../interfaces/FlexRenderComponent.md).[`allowedInputNames`](../interfaces/FlexRenderComponent.md#allowedinputnames)
85+
86+
***
87+
88+
### allowedOutputNames
89+
90+
```ts
91+
readonly allowedOutputNames: string[] = [];
92+
```
93+
94+
Defined in: [flex-render/flexRenderComponent.ts:264](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L264)
95+
96+
List of allowed output names.
97+
98+
#### Implementation of
99+
100+
[`FlexRenderComponent`](../interfaces/FlexRenderComponent.md).[`allowedOutputNames`](../interfaces/FlexRenderComponent.md#allowedoutputnames)
101+
102+
***
103+
104+
### bindings?
105+
106+
```ts
107+
readonly optional bindings: Binding[];
108+
```
109+
110+
Defined in: [flex-render/flexRenderComponent.ts:272](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L272)
111+
112+
Bindings to apply to the root component
113+
114+
#### See
115+
116+
FlexRenderOptions#bindings
117+
118+
#### Implementation of
119+
120+
[`FlexRenderComponent`](../interfaces/FlexRenderComponent.md).[`bindings`](../interfaces/FlexRenderComponent.md#bindings)
121+
122+
***
123+
124+
### component
125+
126+
```ts
127+
readonly component: Type<TComponent>;
128+
```
129+
130+
Defined in: [flex-render/flexRenderComponent.ts:267](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L267)
131+
132+
The component type
133+
134+
#### Implementation of
135+
136+
[`FlexRenderComponent`](../interfaces/FlexRenderComponent.md).[`component`](../interfaces/FlexRenderComponent.md#component)
137+
138+
***
139+
140+
### directives?
141+
142+
```ts
143+
readonly optional directives: (Type<unknown> | DirectiveWithBindings<unknown>)[];
144+
```
145+
146+
Defined in: [flex-render/flexRenderComponent.ts:271](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L271)
147+
148+
Directives that should be applied to the component.
149+
150+
#### See
151+
152+
#### Implementation of
153+
154+
[`FlexRenderComponent`](../interfaces/FlexRenderComponent.md).[`directives`](../interfaces/FlexRenderComponent.md#directives)
155+
156+
***
157+
158+
### injector?
159+
160+
```ts
161+
readonly optional injector: Injector;
162+
```
163+
164+
Defined in: [flex-render/flexRenderComponent.ts:269](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L269)
165+
166+
Optional Injector that will be used when rendering the component.
167+
168+
#### See
169+
170+
FlexRenderOptions#injector
171+
172+
#### Implementation of
173+
174+
[`FlexRenderComponent`](../interfaces/FlexRenderComponent.md).[`injector`](../interfaces/FlexRenderComponent.md#injector)
175+
176+
***
177+
178+
### inputs?
179+
180+
```ts
181+
readonly optional inputs: Inputs<TComponent>;
182+
```
183+
184+
Defined in: [flex-render/flexRenderComponent.ts:268](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L268)
185+
186+
Component instance inputs. Set via [componentRef.setInput API](https://angular.dev/api/core/ComponentRef#setInput))
187+
188+
#### See
189+
190+
FlexRenderOptions#inputs
191+
192+
#### Implementation of
193+
194+
[`FlexRenderComponent`](../interfaces/FlexRenderComponent.md).[`inputs`](../interfaces/FlexRenderComponent.md#inputs)
195+
196+
***
197+
198+
### mirror
199+
200+
```ts
201+
readonly mirror: ComponentMirror<TComponent>;
202+
```
203+
204+
Defined in: [flex-render/flexRenderComponent.ts:262](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L262)
205+
206+
Reflected metadata about the component.
207+
208+
#### Implementation of
209+
210+
[`FlexRenderComponent`](../interfaces/FlexRenderComponent.md).[`mirror`](../interfaces/FlexRenderComponent.md#mirror)
211+
212+
***
213+
214+
### outputs?
215+
216+
```ts
217+
readonly optional outputs: Outputs<TComponent>;
218+
```
219+
220+
Defined in: [flex-render/flexRenderComponent.ts:270](https://github.com/TanStack/table/blob/main/packages/angular-table/src/flex-render/flexRenderComponent.ts#L270)
221+
222+
Component instance outputs. Subscribed via OutputEmitterRef#subscribe
223+
224+
#### See
225+
226+
FlexRenderOptions#outputs
227+
228+
#### Implementation of
229+
230+
[`FlexRenderComponent`](../interfaces/FlexRenderComponent.md).[`outputs`](../interfaces/FlexRenderComponent.md#outputs)

0 commit comments

Comments
 (0)