diff --git a/docs/configuration.md b/docs/configuration.md index 20e586f9..a49d5db3 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -39,7 +39,6 @@ The `config` object is mainly focused around user interaction with the devtools ```ts { panelLocation: 'top' | 'bottom' } - ``` - `openHotkey` - The hotkey set to open the devtools @@ -64,14 +63,12 @@ type KeyboardKey = ModifierKey | (string & {}); ```ts { requireUrlFlag: boolean } - ``` - `triggerImage` - The image used for the dev tools trigger ```ts { triggerImage: string } - ``` - `urlFlag` - The required flag that must be present in the url to enable devtools. @@ -80,7 +77,7 @@ type KeyboardKey = ModifierKey | (string & {}); { urlFlag: string } ``` -The `eventBusConfig` is configuration for the back bone of the devtools, the ``, and accepts the following properties: +The `eventBusConfig` is configuration for the back bone of the devtools, the `EventClient`, and accepts the following properties: - `debug` - Enables debug mode for the EventBus @@ -138,13 +135,13 @@ Configuration for the `EventClient` is as follows - `pluginId` (required) - The plugin identifier used by the event bus to direct events to listeners ```ts -{pluginId: string} +{ pluginId: string } ``` - `debug` - Enables debug mode for the EventClient ```ts -{debug: boolean} +{ debug: boolean } ``` Put together the `EventClient` configuration looks like: diff --git a/docs/framework/preact/guides/custom-plugins.md b/docs/framework/preact/guides/custom-plugins.md index 2bf63cf6..c3c3ac1b 100644 --- a/docs/framework/preact/guides/custom-plugins.md +++ b/docs/framework/preact/guides/custom-plugins.md @@ -7,7 +7,7 @@ TanStack devtools allows you to create your own custom plugins by emitting and l ## Prerequisite -This guide will walk you through a simple example where our library is a counter with a count history. A working example can be found in our [custom-plugin example](https://tanstack.com/devtools/latest/docs/framework/preact/examples/custom-plugin). +This guide will walk you through a simple example where our library is a counter with a count history. A working example can be found in our [custom-plugin example](https://tanstack.com/devtools/latest/docs/framework/preact/examples/custom-devtools). This is our library code: diff --git a/docs/framework/react/guides/custom-plugins.md b/docs/framework/react/guides/custom-plugins.md index a4107cf3..4a700220 100644 --- a/docs/framework/react/guides/custom-plugins.md +++ b/docs/framework/react/guides/custom-plugins.md @@ -7,7 +7,7 @@ TanStack devtools allows you to create your own custom plugins by emitting and l ## Prerequisite -This guide will walk you through a simple example where our library is a counter with a count history. A working example can be found in our [custom-plugin example](https://tanstack.com/devtools/latest/docs/framework/react/examples/custom-plugin). +This guide will walk you through a simple example where our library is a counter with a count history. A working example can be found in our [custom-plugin example](https://tanstack.com/devtools/latest/docs/framework/react/examples/custom-devtools). This is our library code: diff --git a/docs/overview.md b/docs/overview.md index 76034498..0e932af9 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -3,7 +3,7 @@ title: Overview id: overview --- -TanStack Devtools is a framework-agnostic devtool for managing and debugging *devtool devtools* +TanStack Devtools is a framework-agnostic devtool for managing and debugging *your devtools*. We offer you all the tools you need to build and maintain your own devtools with ease. diff --git a/docs/plugin-configuration.md b/docs/plugin-configuration.md index 0b9139cd..80417769 100644 --- a/docs/plugin-configuration.md +++ b/docs/plugin-configuration.md @@ -9,7 +9,8 @@ id: plugin-configuration You can configure TanStack Devtools plugins by passing them as an array to the `plugins` prop of the `TanStackDevtools` component. Each plugin can have the following configuration options: -- `render` (required) - A React component that renders the plugin's UI +- `name` (required) - A name to be displayed in the devtools UI. +- `render` (required) - A React component that renders the plugin's UI. - `defaultOpen` (optional) - A boolean that determines if the plugin panel is open by default (default: false). - `id` (optional) - A unique identifier for the plugin. If not provided, a random id will be generated.