Commit graph

15 commits

Author SHA1 Message Date
Alem Tuzlak
cf8e67875c
feat(devtools): rainbow trigger, persist strip fold, and pane gutters (#510)
Use the rainbow palm as the default trigger mark and default triggerMode to floating.
Keep the folded plugin strip across reloads.
Lay plugin panes in rounded cards with even gutters, theme panel scrollbars, and keep resize handles on the live layout so they stay in the gap after a pane opens or a drag.
2026-08-19 18:50:38 +02:00
Alem Tuzlak
d061f0cc3c
feat(devtools): add floating/draggable trigger with throw physics (#485)
* feat(devtools): add floating/draggable trigger with throw physics

Add a `triggerMode: 'fixed' | 'floating'` setting. In floating mode the trigger
can be dragged anywhere with the left mouse button; releasing with velocity
throws it (inertia + wall bounce). Position is clamped to a padded on-screen
area (matching the fixed trigger's edge offset) and persisted to local storage,
re-clamping on window resize so it can never load off-screen.

* ci: apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-07-22 12:04:20 +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
Zaidhaan
6d3bdc0456
feat: add inspector hotkey configuration (inspectHotkey) (#275)
* feat: inspector hotkey configuration

* feat: refactor hotkey handling

* feat: refactor hotkey UI configuration + update docs

* chore: add some tests

* chore: changeset

* ci: apply automated fixes

* remove extra modifiers

* ci: apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Alem Tuzlak <t.zlak97@gmail.com>
Co-authored-by: Alem Tuzlak <t.zlak@hotmail.com>
2025-12-08 10:50:07 +01:00
Sarah
5ae6ded099
docs: format callouts to put content on new line (#269)
fix callouts
2025-11-24 17:56:48 +01:00
Alem Tuzlak
aa32c0219a
feat: add defaultOpen option to plugins (#245)
* feat: add defaultOpen option to plugins

* ci: apply automated fixes

* chore: docs update

* fix utils

* ci: apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-10-29 11:30:08 +01: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
Jacob Kelley
591b52ff5b
feat(core,ui): trigger image support (#134)
Howdy! I apologize for not reviewing the contributing guidelines more
carefully and built this feature without first soliciting feedback from
the team on the desire to implement this. I hope this request is
received well.

This PR adds support for specifying a trigger image via the config
object or via the UI. We are interested in using the devtools package
for more than just the tanstack ecosystem, and would like to consider
replacing it with our engineering/dev logo (even though we're using
tanstack for all the things!) If no logo is provided, it will default to
the tanstack logo in the package.

<img width="112" height="105" alt="image"
src="https://github.com/user-attachments/assets/10a0728e-61cc-4eea-b076-e065a17651fb"
/>

**Via UI**
<img width="430" alt="image"
src="https://github.com/user-attachments/assets/42b7f024-114c-4cfb-879a-7a0a30b5892b"
/>


**Via Configuragion**
```tsx
<TanStackDevtools
  config={{
    triggerImage: "https://avatars.githubusercontent.com/u/1041792?v=4",
  }}
/>
```

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-09-18 11:53:32 +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
db7f3d9761 docs(core, react): fixes to examples package.json, links and typos 2025-08-10 16:43:37 +02:00
Harry Whorlow
3305f00f41 chore: more typos 2025-08-09 12:03:38 +02:00
Harry Whorlow
316cfc50f0 chore: pr comments 2025-08-09 12:01:36 +02:00
Harry Whorlow
7ea51a4a4c docs: devtools configuration 2025-08-09 11:25:26 +02:00