Commit graph

33 commits

Author SHA1 Message Date
Alem Tuzlak
b1ac893a7d
feat(event-client): strip the root EventClient export from production by default (#471)
* feat(event-client): add shared types module, /production entry, and package wiring

* feat(event-client): add standalone no-op client and share event types

* feat(event-client): no-op the root export outside development

* docs(event-client): document dev-only root export and /production subpath

* chore(event-client): add changeset for production stripping

* test(event-client): guard no-op/real public-surface parity and cover the dev resolver branch

* docs(event-client): clarify unset NODE_ENV behavior and fix stale stripping guidance

* ci: apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-06-24 13:13:14 +02:00
Alem Tuzlak
d7c5a93710
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
Riccardo Perra
ad26f6182f
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
Alem Tuzlak
9bf08e270f
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
Shinya Fujino
487123d8b4
docs: fix typos, formatting, and broken links (#293)
* docs: fix typos and improve formatting in documentation

* period

* fix example links in custom-plugins guides

---------

Co-authored-by: Alem Tuzlak <t.zlak97@gmail.com>
2025-12-24 15:30:58 +01:00
Kevin Van Cott
e0d58d56fc
feat: add preact devtools (#283)
* feat: add preact devtools

* changeset

* ci: apply automated fixes

* fix example jsx issue

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-12-07 13:48:43 -06:00
Lachlan Collins
66722f5a70
docs: correct local relative links (#282)
* docs: correct local relative links

* Fix config imports
2025-12-05 22:38:56 +11:00
Sarah
5ae6ded099
docs: format callouts to put content on new line (#269)
fix callouts
2025-11-24 17:56:48 +01:00
spookyuser
24a3a593db
fix example variable (#247) 2025-10-29 17:48:02 +01:00
Takhyun Kim
690c61823a
fix: apply missing ) to DevtoolsPanel example code (#190)
apply missing ) to DevtoolsPanel example code
2025-10-01 15:51:14 +02:00
TakhyunKim
023fd2482d
fix: update react custom plugin count handling logic position (#173)
Fixes #167 

### Changes

Update to execute count increment/decrement before history push.

The pages affected by this change are as follows:
-
https://tanstack.com/devtools/latest/docs/framework/react/guides/custom-plugins
-
https://tanstack.com/devtools/latest/docs/framework/react/examples/custom-devtools
2025-09-25 10:41:27 +02:00
TakhyunKim
fadd95541d
docs: unify code conventions in example code within document (#156)
Fixes #155 

### Changes

Remove unused commas, semicolons, and spaces.
Also fix the incorrect constructor depth.
2025-09-22 12:51:15 +02:00
Cole Lawrence
a2835d02f2
docs: Fix count increment and decrement in custom plugins guide (#154)
The previous code was simply incorrect and I removed a typo'd redundant
"TanStack" mention.
2025-09-22 12:50:36 +02:00
Szymon Prusak
543b0a23b2
docs: update example for creating custom plugin (#157)
quick update to example for creating a custom plugin

Co-authored-by: Szymon Prusak <szymonprusak@laptop-Szymon.local>
2025-09-21 14:04:03 +02:00
TakhyunKim
19a92cf5d3
fix: update broken links in documents (#141)
I'm delighted to be able to contribute to such a great project. Thank
you.

### Changes

Releated issue: https://github.com/TanStack/devtools/issues/140

Resolves the issue where some links in the [TanStack Devtools
documentation](https://tanstack.com/devtools/latest/docs/overview) were
broken.

Testing for the updated link was conducted by referring to the README at
tanstack.com below.
- https://github.com/TanStack/tanstack.com/blob/main/README.md
2025-09-18 19:19:34 +02:00
Harry Whorlow
30751c306f
docs(react): update tanstack devtool list (#93) 2025-09-01 19:53:40 +02:00
Alem Tuzlak
89b1493ab0
feat: improve open source funtionality (#61)
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-08-23 08:47:01 +02:00
Matthijs Kok
44a8410b47
chore: capitalize "TanStack" consistently (#35) 2025-08-14 11:47:20 +02:00
Harry Whorlow
3d7082eea5 chore: more stuff 2025-08-10 17:10:11 +02:00
Harry Whorlow
d422102539 chore: missing link 2025-08-10 17:04:31 +02:00
Harry Whorlow
e0cc67b38e chore: update config 2025-08-10 17:01:25 +02:00
Harry Whorlow
db7f3d9761 docs(core, react): fixes to examples package.json, links and typos 2025-08-10 16:43:37 +02:00
Alem Tuzlak
38bcd5785b chore: update doc config 2025-08-10 15:28:23 +02:00
Harry Whorlow
22631ae155 chore: minor changes 2025-08-10 11:56:34 +02:00
Harry Whorlow
55ae3b86e4 chore: pr comments and tweeks 2025-08-10 11:56:34 +02:00
Harry Whorlow
04a8f91a88 docs(react): basic setup 2025-08-10 11:54:47 +02:00
Harry Whorlow
67348ed927 chore: review fixes 2025-08-09 09:27:11 +02:00
Harry Whorlow
537165dffc chore: structure 2025-08-09 08:36:28 +02:00
Harry Whorlow
53230645f8 chore: add debugging to docs 2025-08-09 08:24:32 +02:00
Harry Whorlow
ec60509291 docs(react): custom plugin docs and custom plugin example 2025-08-08 23:49:08 +02:00
Alem Tuzlak
d7dc08211d chore: update jsdoc and docs 2025-08-01 16:13:01 +02:00
Kevin Van Cott
c6af62ba04 run docs:generate 2025-08-01 07:47:08 -05:00
Kevin Van Cott
f3d7dfd171 init 2025-07-25 16:40:55 -05:00