Global

Members

(constant) ALERT_CFG :Object.<string, AlertConfig>

Objeto de configuración para los diferentes tipos de alertas.
Type:
Source:

(constant) PATTERNS :ValidationPatterns

Objeto que contiene los patrones de validación para diferentes campos.
Type:
Source:

(constant) TITLES :ValidationTitles

Objeto que contiene los mensajes de error para diferentes campos.
Type:
Source:

(constant) theme :Theme

Objeto que contiene el tema de colores utilizado en la aplicación y adaptado a la identidad institucional.
Type:
Source:

Methods

ArrowIcon(props) → {JSX.Element}

Componente de icono de flecha(<-).
Parameters:
Name Type Description
props Object Propiedades del componente.
Properties
Name Type Attributes Default Description
width number <optional>
 48 Ancho del icono.
height number <optional>
 48 Altura del icono.
color string <optional>
 Color del icono.
Source:
Returns:
Componente de icono de flecha(<-).
Type
JSX.Element

Button(handler, tooltip, secundary, props, fixed, color) → {JSX.Element}

Componentes de boton.
Parameters:
Name Type Description
handler function Función que maneja el evento click del botón.
tooltip string Texto que se muestra como tooltip cuando el cursor es colocado encima del boton
secundary boolean Indica si el botón es secundario. Si es verdadero, el boton tendra un estilo diferente
props * Props adicionales a ser aplicadas al botón.
fixed boolean Indica si el botón es fijo. Si es verdadero, el botón tendra una posicion fija
color string Color del botón. Puede ser 'yellow', 'blue', 'red', 'purple', o 'green'.
Source:
Returns:
- Elemento JSX que representa un botón generico o redondo
Type
JSX.Element

CheckIcon(props) → {JSX.Element}

Componente de icono de check(✓).
Parameters:
Name Type Description
props Object Propiedades del componente.
Properties
Name Type Attributes Default Description
width number <optional>
 48 Ancho del icono.
height number <optional>
 48 Altura del icono.
color string <optional>
 Color del icono.
Source:
Returns:
Componente de icono de check(✓).
Type
JSX.Element

EditIcon(props) → {JSX.Element}

Componente de icono de editar.
Parameters:
Name Type Description
props Object Propiedades del componente.
Properties
Name Type Attributes Default Description
width number <optional>
 48 Ancho del icono.
height number <optional>
 48 Altura del icono.
color string <optional>
 Color del icono.
Source:
Returns:
Componente de icono de editar.
Type
JSX.Element

LogoutIcon(props) → {JSX.Element}

Componente de icono de cerrar sesión
Parameters:
Name Type Description
props Object Propiedades del componente.
Properties
Name Type Attributes Default Description
width number <optional>
 48 Ancho del icono.
height number <optional>
 48 Altura del icono.
color string <optional>
 Color del icono.
Source:
Returns:
Componente de icono de cerrar sesión.
Type
JSX.Element
Componente funcional de React para una barra de navegación.
Parameters:
Name Type Description
props Object Las propiedades del componente.
Properties
Name Type Description
logged boolean Indica si el usuario ha iniciado sesión o no.
title string El título que se mostrará en la barra de navegación.
handlerLogout function La función que se llamará cuando se haga clic en el botón de cerrar sesión.
Source:
Returns:
Un elemento JSX que representa la barra de navegación.
Type
JSX.Element

PlusIcon(props) → {JSX.Element}

Componente de icono de más(+).
Parameters:
Name Type Description
props Object Propiedades del componente.
Properties
Name Type Attributes Default Description
width number <optional>
 48 Ancho del icono.
height number <optional>
 48 Altura del icono.
color string <optional>
 Color del icono.
Source:
Returns:
Componente de icono de más(+).
Type
JSX.Element

TrashIcon(props) → {JSX.Element}

Componente de icono de papelera (Eliminar).
Parameters:
Name Type Description
props Object Propiedades del componente.
Properties
Name Type Attributes Default Description
width number <optional>
 48 Ancho del icono.
height number <optional>
 48 Altura del icono.
