Arc Rider Docs · Markdown

Mini Widgets

Icon

Icon en React

Representa un símbolo de un conjunto de iconos compatible, por ejemplo como indicador de estado o dentro de un botón.

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 ArcWidgetIconData. 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>.

Este widget es un componente de presentación y no ofrece callbacks de interacción propios.

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.

iconSet

Familia de iconos. Por defecto: phosphor.

Tipo: 'phosphor' | 'material_symbols'.

name

Nombre del símbolo dentro del conjunto elegido, p. ej. 'user'.

Tipo: string.

style

Variante del símbolo. Phosphor: regular (por defecto), bold, fill, thin, light, duotone. Material Symbols: outlined (por defecto), outlined-fill, rounded, rounded-fill, sharp, sharp-fill.

Tipo: string.

iconSize

Ancho y alto del símbolo. Valor por defecto: 15px.

Tipo: string.

color

Color de relleno del símbolo.

Tipo: string.

containerSize

Ancho y alto de la caja que rodea el símbolo; el símbolo se centra dentro.

Tipo: string.

backgroundColor

Fondo de la caja que rodea el símbolo.

Tipo: string.

borderRadius

Redondeo de las esquinas de la caja.

Tipo: string.

borderSize

Grosor del borde de la caja, p. ej. '1px'. Valor por defecto: 0px.

Tipo: string.

borderColor

Color del borde de la caja. Valor por defecto: #000.

Tipo: string.

Comportamiento y límites

  • Los iconos se cargan según sea necesario y se almacenan en caché en el navegador. Los SVG de Phosphor y Material usan, cuando la caché está vacía, https://universe.arc-rider.com/cdn/; esta conexión debe ser alcanzable y estar permitida en la Content Security Policy de tu app.
  • Establece iconSet y el name correspondiente. El tamaño y el color pertenecen a iconSize y color.
  • El widget es un componente de presentación. La interacción y la etiqueta accesible corresponden al control circundante.

Los campos ArcWidgetSlot admitidos permiten elementos JSX individuales, texto o descriptores de widget. Pasa texto externo como texto JSX; los strings HTML se interpretan como HTML. <a href="/docs/react/patterns/nested-widget-descriptors">Combinar contenidos</a>.

Iconos fijos o nombres dinámicos

Para iconos fijos en tu código, usa el paquete oficial @phosphor-icons/react y pasa el icono como JSX a un slot, como el icon de un Button, el value de un bloque de Layout o el layout de una tarjeta. Los iconos pasan a formar parte del bundle de tu app: solo se incluyen los iconos importados, TypeScript comprueba los nombres y no se contacta con ningún servidor externo.

npm install @phosphor-icons/react
import { ArcWidgetButton } from '@arcrider/arcwidgets-react';
import { PlusIcon } from '@phosphor-icons/react';

export default function Example() { return ( &lt;ArcWidgetButton data={{ title: 'Add', icon: &lt;PlusIcon size={16} /&gt;, iconPosition: 'left' }} /&gt; ); }</code></pre>

El icono toma el color de texto del widget que lo rodea (currentColor); weight="fill" elige la variante rellena.

ArcWidgetIcon está pensado para iconos cuyo nombre solo se conoce en tiempo de ejecución, por ejemplo guardado en tus datos o elegido por los usuarios. Carga el icono la primera vez que se muestra.

Origen de los iconos, privacidad y alojamiento propio

La primera vez que se muestra un icono, su SVG se descarga del CDN de Arc Rider (https://universe.arc-rider.com/cdn/) y se guarda en el navegador, de modo que cada icono se solicita una sola vez por navegador. Así, los catálogos completos de Phosphor y Material Symbols están disponibles sin instalar nada: usa cualquier nombre de <a href="https://phosphoricons.com">phosphoricons.com</a> o <a href="https://fonts.google.com/icons">fonts.google.com/icons</a>.

  • Privacidad: cada solicitud transmite la dirección IP del visitante a Arc Rider Ventures GmbH, como con cualquier recurso web externo. Si tu política de privacidad enumera servicios de terceros, añade universe.arc-rider.com o carga los iconos desde tu propio servidor (ver más abajo). En caso de duda, consulta a tu responsable de protección de datos.
  • Content Security Policy: permite https://universe.arc-rider.com en connect-src.
  • Nombres desconocidos: un nombre o estilo mal escrito no muestra nada y registra en la consola del navegador una advertencia con la URL solicitada. Las descargas fallidas nunca se guardan.
  • Seguridad: los archivos descargados se reducen a formas simples antes de insertarse; se eliminan scripts, manejadores de eventos, estilos en línea y referencias externas.
  • Actualización: los iconos en caché se renuevan automáticamente cuando una versión del paquete actualiza los archivos de iconos.

Para servir los iconos tú mismo, copia los archivos a una carpeta estática de tu app y llama a configureIcons una vez al iniciar la app, antes de que se renderice el primer icono. Una llamada sin opciones restablece el CDN de Arc Rider.

import { configureIcons } from '@arcrider/arcwidgets-react';

configureIcons({ phosphorBaseUrl: '/icons/phosphor', materialSymbolsBaseUrl: '/icons/material', });</code></pre>

npm install @phosphor-icons/core @material-symbols/svg-400
cp -r node_modules/@phosphor-icons/core/assets public/icons/phosphor
cp -r node_modules/@material-symbols/svg-400 public/icons/material

Cada carpeta debe contener las carpetas de estilo (regular, bold, fill … en Phosphor; outlined, rounded, sharp en Material Symbols).

Licencias: Phosphor Icons (MIT) y Material Symbols (Apache 2.0) se pueden usar en apps comerciales; si copias los archivos, conserva los textos de licencia incluidos.

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 ArcWidgetIconData {
	iconSet?: 'phosphor' | 'material_symbols';
	name: string;
	style?: string;
	iconSize?: string;
	color?: string;
	containerSize?: string;
	backgroundColor?: string;
	borderRadius?: string;
	borderSize?: string;
	borderColor?: string;
}

export interface ArcWidgetIconProps extends ArcReactWidgetProps&lt;ArcWidgetIconData&gt; {}

export interface ArcConfigureIconsOptions { phosphorBaseUrl?: string; materialSymbolsBaseUrl?: string; }

export declare function configureIcons(options?: ArcConfigureIconsOptions): void;</code></pre>