@solid-devtools/frontend

@solid-devtools/frontend

The frontend of the devtools extension as a npm package, so it can be embedded in different projects.

Getting started

Installation

npm i @solid-devtools/frontend
# or
yarn add @solid-devtools/frontend
# or
pnpm add @solid-devtools/frontend

The debugger

The debugger package is what you should use to get information out of the reactivity graph of an app you want to debug and display on the devtools.

You can communicate with it using it's plugin API. For reference, see the main package, which contains the code to communicate with the debugger from the devtools extension through a chrome postMessage API.

The controller

The devtools frontend is controlled with a Controller API. It provides a set of methods to trigger actions, and a way to get events from the devtools frontend.

const controller = new Controller({
  onDevtoolsLocatorStateChange(enabled) {
    console.log(enabled)
  },
  onHighlightElementChange(data) {
    console.log(data)
  },
  onInspectNode(data) {
    console.log(data)
  },
  onInspectValue(data) {
    console.log(data)
  },
})

This package is continuously under development, so the API is still not well defined. So instead of focusing on the API, the usage examples should show how you can embed this package in different context.

• Chrome Extension - The extension is communicating with the debugger using the main npm package.

• Overlay component

Changelog

See CHANGELOG.md.