color string <optional>
 Color del icono.
Source:
Returns:
Componente de icono de papelera (Eliminar).
Type
JSX.Element

UdeaIcon(props) → {JSX.Element}

Componente de icono de la Universidad de Antioquia simplificado (UdeA).
Parameters:
Name Type Description
props Object Propiedades del componente.
Properties
Name Type Attributes Default Description
width number <optional>
 48 Ancho del icono.
height number <optional>
 48 Altura del icono.
color string <optional>
 Color del icono.
Source:
Returns:
Componente de icono de la Universidad de Antioquia simplificado (UdeA).
Type
JSX.Element

Units() → {JSX.Element}

Componente para la página de visualización del listado de unidades académicas.
Source:
Returns:
Elemento JSX que representa la página del listado de unidades académicas.
Type
JSX.Element

ViewSubunit() → {JSX.Element}

Componente página para mostrar los detalles de una subunidad académica.
Source:
Returns:
Elemento JSX que muestra los detalles de la subunidad académica.
Type
JSX.Element

ViewUnit() → {JSX.Element}

Componente para la página de visualización de una unidad académica específica. En está página se puede ver la información de la unidad académica, así como las subunidades académicas que la componen.
Source:
Returns:
Elemento JSX que representa la página de visualización de una unidad académica.
Type
JSX.Element

XIcon(props) → {JSX.Element}

Componente de icono de cancelar o cerar (X).
Parameters:
Name Type Description
props Object Propiedades del componente.
Properties
Name Type Attributes Default Description
width number <optional>
 48 Ancho del icono.
height number <optional>
 48 Altura del icono.
color string <optional>
 Color del icono.
Source:
Returns:
Componente de icono de cancelar o cerar (X).
Type
JSX.Element

Type Definitions

AlertConfig

Objeto de configuración para los diferentes tipos de alertas.
Type:
  • Object
Properties:
Name Type Description
title string El título de la alerta.
text string El texto de la alerta.
icon string El ícono de la alerta.
iconColor string El color del ícono de la alerta.
showCancelButton boolean Indica si se muestra el botón de cancelar.
confirmButtonText string El texto a mostrar en el botón de confirmar.
cancelButtonText string El texto a mostrar en el botón de cancelar.
confirmButtonColor string El color del botón de confirmar.
cancelButtonColor string El color del botón de cancelar.
focusCancel boolean El color del botón de cancelar.
focusConfirm boolean El color del botón de confirmar.
Source:

Theme

Tema de colores utilizado en la aplicación.
Type:
  • Object
Properties:
Name Type Description
colors Object Colores utilizados en el tema.
Properties
Name Type Description
primary Object Colores primarios.
Properties
Name Type Description
1 string Color primario 1.
2 string Color primario 2.
3 string Color primario 3.
4 string Color primario 4.
5 string Color primario 5.
secondary Object Colores secundarios.
Properties
Name Type Description
purple string Color secundario morado.
blue string Color secundario azul.
red string Color secundario rojo.
yellow string Color secundario amarillo.
violet string Color secundario violeta.
green string Color secundario verde.
white string Color secundario blanco.
others Object Otros colores.
Properties
Name Type Description
text string Color de texto.
background string Color de fondo.
disabled string Color para elementos deshabilitados.
Source:

ValidationPatterns

Patrones (Expresiones Regulares) de validación para diferentes campos.
Type:
  • Object
Properties:
Name Type Description
name string Patrón para validar el campo de nombre.
code string Patrón para validar el campo de código.
description string Patrón para validar el campo de descripción.
centerCode string Patrón para validar el campo de código del centro.
address string Patrón para validar el campo de dirección.
Source:

ValidationTitles

Mensajes de error para diferentes campos.
Type:
  • Object
Properties:
Name Type Description
name string Mensaje de error para el campo de nombre.
code string Mensaje de error para el campo de código.
description string Mensaje de error para el campo de descripción.
centerCode string Mensaje de error para el campo de código del centro.
address string Mensaje de error para el campo de dirección.
Source: