[svelte] createTableHook: App* wrappers call setContext in the parent's component context (set_context_after_init when showing a column) #6614
Send to my agentTanStack Table version#
@tanstack/svelte-table v9.2.5 (the same code is in v9.2.6)
Framework/Library version#
Svelte v5.57.1, with compilerOptions.experimental.async: true
Describe the bug and the steps to reproduce it#
With createTableHook, any <table.AppCell> / <table.AppHeader> that is created after the component using it has initialized throws set_context_after_init, and the cells don't render. The most common trigger is showing a hidden column; it also affects anything else that creates new cells later.
Svelte error: set_context_after_init
`setContext` must be called when a component first initializes, not in a subsequent effect or after an `await` expression
at setContext
at AppCell (createTableHook.svelte.js)
Steps (see the playground below):
- Create a table with
createTableHook/createAppTablewhere one column is hidden (initialState: { columnVisibility: { age: false } }), and render cells with<table.AppCell {cell}>. - Show the column:
table.getColumn('age').toggleVisibility(). - The error is thrown and the new column's cells aren't rendered.
Cause: createAppTable builds the App* wrappers as plain functions that call setContext and then call the real component:
const AppCell = ((internal, { children, cell }) => {
setContext(cellContextKey, cell);
return AppCellSvelte(internal, { cell, cellComponents: cellComponentsWithFlexRender, children });
});
setContext runs before AppCellSvelte has pushed its own component context, so it writes into the parent's context (the component that renders <table.AppCell>). Svelte's async mode validates that setContext only runs while a component initializes. That holds during the parent's first render, but not for cells created later, e.g. when a column is shown. Without async mode it doesn't throw, but cells/headers still get written into the parent's context map rather than their own. The same applies to AppHeader, AppFooter and AppTable.
Possible fix, which I'm using as a local patch: let the App*Svelte components set the context themselves, during their own initialization, and have the wrappers only pass props:
// createTableHook.svelte.js
- const AppCell = ((internal, { children, cell }) => {
- setContext(cellContextKey, cell);
- return AppCellSvelte(internal, {
- cell,
- cellComponents: cellComponentsWithFlexRender,
- children,
- });
- });
+ const AppCell = ((internal, { children, cell }) => AppCellSvelte(internal, {
+ cell,
+ cellComponents: cellComponentsWithFlexRender,
+ contextKey: cellContextKey,
+ children,
+ }));
<!-- AppCell.svelte -->
<script lang="ts">
- import type { Snippet } from 'svelte'
+ import { setContext, type Snippet } from 'svelte'
...
- let { children, cell, cellComponents }: Props = $props()
+ let { children, cell, cellComponents, contextKey }: Props = $props()
+
+ setContext(contextKey, cell)
</script>
…and the same for AppHeader / AppFooter (AppHeader.svelte) and AppTable (AppTable.svelte, which would receive table as a prop). With that patch, showing/hiding columns, paging, sorting and filtering work without errors, and useCellContext / useHeaderContext / useTableContext return the right instances.
Your Minimal, Reproducible Example - (Sandbox Highly Recommended)#
Click Toggle "Age": the error appears in the console and the "Age" cells don't render.
Screenshots or Videos (Optional)#
No response
Do you intend to try to help solve this bug with your own PR?#
Yes, I think I know how to fix it and will discuss it in the comments of this issue
Terms & Code of Conduct#
- I agree to follow this project's Code of Conduct
- I understand that if my bug cannot be reliable reproduced in a debuggable environment, it will probably not be fixed and this issue may even be closed.
KevinVandy closed this
Sign in to join this conversation.