EditableCheckboxField
EditableCheckboxField muestra un valor booleano como un ícono de checkbox en modo lectura (marcado o desmarcado). Al hacer clic en el ícono de edición se renderiza un CheckboxField interactivo. Al guardar, el valor booleano (true/false) se persiste mediante la API.
Props
| Prop | Tipo | Requerido | Por defecto | Descripción |
|------|------|-----------|-------------|-------------|
| name | string | Sí | — | Nombre del campo enviado como clave en el payload de actualización. |
| value | boolean | Sí | false | Valor booleano actual. |
| updatePath | string | Sí | — | Ruta del endpoint API para persistir el cambio. |
| label | string | No | — | Etiqueta mostrada junto al checkbox en modo edición y lectura. |
| description | string | No | — | Texto de ayuda mostrado junto a la etiqueta en modo edición. |
| apiBaseUrl | string | No | — | URL base que se antepone a updatePath. |
| useAuthToken | boolean | No | false | Cuando es true, el request incluye el token de autorización. |
| onEditStart | () => void | No | — | Llamado cuando comienza el modo edición. |
| onEditSuccess | (updatedValue: boolean, newFormData: any) => void | No | — | Llamado tras un guardado exitoso. |
| onEditError | (error: any) => void | No | — | Llamado al fallar el request; el valor se revierte. |
| onEditCancel | () => void | No | — | Llamado al cancelar; el valor se revierte. |
| editIcon | string | No | "pencil" | Nombre del ícono para el botón de edición. |
| saveIcon | string | No | "check" | Nombre del ícono para el botón de guardar. |
| cancelIcon | string | No | "close" | Nombre del ícono para el botón de cancelar. |
| containerStyle | React.CSSProperties | No | — | Estilo del contenedor externo. |
| labelStyle | React.CSSProperties | No | — | Estilo del texto de etiqueta. |
| descriptionStyle | React.CSSProperties | No | — | Estilo del texto de descripción. |
Uso
Básico
import React, { useState } from 'react';
import EditableCheckboxField from '@/components/editable-fields/EditableCheckboxField';
export default function Example() {
const [isActive, setIsActive] = useState(true);
return (
<EditableCheckboxField
label="Active"
name="is_active"
value={isActive}
updatePath="/v1/users/42"
apiBaseUrl="https://api.example.com"
useAuthToken
onEditSuccess={(updated) => setIsActive(updated)}
/>
);
}