-
-
Notifications
You must be signed in to change notification settings - Fork 3.1k
/
Copy pathflex-render.ts
331 lines (300 loc) · 9.55 KB
/
flex-render.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
import type { EffectRef } from '@angular/core'
import {
ChangeDetectorRef,
Directive,
DoCheck,
effect,
Inject,
inject,
Injector,
Input,
OnChanges,
runInInjectionContext,
SimpleChanges,
TemplateRef,
Type,
ViewContainerRef,
} from '@angular/core'
import type {
CellContext,
HeaderContext,
Table,
TableFeatures,
} from '@tanstack/table-core'
import { memo } from '@tanstack/table-core'
import { FlexRenderComponentProps } from './flex-render/context'
import { FlexRenderFlags } from './flex-render/flags'
import {
FlexRenderComponent,
flexRenderComponent,
} from './flex-render/flex-render-component'
import { FlexRenderComponentFactory } from './flex-render/flex-render-component-ref'
import type { FlexRenderTypedContent } from './flex-render/view'
import {
FlexRenderComponentView,
FlexRenderTemplateView,
FlexRenderView,
mapToFlexRenderTypedContent,
} from './flex-render/view'
export {
injectFlexRenderContext,
type FlexRenderComponentProps,
} from './flex-render/context'
export type FlexRenderContent<TProps extends NonNullable<unknown>> =
| string
| number
| Type<TProps>
| FlexRenderComponent<TProps>
| TemplateRef<{ $implicit: TProps }>
| null
| Record<any, any>
| undefined
@Directive({
selector: '[flexRender]',
standalone: true,
providers: [FlexRenderComponentFactory],
})
export class FlexRenderDirective<
TProps extends
| NonNullable<unknown>
| CellContext<TableFeatures, any>
| HeaderContext<TableFeatures, any>,
>
implements OnChanges, DoCheck
{
readonly #flexRenderComponentFactory = inject(FlexRenderComponentFactory)
readonly #changeDetectorRef = inject(ChangeDetectorRef)
@Input({ required: true, alias: 'flexRender' })
content:
| number
| string
| ((props: TProps) => FlexRenderContent<TProps>)
| null
| undefined = undefined
@Input({ required: true, alias: 'flexRenderProps' })
props: TProps = {} as TProps
@Input({ required: false, alias: 'flexRenderNotifier' })
notifier: 'doCheck' | 'tableChange' = 'tableChange'
@Input({ required: false, alias: 'flexRenderInjector' })
injector: Injector = inject(Injector)
table: Table<TableFeatures, any>
renderFlags = FlexRenderFlags.ViewFirstRender
renderView: FlexRenderView<any> | null = null
readonly #latestContent = () => {
const { content, props } = this
return typeof content !== 'function'
? content
: runInInjectionContext(this.injector, () => content(props))
}
#getContentValue = memo({
memoDeps: () => [this.#latestContent(), this.props, this.content],
fn: (latestContent) => {
return mapToFlexRenderTypedContent(latestContent)
},
})
constructor(
@Inject(ViewContainerRef)
private readonly viewContainerRef: ViewContainerRef,
@Inject(TemplateRef)
private readonly templateRef: TemplateRef<any>,
) {}
ngOnChanges(changes: SimpleChanges) {
if (changes['props']) {
this.table = 'table' in this.props ? this.props.table : null
this.renderFlags |= FlexRenderFlags.PropsReferenceChanged
this.bindTableDirtyCheck()
}
if (changes['content']) {
this.renderFlags |=
FlexRenderFlags.ContentChanged | FlexRenderFlags.ViewFirstRender
this.update()
}
}
ngDoCheck(): void {
if (this.renderFlags & FlexRenderFlags.ViewFirstRender) {
// On the initial render, the view is created during the `ngOnChanges` hook.
// Since `ngDoCheck` is called immediately afterward, there's no need to check for changes in this phase.
this.renderFlags &= ~FlexRenderFlags.ViewFirstRender
return
}
if (this.notifier === 'doCheck') {
this.renderFlags |= FlexRenderFlags.DirtyCheck
this.doCheck()
}
}
private doCheck() {
const latestContent = this.#getContentValue()
if (latestContent.kind === 'null' || !this.renderView) {
this.renderFlags |= FlexRenderFlags.ContentChanged
} else {
this.renderView.content = latestContent
const { kind: previousKind } = this.renderView.previousContent
if (latestContent.kind !== previousKind) {
this.renderFlags |= FlexRenderFlags.ContentChanged
}
}
this.update()
}
#tableChangeEffect: EffectRef | null = null
private bindTableDirtyCheck() {
this.#tableChangeEffect?.destroy()
this.#tableChangeEffect = null
let firstCheck = !!(this.renderFlags & FlexRenderFlags.ViewFirstRender)
if (this.table && this.notifier === 'tableChange') {
this.#tableChangeEffect = effect(
() => {
this.table.get()
if (firstCheck) {
firstCheck = false
return
}
this.renderFlags |= FlexRenderFlags.DirtyCheck
this.doCheck()
},
{ injector: this.injector, forceRoot: true },
)
}
}
update() {
if (
this.renderFlags &
(FlexRenderFlags.ContentChanged | FlexRenderFlags.ViewFirstRender)
) {
this.render()
return
}
if (this.renderFlags & FlexRenderFlags.PropsReferenceChanged) {
if (this.renderView) this.renderView.updateProps(this.props)
this.renderFlags &= ~FlexRenderFlags.PropsReferenceChanged
}
if (
this.renderFlags &
(FlexRenderFlags.DirtyCheck | FlexRenderFlags.DirtySignal)
) {
if (this.renderView) this.renderView.dirtyCheck()
this.renderFlags &= ~(
FlexRenderFlags.DirtyCheck | FlexRenderFlags.DirtySignal
)
}
}
#currentEffectRef: EffectRef | null = null
render() {
if (this.#shouldRecreateEntireView() && this.#currentEffectRef) {
this.#currentEffectRef.destroy()
this.#currentEffectRef = null
this.renderFlags &= ~FlexRenderFlags.RenderEffectChecked
}
this.viewContainerRef.clear()
this.renderFlags =
FlexRenderFlags.Pristine |
(this.renderFlags & FlexRenderFlags.ViewFirstRender) |
(this.renderFlags & FlexRenderFlags.RenderEffectChecked)
const resolvedContent = this.#getContentValue()
if (resolvedContent.kind === 'null') {
this.renderView = null
} else {
this.renderView = this.#renderViewByContent(resolvedContent)
}
// If the content is a function `content(props)`, we initialize an effect
// in order to react to changes if the given definition use signals.
if (!this.#currentEffectRef && typeof this.content === 'function') {
this.#currentEffectRef = effect(
() => {
this.#latestContent()
if (!(this.renderFlags & FlexRenderFlags.RenderEffectChecked)) {
this.renderFlags |= FlexRenderFlags.RenderEffectChecked
return
}
this.renderFlags |= FlexRenderFlags.DirtySignal
// This will mark the view as changed,
// so we'll try to check for updates into ngDoCheck
this.#changeDetectorRef.markForCheck()
},
{ injector: this.viewContainerRef.injector },
)
}
}
#shouldRecreateEntireView() {
return (
this.renderFlags &
FlexRenderFlags.ContentChanged &
FlexRenderFlags.ViewFirstRender
)
}
#renderViewByContent(
content: FlexRenderTypedContent,
): FlexRenderView<any> | null {
if (content.kind === 'primitive') {
return this.#renderStringContent(content)
} else if (content.kind === 'templateRef') {
return this.#renderTemplateRefContent(content)
} else if (content.kind === 'flexRenderComponent') {
return this.#renderComponent(content)
} else if (content.kind === 'component') {
return this.#renderCustomComponent(content)
} else {
return null
}
}
#renderStringContent(
template: Extract<FlexRenderTypedContent, { kind: 'primitive' }>,
): FlexRenderTemplateView {
const context = () => {
return typeof this.content === 'string' ||
typeof this.content === 'number'
? this.content
: this.content?.(this.props)
}
const ref = this.viewContainerRef.createEmbeddedView(this.templateRef, {
get $implicit() {
return context()
},
})
return new FlexRenderTemplateView(template, ref)
}
#renderTemplateRefContent(
template: Extract<FlexRenderTypedContent, { kind: 'templateRef' }>,
): FlexRenderTemplateView {
const latestContext = () => this.props
const view = this.viewContainerRef.createEmbeddedView(template.content, {
get $implicit() {
return latestContext()
},
})
return new FlexRenderTemplateView(template, view)
}
#renderComponent(
flexRenderComponent: Extract<
FlexRenderTypedContent,
{ kind: 'flexRenderComponent' }
>,
): FlexRenderComponentView {
const { inputs, outputs, injector } = flexRenderComponent.content
const getContext = () => this.props
const proxy = new Proxy(this.props, {
get: (_, key) => getContext()[key as keyof typeof _],
})
const componentInjector = Injector.create({
parent: injector ?? this.injector,
providers: [{ provide: FlexRenderComponentProps, useValue: proxy }],
})
const view = this.#flexRenderComponentFactory.createComponent(
flexRenderComponent.content,
componentInjector,
)
return new FlexRenderComponentView(flexRenderComponent, view)
}
#renderCustomComponent(
component: Extract<FlexRenderTypedContent, { kind: 'component' }>,
): FlexRenderComponentView {
const view = this.#flexRenderComponentFactory.createComponent(
flexRenderComponent(component.content, {
inputs: this.props,
injector: this.injector,
}),
this.injector,
)
return new FlexRenderComponentView(component, view)
}
}
export const FlexRender = FlexRenderDirective