Arc Rider Docs · Markdown

Mini Widgets

Text

Text en React

Muestra texto o contenidos de React con tipografía y alineación uniformes.

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 ArcWidgetTextData. 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 representació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.

value

Contenido a mostrar; null y undefined no renderizan nada.

Tipo: ArcWidgetSlot.

width

Ancho del widget. Valor por defecto: 100%.

Tipo: string.

height

Alto del widget, p. ej. "320px"; 'auto' mantiene la altura del contenido. Los valores en porcentaje necesitan un contenedor padre con altura fija. Valor por defecto: auto.

Tipo: string.

alignX

Posición horizontal del bloque de texto dentro del widget. Valor por defecto: left.

Tipo: 'left' | 'center' | 'right'.

alignY

Posición vertical del bloque de texto dentro del widget. Valor por defecto: top.

Tipo: 'top' | 'center' | 'bottom'.

fontSize

Tamaño de fuente como valor CSS. Valor por defecto: 13px.

Tipo: string.

fontWeight

Grosor de la fuente. Valor por defecto: 400.

Tipo: string | number.

fontColor

Color de la fuente. Valor por defecto: #000.

Tipo: string.

lineHeight

Altura de línea. Valor por defecto: normal.

Tipo: string.

textAlign

Alineación de las líneas dentro del bloque de texto; usa alignX para posicionar el propio bloque. Valor por defecto: left.

Tipo: 'left' | 'center' | 'right' | 'justify' | 'start' | 'end'.

textWrap

Comportamiento de espacios en blanco y salto de línea (CSS white-space). Valor por defecto: normal.

Tipo: 'normal' | 'nowrap' | 'pre' | 'pre-wrap' | 'pre-line' | 'break-spaces'.

textScroll

true permite que el texto se desplace verticalmente cuando supera height; la barra de desplazamiento permanece oculta. Valor por defecto: false.

Tipo: boolean.

textDirection

'vertical' gira el texto para leerlo de abajo arriba. Valor por defecto: horizontal.

Tipo: 'horizontal' | 'vertical'.

textDecoration

Línea de decoración debajo, a través o encima del texto: type (underline, line-through, overline) es obligatorio; style (por defecto solid), color (por defecto #000) y thickness (por defecto 1px) son opcionales.

Tipo: ArcWidgetTextDecoration.

truncate

Recorta el texto a una sola línea con puntos suspensivos; necesita un ancho limitado. Valor por defecto: false.

Tipo: boolean.

Comportamiento y límites

  • value admite JSX. Es posible el rich text de fuente propia; para contenidos externos, un elemento de texto de React es la opción segura.
  • truncate recorta textos largos. Un ancho limitado es requisito para ello.

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

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 ArcWidgetTextDecoration {
	type?: 'underline' | 'line-through' | 'overline';
	style?: 'solid' | 'double' | 'dotted' | 'dashed' | 'wavy';
	color?: string;
	thickness?: string;
}

export interface ArcWidgetTextData { value?: ArcWidgetSlot; width?: string; height?: string; alignX?: 'left' | 'center' | 'right'; alignY?: 'top' | 'center' | 'bottom'; fontSize?: string; fontWeight?: string | number; fontColor?: string; lineHeight?: string; textAlign?: 'left' | 'center' | 'right' | 'justify' | 'start' | 'end'; textWrap?: 'normal' | 'nowrap' | 'pre' | 'pre-wrap' | 'pre-line' | 'break-spaces'; textScroll?: boolean; textDirection?: 'horizontal' | 'vertical'; textDecoration?: ArcWidgetTextDecoration; truncate?: boolean; }

export interface ArcWidgetTextProps extends ArcReactWidgetProps&lt;ArcWidgetTextData&gt; {}</code></pre>