@mwillbanks/tuil-devtools

Overview

Runtime inspector and developer overlay for tuil applications.

@mwillbanks/tuil-devtools is independently installable and also participates in the umbrella @mwillbanks/tuil runtime where applicable.

Installation

npm install @mwillbanks/tuil-devtools

How it operates

Devtools subscribes to runtime snapshots without changing application state. The overlay exposes lifecycle, focus, services, commands, plugins, events, capabilities, and theme information.

Documentation flow diagram. mount inspector; subscribe; render snapshots; unsubscribe; S0 leads to S1; S1 leads to S2; S2 leads to S3 — **Documentation flow diagram.** mount inspector; subscribe; render snapshots; unsubscribe; S0 leads to S1; S1 leads to S2; S2 leads to S3

API

API	Signature	Description
`DevtoolsActionContext`	`interface DevtoolsActionContext`	Public interface DevtoolsActionContext.
`DevtoolsActionContribution`	`interface DevtoolsActionContribution`	Public interface DevtoolsActionContribution.
`DevtoolsActionHistorySnapshot`	`interface DevtoolsActionHistorySnapshot`	Public interface DevtoolsActionHistorySnapshot.
`DevtoolsActionRecord`	`interface DevtoolsActionRecord`	Public interface DevtoolsActionRecord.
`DevtoolsCapability`	`type DevtoolsCapability`	Public type DevtoolsCapability.
`DevtoolsContribution`	`interface DevtoolsContribution`	Public interface DevtoolsContribution.
`DevtoolsExtension`	`type DevtoolsExtension`	Public type DevtoolsExtension.
`DevtoolsExtensionRegistry`	`class DevtoolsExtensionRegistry`	Public class DevtoolsExtensionRegistry.
`DevtoolsObserverContribution`	`interface DevtoolsObserverContribution`	Public interface DevtoolsObserverContribution.
`DevtoolsObserverKind`	`type DevtoolsObserverKind`	Public type DevtoolsObserverKind.
`DevtoolsPanel`	`type DevtoolsPanel`	Public type DevtoolsPanel.
`DevtoolsPanelContribution`	`interface DevtoolsPanelContribution`	Public interface DevtoolsPanelContribution.
`devtoolsPanels`	`constant devtoolsPanels`	Public constant devtoolsPanels.
`DevtoolsPermission`	`type DevtoolsPermission`	Public type DevtoolsPermission.
`DevtoolsQueryContribution`	`interface DevtoolsQueryContribution`	Public interface DevtoolsQueryContribution.
`DevtoolsStore`	`class DevtoolsStore`	Public class DevtoolsStore.
`inspectRuntime`	`function inspectRuntime`	Public function inspectRuntime.
`RuntimeInspection`	`interface RuntimeInspection`	Public interface RuntimeInspection.
`TuilDevtools`	`constant TuilDevtools`	Public constant TuilDevtools.
`TuilDevtoolsProps`	`interface TuilDevtoolsProps`	Public interface TuilDevtoolsProps.

Events and lifecycle

Reads the runtime event history and observer stream. It does not emit application events.

All subscriptions and registrations return a disposer or belong to an owning runtime that disposes them in reverse order.

Example

import { TuilDevtools } from "@mwillbanks/tuil-devtools";

render(<TuilDevtools />);