Arc Rider Docs · Markdown

Mini Widgets

Signature

Signature en React

Captura una firma en un lienzo y pásala como imagen a tu aplicación. El ejemplo guarda localmente en el navegador.

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

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

export default function Example() { const [value, setValue] = useState&lt;string | undefined&gt;(); return ( &lt;ArcWidgetSignature data={{ value, height: '220px', placeholder: 'Sign here', confirmLabel: 'Confirm', clearLabel: 'Clear', }} onSave={setValue} onClear={() =&gt; setValue(undefined)} /&gt; ); }</code></pre>

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

onSave

La firma se ha confirmado. Recibe una data-URL PNG (data:image/png;base64,…) con el tamaño del lienzo multiplicado por el device pixel ratio. Si devuelves una promesa, la vista previa aparece cuando se resuelve.

onSave?: (dataUrl: string) => void | Promise<void>;

onClear

El usuario ha vaciado el lienzo.

onClear?: () => void | Promise<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.

value

Firma guardada como data-URL de imagen, p. ej. el resultado de onSave. Se muestra como vista previa con un botón para volver a firmar; los valores que no empiezan por data:image/ abren un lienzo vacío.

Tipo: string | null.

height

Alto del lienzo, p. ej. "220px". Valor por defecto: 200px.

Tipo: string.

autoSaveDelay

Milisegundos tras el último trazo hasta que la firma se guarda sola; 0 guarda de inmediato. Sin este valor, solo guarda el botón de confirmar.

Tipo: number.

confirmLabel

Tooltip y nombre accesible del botón de confirmar. Valor por defecto: Bestätigen (alemán).

Tipo: string.

lineColor

Color del trazo. Valor por defecto: #000000.

Tipo: string.

lineWidth

Grosor del trazo en píxeles CSS. Valor por defecto: 2.

Tipo: number.

backgroundColor

Color de fondo del lienzo; forma parte de la imagen guardada. Valor por defecto: #FFFFFF.

Tipo: string.

placeholder

Aviso que se muestra en el lienzo vacío.

Tipo: string.

readonly

Muestra la firma guardada sin controles de edición. Valor por defecto: false.

Tipo: boolean.

clearLabel

Tooltip y nombre accesible del botón de borrar. Valor por defecto: Löschen (alemán).

Tipo: string.

editLabel

Tooltip y nombre accesible del botón para volver a firmar. Valor por defecto: Neu unterschreiben (alemán).

Tipo: string.

Comportamiento y límites

  • onSave entrega una data-URL PNG; onClear notifica el vaciado. Mantén data.value sincronizado con el estado guardado.
  • El guardado se hace con el botón de confirmar abajo a la derecha. autoSaveDelay es opcional y confirma automáticamente tras una pausa. readonly impide la edición.
  • Para almacenamiento duradero o entre dispositivos, sustituye el almacenamiento local por tu API.

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 ArcWidgetSignatureData {
	value?: string | null;
	height?: string;
	autoSaveDelay?: number;
	lineColor?: string;
	lineWidth?: number;
	backgroundColor?: string;
	placeholder?: string;
	readonly?: boolean;
	clearLabel?: string;
	confirmLabel?: string;
	editLabel?: string;
}

export interface ArcWidgetSignatureProps extends ArcReactWidgetProps&lt;ArcWidgetSignatureData&gt; { onSave?: (dataUrl: string) =&gt; void | Promise&lt;void&gt;; onClear?: () =&gt; void | Promise&lt;void&gt;; }</code></pre>