This website requires JavaScript.
About
Status
₊˚⊹Discord
Explore
Register
Sign in
Reference in a new issue
Blame
Copy permalink
Reference in a new issue
Copy permalink
TanStack
/
devtools
Star
0
Fork
You've already forked devtools
0
mirror of
https://github.com/TanStack/devtools.git
synced
2026-11-16 10:49:48 +00:00
Code
Issues
Releases
Packages
Activity
@tanstack/devtools-rspack@0.1.2
devtools
/
docs
/
devtools-utils.md
365 lines
11 KiB
Raw
Permalink
Normal View
History
docs: comprehensive documentation overhaul (#363) * docs: add documentation redesign design document Comprehensive plan for restructuring TanStack Devtools documentation with layered architecture approach: Getting Started, Concepts, Guides, API Reference, and Examples sections. Adds 11 new pages including architecture overview, event system deep-dive, Vue framework support, and plugin building guides. * docs: add documentation implementation plan 18-task plan covering: navigation restructure, 4 new Concepts pages (architecture, event system, plugin lifecycle, source inspector), 3 new Guides (custom plugins, devtools-utils, bidirectional comms), Vue framework support, Solid custom plugins, and updates to existing pages including overview, quick-start, installation, and React adapter. * docs: restructure navigation with Concepts and Guides sections, add Vue * docs: expand overview with package map and architecture diagram * docs: add all framework examples to quick start * docs: add Vue and Preact installation instructions * docs: add architecture overview page * docs: add event system concepts page * docs: add plugin lifecycle concepts page * docs: add source inspector concepts page * docs: add framework-agnostic custom plugin building guide * docs: add devtools-utils guide for plugin factory helpers * docs: add bidirectional communication guide * docs: add Vue basic setup and adapter pages * docs: add Vue and Solid custom plugins guides * docs: replace TODO in React adapter with actual content * docs: expand Vite plugin features documentation * docs: fix event map key convention, typos, and internal link extensions - Event map keys should be suffix-only (e.g., 'state-update'), not prefixed with pluginId. EventClient prepends pluginId automatically. Fixed across all custom plugin guides and concept pages. - Fix enabled:false docs in event-system.md (emit is a no-op, not internal dispatch) - Fix double "the the" typo in installation.md - Remove .md extensions from internal doc links for consistency - Fix event map key in configuration.md example * docs: remove internal plan files * docs: replace ASCII diagrams with mermaid in architecture overview * docs: add mermaid diagrams across all documentation pages - overview.md: architecture layer diagram - event-system.md: connection lifecycle state diagram - plugin-lifecycle.md: mount sequence flowchart + portal pattern diagram - source-inspector.md: inspection flow diagram - building-custom-plugins.md: plugin architecture overview - bidirectional-communication.md: two-way flow + time travel sequence diagram - vite-plugin.md: sub-plugin overview diagram
2026-03-04 13:52:26 +01:00
feat: add Svelte 5 adapter and devtools-utils Svelte factories (#366) * docs: add Svelte devtools adapter design doc * docs: add Svelte devtools implementation plan * feat(svelte-devtools): add Svelte 5 adapter package * feat(devtools-utils): add Svelte factory functions and build config * fix: resolve knip issues and update svelte vite plugin to v6 * docs: add Svelte documentation * chore: add changeset for Svelte adapter * ci: apply automated fixes * fix(svelte-devtools): mount once and tear down stale plugin components on update - Mount the core exactly once: untrack props in the mount $effect so a prop change no longer destroys and rebuilds the entire devtools core (the update $effect already handles config/plugin changes reactively). - update() now calls destroyAllComponents() before setConfig(), matching the Angular adapter — the core re-invokes render/name for the new plugin set, so without this the previous Svelte instances were orphaned and leaked. - renderComponent() keys mounted components by container.id directly (the core always assigns one) instead of an empty-string fallback that could never be matched on destroy. - vite.config: cast svelte() plugin as any, matching the vue/solid configs, to satisfy the vite 8 plugin types. * chore(devtools-utils): add svelte devDependency for the svelte subpath build The `./svelte` build type-checks svelte-importing source, so svelte must be resolvable at build time (mirroring vite-plugin-solid for the solid build) rather than relying on workspace hoisting of the optional peer. * test(devtools-utils): cover svelte plugin and panel factories Mirrors the existing solid class factory tests: createSveltePlugin shape + NoOp behavior, and createSveltePanel mounting/tearing down a class-based core. * ci: apply automated fixes * refactor(devtools-utils): make createSveltePlugin generic over component props Threads a TComponentProps generic through the svelte plugin factory (mirroring createVuePlugin) so plugin props are type-checked against the component instead of falling back to `any`. Addresses PR review feedback. * ci: apply automated fixes --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-06-23 11:12:54 +02:00
docs: comprehensive documentation overhaul (#363) * docs: add documentation redesign design document Comprehensive plan for restructuring TanStack Devtools documentation with layered architecture approach: Getting Started, Concepts, Guides, API Reference, and Examples sections. Adds 11 new pages including architecture overview, event system deep-dive, Vue framework support, and plugin building guides. * docs: add documentation implementation plan 18-task plan covering: navigation restructure, 4 new Concepts pages (architecture, event system, plugin lifecycle, source inspector), 3 new Guides (custom plugins, devtools-utils, bidirectional comms), Vue framework support, Solid custom plugins, and updates to existing pages including overview, quick-start, installation, and React adapter. * docs: restructure navigation with Concepts and Guides sections, add Vue * docs: expand overview with package map and architecture diagram * docs: add all framework examples to quick start * docs: add Vue and Preact installation instructions * docs: add architecture overview page * docs: add event system concepts page * docs: add plugin lifecycle concepts page * docs: add source inspector concepts page * docs: add framework-agnostic custom plugin building guide * docs: add devtools-utils guide for plugin factory helpers * docs: add bidirectional communication guide * docs: add Vue basic setup and adapter pages * docs: add Vue and Solid custom plugins guides * docs: replace TODO in React adapter with actual content * docs: expand Vite plugin features documentation * docs: fix event map key convention, typos, and internal link extensions - Event map keys should be suffix-only (e.g., 'state-update'), not prefixed with pluginId. EventClient prepends pluginId automatically. Fixed across all custom plugin guides and concept pages. - Fix enabled:false docs in event-system.md (emit is a no-op, not internal dispatch) - Fix double "the the" typo in installation.md - Remove .md extensions from internal doc links for consistency - Fix event map key in configuration.md example * docs: remove internal plan files * docs: replace ASCII diagrams with mermaid in architecture overview * docs: add mermaid diagrams across all documentation pages - overview.md: architecture layer diagram - event-system.md: connection lifecycle state diagram - plugin-lifecycle.md: mount sequence flowchart + portal pattern diagram - source-inspector.md: inspection flow diagram - building-custom-plugins.md: plugin architecture overview - bidirectional-communication.md: two-way flow + time travel sequence diagram - vite-plugin.md: sub-plugin overview diagram
2026-03-04 13:52:26 +01:00
feat(angular): angular adapter and utils (#368) * feat(angular-devtools): create angular adapter package Add the @tanstack/angular-devtools package with: - TanStackDevtoolsComponent: standalone Angular component that wraps TanStackDevtoolsCore - Plugin system supporting Angular components rendered into devtools containers - Type definitions for Angular-specific plugin and init configuration - Build config using @analogjs/vite-plugin-angular for AOT compilation * fix(angular-devtools): add reactivity for input changes, remove unused RenderArray * feat(devtools-utils): add angular support * fix: resolve angular build issues - Remove @analogjs/vite-plugin-angular from build (produces empty chunks for library builds). Use plain esbuild via Vite instead - Angular AOT compilation happens at consumer's build time. - Upgrade Angular dev deps from ^19 to ^20 for TypeScript 5.9 compat. - Remove @angular/build dep (only needed by analogjs plugin). - Add @tanstack/angular-devtools workspace override to root. * ci: apply automated fixes * fix: resolve lint, knip, and sherif issues - Fix array-type ESLint rule in angular-devtools - Fix import/consistent-type-specifier-style in devtools-utils angular - Sort peerDependencies alphabetically (sherif) - Remove unused devDependencies flagged by knip - Remove angularCompilerOptions from tsconfig (not using ngc) * feat: add Angular support with setup, adapter, and custom plugin documentation * feat(angular): angular adapter add utils and some examples, fix build * ci: apply automated fixes * feat: Add angular adapter and devtools-utils/angular * remove afterNextRender in devtools-utils Since angular-devtools already run the code within afterNextRender in browser env, we don't like to wrap the panel returned from utils * fix examples * fix angular devtools wrong pnpm link * feat(angular-devtools): add with-devtools provider * docs(angular-devtools): update docs * ci: apply automated fixes * chore(angular-devtools): fix examples dependencies and knip issues * feat(angular-devtools): rename withDevtools to provideTanStackDevtools * Add a11y plugin for angular * chore(deps): update @tanstack/devtools and related packages * ci: apply automated fixes --------- Co-authored-by: Alem Tuzlak <t.zlak@hotmail.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-04-28 20:17:46 +02:00
feat: add Svelte 5 adapter and devtools-utils Svelte factories (#366) * docs: add Svelte devtools adapter design doc * docs: add Svelte devtools implementation plan * feat(svelte-devtools): add Svelte 5 adapter package * feat(devtools-utils): add Svelte factory functions and build config * fix: resolve knip issues and update svelte vite plugin to v6 * docs: add Svelte documentation * chore: add changeset for Svelte adapter * ci: apply automated fixes * fix(svelte-devtools): mount once and tear down stale plugin components on update - Mount the core exactly once: untrack props in the mount $effect so a prop change no longer destroys and rebuilds the entire devtools core (the update $effect already handles config/plugin changes reactively). - update() now calls destroyAllComponents() before setConfig(), matching the Angular adapter — the core re-invokes render/name for the new plugin set, so without this the previous Svelte instances were orphaned and leaked. - renderComponent() keys mounted components by container.id directly (the core always assigns one) instead of an empty-string fallback that could never be matched on destroy. - vite.config: cast svelte() plugin as any, matching the vue/solid configs, to satisfy the vite 8 plugin types. * chore(devtools-utils): add svelte devDependency for the svelte subpath build The `./svelte` build type-checks svelte-importing source, so svelte must be resolvable at build time (mirroring vite-plugin-solid for the solid build) rather than relying on workspace hoisting of the optional peer. * test(devtools-utils): cover svelte plugin and panel factories Mirrors the existing solid class factory tests: createSveltePlugin shape + NoOp behavior, and createSveltePanel mounting/tearing down a class-based core. * ci: apply automated fixes * refactor(devtools-utils): make createSveltePlugin generic over component props Threads a TComponentProps generic through the svelte plugin factory (mirroring createVuePlugin) so plugin props are type-checked against the component instead of falling back to `any`. Addresses PR review feedback. * ci: apply automated fixes --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-06-23 11:12:54 +02:00
feat(angular): angular adapter and utils (#368) * feat(angular-devtools): create angular adapter package Add the @tanstack/angular-devtools package with: - TanStackDevtoolsComponent: standalone Angular component that wraps TanStackDevtoolsCore - Plugin system supporting Angular components rendered into devtools containers - Type definitions for Angular-specific plugin and init configuration - Build config using @analogjs/vite-plugin-angular for AOT compilation * fix(angular-devtools): add reactivity for input changes, remove unused RenderArray * feat(devtools-utils): add angular support * fix: resolve angular build issues - Remove @analogjs/vite-plugin-angular from build (produces empty chunks for library builds). Use plain esbuild via Vite instead - Angular AOT compilation happens at consumer's build time. - Upgrade Angular dev deps from ^19 to ^20 for TypeScript 5.9 compat. - Remove @angular/build dep (only needed by analogjs plugin). - Add @tanstack/angular-devtools workspace override to root. * ci: apply automated fixes * fix: resolve lint, knip, and sherif issues - Fix array-type ESLint rule in angular-devtools - Fix import/consistent-type-specifier-style in devtools-utils angular - Sort peerDependencies alphabetically (sherif) - Remove unused devDependencies flagged by knip - Remove angularCompilerOptions from tsconfig (not using ngc) * feat: add Angular support with setup, adapter, and custom plugin documentation * feat(angular): angular adapter add utils and some examples, fix build * ci: apply automated fixes * feat: Add angular adapter and devtools-utils/angular * remove afterNextRender in devtools-utils Since angular-devtools already run the code within afterNextRender in browser env, we don't like to wrap the panel returned from utils * fix examples * fix angular devtools wrong pnpm link * feat(angular-devtools): add with-devtools provider * docs(angular-devtools): update docs * ci: apply automated fixes * chore(angular-devtools): fix examples dependencies and knip issues * feat(angular-devtools): rename withDevtools to provideTanStackDevtools * Add a11y plugin for angular * chore(deps): update @tanstack/devtools and related packages * ci: apply automated fixes --------- Co-authored-by: Alem Tuzlak <t.zlak@hotmail.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-04-28 20:17:46 +02:00
docs: comprehensive documentation overhaul (#363) * docs: add documentation redesign design document Comprehensive plan for restructuring TanStack Devtools documentation with layered architecture approach: Getting Started, Concepts, Guides, API Reference, and Examples sections. Adds 11 new pages including architecture overview, event system deep-dive, Vue framework support, and plugin building guides. * docs: add documentation implementation plan 18-task plan covering: navigation restructure, 4 new Concepts pages (architecture, event system, plugin lifecycle, source inspector), 3 new Guides (custom plugins, devtools-utils, bidirectional comms), Vue framework support, Solid custom plugins, and updates to existing pages including overview, quick-start, installation, and React adapter. * docs: restructure navigation with Concepts and Guides sections, add Vue * docs: expand overview with package map and architecture diagram * docs: add all framework examples to quick start * docs: add Vue and Preact installation instructions * docs: add architecture overview page * docs: add event system concepts page * docs: add plugin lifecycle concepts page * docs: add source inspector concepts page * docs: add framework-agnostic custom plugin building guide * docs: add devtools-utils guide for plugin factory helpers * docs: add bidirectional communication guide * docs: add Vue basic setup and adapter pages * docs: add Vue and Solid custom plugins guides * docs: replace TODO in React adapter with actual content * docs: expand Vite plugin features documentation * docs: fix event map key convention, typos, and internal link extensions - Event map keys should be suffix-only (e.g., 'state-update'), not prefixed with pluginId. EventClient prepends pluginId automatically. Fixed across all custom plugin guides and concept pages. - Fix enabled:false docs in event-system.md (emit is a no-op, not internal dispatch) - Fix double "the the" typo in installation.md - Remove .md extensions from internal doc links for consistency - Fix event map key in configuration.md example * docs: remove internal plan files * docs: replace ASCII diagrams with mermaid in architecture overview * docs: add mermaid diagrams across all documentation pages - overview.md: architecture layer diagram - event-system.md: connection lifecycle state diagram - plugin-lifecycle.md: mount sequence flowchart + portal pattern diagram - source-inspector.md: inspection flow diagram - building-custom-plugins.md: plugin architecture overview - bidirectional-communication.md: two-way flow + time travel sequence diagram - vite-plugin.md: sub-plugin overview diagram
2026-03-04 13:52:26 +01:00
feat: add Svelte 5 adapter and devtools-utils Svelte factories (#366) * docs: add Svelte devtools adapter design doc * docs: add Svelte devtools implementation plan * feat(svelte-devtools): add Svelte 5 adapter package * feat(devtools-utils): add Svelte factory functions and build config * fix: resolve knip issues and update svelte vite plugin to v6 * docs: add Svelte documentation * chore: add changeset for Svelte adapter * ci: apply automated fixes * fix(svelte-devtools): mount once and tear down stale plugin components on update - Mount the core exactly once: untrack props in the mount $effect so a prop change no longer destroys and rebuilds the entire devtools core (the update $effect already handles config/plugin changes reactively). - update() now calls destroyAllComponents() before setConfig(), matching the Angular adapter — the core re-invokes render/name for the new plugin set, so without this the previous Svelte instances were orphaned and leaked. - renderComponent() keys mounted components by container.id directly (the core always assigns one) instead of an empty-string fallback that could never be matched on destroy. - vite.config: cast svelte() plugin as any, matching the vue/solid configs, to satisfy the vite 8 plugin types. * chore(devtools-utils): add svelte devDependency for the svelte subpath build The `./svelte` build type-checks svelte-importing source, so svelte must be resolvable at build time (mirroring vite-plugin-solid for the solid build) rather than relying on workspace hoisting of the optional peer. * test(devtools-utils): cover svelte plugin and panel factories Mirrors the existing solid class factory tests: createSveltePlugin shape + NoOp behavior, and createSveltePanel mounting/tearing down a class-based core. * ci: apply automated fixes * refactor(devtools-utils): make createSveltePlugin generic over component props Threads a TComponentProps generic through the svelte plugin factory (mirroring createVuePlugin) so plugin props are type-checked against the component instead of falling back to `any`. Addresses PR review feedback. * ci: apply automated fixes --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-06-23 11:12:54 +02:00
feat(angular): angular adapter and utils (#368) * feat(angular-devtools): create angular adapter package Add the @tanstack/angular-devtools package with: - TanStackDevtoolsComponent: standalone Angular component that wraps TanStackDevtoolsCore - Plugin system supporting Angular components rendered into devtools containers - Type definitions for Angular-specific plugin and init configuration - Build config using @analogjs/vite-plugin-angular for AOT compilation * fix(angular-devtools): add reactivity for input changes, remove unused RenderArray * feat(devtools-utils): add angular support * fix: resolve angular build issues - Remove @analogjs/vite-plugin-angular from build (produces empty chunks for library builds). Use plain esbuild via Vite instead - Angular AOT compilation happens at consumer's build time. - Upgrade Angular dev deps from ^19 to ^20 for TypeScript 5.9 compat. - Remove @angular/build dep (only needed by analogjs plugin). - Add @tanstack/angular-devtools workspace override to root. * ci: apply automated fixes * fix: resolve lint, knip, and sherif issues - Fix array-type ESLint rule in angular-devtools - Fix import/consistent-type-specifier-style in devtools-utils angular - Sort peerDependencies alphabetically (sherif) - Remove unused devDependencies flagged by knip - Remove angularCompilerOptions from tsconfig (not using ngc) * feat: add Angular support with setup, adapter, and custom plugin documentation * feat(angular): angular adapter add utils and some examples, fix build * ci: apply automated fixes * feat: Add angular adapter and devtools-utils/angular * remove afterNextRender in devtools-utils Since angular-devtools already run the code within afterNextRender in browser env, we don't like to wrap the panel returned from utils * fix examples * fix angular devtools wrong pnpm link * feat(angular-devtools): add with-devtools provider * docs(angular-devtools): update docs * ci: apply automated fixes * chore(angular-devtools): fix examples dependencies and knip issues * feat(angular-devtools): rename withDevtools to provideTanStackDevtools * Add a11y plugin for angular * chore(deps): update @tanstack/devtools and related packages * ci: apply automated fixes --------- Co-authored-by: Alem Tuzlak <t.zlak@hotmail.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-04-28 20:17:46 +02:00
docs: comprehensive documentation overhaul (#363) * docs: add documentation redesign design document Comprehensive plan for restructuring TanStack Devtools documentation with layered architecture approach: Getting Started, Concepts, Guides, API Reference, and Examples sections. Adds 11 new pages including architecture overview, event system deep-dive, Vue framework support, and plugin building guides. * docs: add documentation implementation plan 18-task plan covering: navigation restructure, 4 new Concepts pages (architecture, event system, plugin lifecycle, source inspector), 3 new Guides (custom plugins, devtools-utils, bidirectional comms), Vue framework support, Solid custom plugins, and updates to existing pages including overview, quick-start, installation, and React adapter. * docs: restructure navigation with Concepts and Guides sections, add Vue * docs: expand overview with package map and architecture diagram * docs: add all framework examples to quick start * docs: add Vue and Preact installation instructions * docs: add architecture overview page * docs: add event system concepts page * docs: add plugin lifecycle concepts page * docs: add source inspector concepts page * docs: add framework-agnostic custom plugin building guide * docs: add devtools-utils guide for plugin factory helpers * docs: add bidirectional communication guide * docs: add Vue basic setup and adapter pages * docs: add Vue and Solid custom plugins guides * docs: replace TODO in React adapter with actual content * docs: expand Vite plugin features documentation * docs: fix event map key convention, typos, and internal link extensions - Event map keys should be suffix-only (e.g., 'state-update'), not prefixed with pluginId. EventClient prepends pluginId automatically. Fixed across all custom plugin guides and concept pages. - Fix enabled:false docs in event-system.md (emit is a no-op, not internal dispatch) - Fix double "the the" typo in installation.md - Remove .md extensions from internal doc links for consistency - Fix event map key in configuration.md example * docs: remove internal plan files * docs: replace ASCII diagrams with mermaid in architecture overview * docs: add mermaid diagrams across all documentation pages - overview.md: architecture layer diagram - event-system.md: connection lifecycle state diagram - plugin-lifecycle.md: mount sequence flowchart + portal pattern diagram - source-inspector.md: inspection flow diagram - building-custom-plugins.md: plugin architecture overview - bidirectional-communication.md: two-way flow + time travel sequence diagram - vite-plugin.md: sub-plugin overview diagram
2026-03-04 13:52:26 +01:00