Arc Rider Docs · Markdown

Premium Widgets

Custom Upload

Upload en React

Selecciona archivos, reduce imágenes y pasa los resultados a tu aplicación. El widget no realiza por sí mismo ningún upload al backend.

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 { ArcWidgetUpload } from '@arcrider/arcwidgets-react';

export default function Example() { return ( &lt;ArcWidgetUpload data={{ multiupload: true, container: { label: 'Upload files', width: '100%', height: '150px' }, }} /&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 ArcWidgetUploadData. 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>.

onUpload

Se llama una vez por cada archivo preparado, con name, src (data URL), las dimensiones de la imagen y original. El siguiente archivo espera hasta que se resuelva un promise devuelto.

onUpload?: (payload: ArcWidgetUploadPayload) => 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.

container

Obligatorio. Contenido del área de subida: label bajo el icono por defecto o tu propio value, además de width, height, paddingX y paddingY.

Tipo: ArcWidgetUploadContainer.

multiupload

Permite seleccionar varios archivos. Valor por defecto: false.

Tipo: boolean.

capture

Abre la cámara trasera en dispositivos compatibles y solo acepta imágenes. Valor por defecto: false.

Tipo: boolean.

allowedFileTypes

Tipos de archivo ofrecidos en el selector de archivos: extensiones como "pdf" o ".docx", tipos MIME como "image/*", o 'all'. Por defecto: imágenes, PDF, XML, CSV y archivos de Excel.

Tipo: string[] | 'all'.

image

Tamaño máximo, formato de salida (jpeg, webp, original) y calidad (por defecto 0.8) para imágenes.

Tipo: ArcWidgetUploadImage.

clipboard

Acepta archivos pegados con Ctrl/Cmd+V. Un objeto define el texto del tooltip y la esquina.

Tipo: boolean | ArcWidgetUploadClipboard.

drag

Seleccionar archivos mediante arrastrar y soltar. Activado por defecto cuando container.value no está establecido; targetId convierte otro elemento, p. ej. una fila de tabla o un bloque de Layout con ese blockId, en destino de soltado.

Tipo: boolean | ArcWidgetUploadDrag.

showLoadingPopup

Diálogo de progreso con un botón de cancelar mientras se procesan los archivos. Valor por defecto: false.

Tipo: boolean.

logs

Registra los resultados de codificación en la consola y muestra una vista previa de la última imagen codificada. Valor por defecto: false.

Tipo: boolean | { enabled?: boolean }.

lang

Idioma de los textos integrados. Valor por defecto: en.

Tipo: 'en' | 'de'.

Comportamiento y límites

  • onUpload se llama por cada archivo y recibe name, src, original y, en el caso de imágenes, las dimensiones. src es la data URL procesada.
  • image controla el tamaño máximo de imagen, el formato y la calidad. multiupload permite varios archivos.
  • Transfiere el archivo en el callback a tu propia API y gestiona allí el éxito y los errores. El widget no incluye ningún servicio de almacenamiento propio.

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 ArcWidgetUploadImage {
	width?: number;
	height?: number;
	format?: 'jpeg' | 'webp' | 'original';
	quality?: number;
}

export interface ArcWidgetUploadDrag { enabled?: boolean; label?: string; target?: 'area' | 'first-child' | 'layout'; targetId?: string; }

export interface ArcWidgetUploadClipboardTooltip { value?: string; position?: 'bottom-right' | 'bottom-left' | 'bottom-center' | 'top-right' | 'top-left' | 'top-center'; }

export interface ArcWidgetUploadClipboard { tooltip?: string | ArcWidgetUploadClipboardTooltip; }

export interface ArcWidgetUploadContainer { label?: string; value?: ArcWidgetSlot; width?: string; height?: string; paddingX?: string; paddingY?: string; }

export interface ArcWidgetUploadData { container: ArcWidgetUploadContainer; multiupload?: boolean; capture?: boolean; allowedFileTypes?: string[] | 'all'; image?: ArcWidgetUploadImage; clipboard?: boolean | ArcWidgetUploadClipboard; drag?: boolean | ArcWidgetUploadDrag; showLoadingPopup?: boolean; logs?: boolean | { enabled?: boolean }; lang?: 'en' | 'de'; }

export interface ArcWidgetUploadPayload { name: string; src: string; width?: number; height?: number; }

export interface ArcWidgetUploadProps extends ArcReactWidgetProps&lt;ArcWidgetUploadData&gt; { onUpload?: (payload: ArcWidgetUploadPayload) =&gt; void | Promise&lt;void&gt;; }</code></pre>