Mini Widgets
Progress Bar
ProgressBar en React
Representa un valor parcial en relación con un valor total, por ejemplo tareas completadas u objetivos alcanzados.
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 ArcWidgetProgressBarData. 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.
valueProgress
Valor de progreso actual; los strings numéricos se interpretan. Valor por defecto: 0.
Tipo: number | string.
valueTotal
Valor objetivo; la barra permanece vacía mientras no sea mayor que cero. Valor por defecto: 0.
Tipo: number | string.
valueText
Etiqueta de texto plano que se muestra en negrita junto a la pista; se oculta si está vacía.
Tipo: string | number.
progressColor
Color de la zona rellena. Si se omite, es ámbar por debajo del 100 %, verde exactamente al 100 % y negro por encima del 100 %.
Tipo: string.
backgroundColor
Color de la pista. Valor por defecto: rgba(0,0,0,0.25).
Tipo: string.
width
Ancho de la pista. Valor por defecto: 100%.
Tipo: string.
height
Alto de la pista. Valor por defecto: 10px.
Tipo: string.
borderRadius
Redondeo de las esquinas de la pista. Valor por defecto: 50px.
Tipo: string.
fontColor
Color de la etiqueta. Valor por defecto: #000000.
Tipo: string.
fontSize
Tamaño de fuente de la etiqueta. Valor por defecto: 12px.
Tipo: string.
Comportamiento y límites
valueProgressyvalueTotalforman la proporción. Usa un valor total mayor que cero.
valueTextes una etiqueta propia. El cálculo y formateo de los valores de negocio se realiza en React.
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 ArcWidgetProgressBarData {
valueProgress?: number | string;
valueTotal?: number | string;
valueText?: string | number;
progressColor?: string;
backgroundColor?: string;
width?: string;
height?: string;
borderRadius?: string;
fontColor?: string;
fontSize?: string;
}
export interface ArcWidgetProgressBarProps extends ArcReactWidgetProps<ArcWidgetProgressBarData> {}</code></pre>