Arc Rider Docs · Markdown

Mini Widgets

Custom Dev Tools

DevTools en React

Muestra un panel de diagnóstico posicionable libremente. Recopila las marcas de error existentes del editor y muestra valores de debug propios; no es un React Error Boundary.

Referencia para @arcrider/arcwidgets-react@0.1.0-alpha.5. <a href="/docs/react/intro/setup-react">Instalación</a> · <a href="/docs/react/intro/react-components">Todos los componentes</a>.

Ejemplo completo

Props del componente

id

ID de DOM opcional. No es necesario en el uso normal; se genera automáticamente si se omite.

data

Configuración de tipo ArcWidgetDevToolsData. Pasa los cambios como objetos nuevos; gestiona los datos de negocio y la selección en el estado de React.

onAction

Fallback opcional (type: string, ...args: unknown[]) => unknown. El callback concreto tiene prioridad. Detalles: <a href="/docs/react/patterns/react-state-events">Estado y eventos</a>.

onFooterClick

Se ha pulsado un botón del footer con clickable: true. Recibe su índice de base cero en footerButtons.

onFooterClick?: (index: number) => void;

Configuración

Los siguientes campos pertenecen a data. Los tamaños se indican como strings, los números y valores de tiempo según su tipo respectivo.

errorPanel

El panel: visible lo muestra (por defecto false), maxErrors limita la lista (por defecto 50), debug añade tus propias filas de clave/valor (los objetos se muestran como JSON), footerButtons añade botones con title y clickable.

Tipo: ArcWidgetDevToolsErrorPanel.

Comportamiento y límites

  • El panel se adjunta al cuerpo del documento. El escaneo de errores necesita un editor CodeMirror correspondiente en el documento. Sin editor no muestra errores de aplicación; debug muestra los valores que le pases. Para cerrarlo, el ejemplo elimina el componente del árbol de React.
  • Solo los botones del footer marcados como clickable disparan onFooterClick. Los títulos de los botones y los valores de debug se muestran como texto plano.
  • La posición del panel se recuerda por instancia tras arrastrarlo. Muestra solo datos de diagnóstico destinados a los usuarios correspondientes.

Tipos de datos

Estos tipos relacionados con el widget se exportan desde el paquete. También están disponibles tipos comunes como ArcWidgetSlot, ArcWidgetStyles y ArcReactWidgetProps. Los objetos de configuración son cerrados, por lo que una clave mal escrita o no admitida se notifica como error de tipo.

export interface ArcWidgetDevToolsFooterButton {
	title?: string;
	clickable?: boolean;
}

export interface ArcWidgetDevToolsDebug { [key: string]: unknown; }

export interface ArcWidgetDevToolsErrorPanel { visible?: boolean; maxErrors?: number; debug?: ArcWidgetDevToolsDebug; footerButtons?: ArcWidgetDevToolsFooterButton[]; }

export interface ArcWidgetDevToolsData { errorPanel?: ArcWidgetDevToolsErrorPanel; }

export interface ArcWidgetDevToolsProps extends ArcReactWidgetProps&lt;ArcWidgetDevToolsData&gt; { onFooterClick?: (index: number) =&gt; void; }</code></pre>