-
Notifications
You must be signed in to change notification settings - Fork 2
jsdoc ui
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
vista |
Busca una hoja de estilos por nombre.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
nombre |
string |
Nombre como expresión regular. |
Devuelve: StyleSheet
|null
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
selector |
||||
tamano |
||||
origen |
Agrega una hoja o un listado de hojas de estilos.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
url |
Procesa un objeto de estilos y establece los estilos contenidos en el mismo para el selector dado.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
selector |
string |
Selector. | ||
obj |
Object[] |
Estilos (objeto compatible con la salida de obtenerEstilos()). |
Devuelve: ui
Establece los estilos para un selector.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
selector |
string |
Selector. | ||
css |
string |Object[]
|
Estilos. Puede ser código CSS o un objeto compatible con la salida de obtenerEstilos(). | ||
tamano |
string |null
|
Tamaño de pantalla. Si se omite, o si es null, se establecerán los estilos generales (sin media query). | Si |
Devuelve: CSSStyleRule
|null
Elimina los estilos para el selector especificado.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
selector |
string |
Selector. | ||
tamano |
string |
Tamaño. Si se omite, se eliminarán todos los estilos para todos los tamaños. | Si |
Devuelve: ui
Renombra los estilos para un selector dado (todos los tamaños).
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
selector |
string |
Selector actual. | ||
selectorNuevo |
string |
Selector nuevo. |
Devuelve: ui
Registra e instancia la clase principal de la aplicación.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
funcion |
function |
Devuelve la instancia de la clase principal de la aplicacion.
Devuelve: Aplicacion
Devuelve la instancia de la clase principal de la aplicacion (alias de ui.obtenerAplicacion()).
Devuelve: Aplicacion
Genera y devuelve un selector CSS único.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
tipo |
string |
Tipo de componente. | Si | |
nombre |
string |
Nombre del componente. | Si |
Devuelve: string
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
nombre |
||||
funcion |
||||
configuracion |
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
nombre |
Crea una instancia de un componente dado su nombre.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
comp |
Object |string
|
Nombre del componente u objeto que representa el componente, si se está creando un componente previamente guardado (desde JSON). | ||
vista |
componenteVista |
Instancia de la vista. | Si |
Devuelve: Componente
Elimina un componente dada su instancia. Equivalente a componente.eliminar()
.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
componente |
componente |
Componente a eliminar. |
Devuelve: ui
Busca y elimina apropiadamente los componentes descendientes del elemento especificado.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
elemento |
Node |
Elemento a analizar. elemento puede ser un componente. |
||
eliminarElemento |
boolean |
Si es true , luego de eliminar los componentes que pueda contener, también removerá del DOM el nodo especificado en elemento . |
Si | true |
Devuelve: ui
Busca y elimina apropiadamente los componentes descendientes del elemento especificado.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
elemento |
NodeList |
Listado de elementos a analizar. | ||
eliminarElemento |
boolean |
Si es true , luego de eliminar los componentes que puedan existir en el listado, también removerá del DOM todos los nodos contenidos en elemento . |
Si | true |
Devuelve: ui
Busca y elimina apropiadamente los componentes descendientes del elemento especificado.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
elemento |
Node[] |
Listado de elementos a analizar. | ||
eliminarElemento |
boolean |
Si es true , luego de eliminar los componentes que puedan existir en el listado, también removerá del DOM todos los nodos contenidos en elemento . |
Si | true |
Devuelve: ui
Finaliza las tareas de limpieza tras la eliminación de un componente. Método de uso interno.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
componente |
componente |
Devuelve: ui
Devuelve las instancias de los componentes existentes.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
vista |
Devuelve la instancia de un componente dado su ID, instancia, nombre o elemento del DOM.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
param |
* |
Valor a evaluar. |
Devuelve: Componente
Devuelve la instancia de un componente dado su ID, instancia, nombre o elemento del DOM (alias de ui.obtenerInstanciaComponente(param)).
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
param |
* |
Valor a evaluar. |
Devuelve: Componente
Elimina la instancia de un componente dado su ID, instancia, nombre o elemento del DOM.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
param |
Busca todos los componentes con nombre y devuelve un objeto con sus valores.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
vista |
componenteVista |
Instancia de la vista. Si se omite, o es null , se devolverán todos los campos de la página. |
Si |
Devuelve: Object
Establece los valores de todos los componentes cuyos nombres coincidan con las propiedades del objeto.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
valores |
Object |
Pares nombre/valor a asignar. | ||
nombreVista |
string |
Nombre de la vista. Si se omite, se aplicará sobre todos los campos de la página. | Si |
Registra un componente en el almacén global componentes
.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
componente |
componente |
Instancia del componente. |
Devuelve: ui
Remueve un componente del almacén global componentes
.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
componente |
componente |
Instancia del componente. |
Devuelve: ui
Devuelve el HTML de la vista.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
paginaCompleta |
boolean |
Determina si debe devolver el HTML de la página completa o, por el contrario, solo del cuerpo. | Si | true |
Devuelve: string
Devuelve el CSS de la vista.
Genera y devuelve un JSON con las relaciones entre el DOM y los componentes.
Genera y devuelve el objeto correspondiente a un componente en particular para ser almacenado en el JSON.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
obj |
* |
Instancia o cualquier valor que identifique al componente compatible con obtenerInstanciaComponente(). |
Devuelve: Object
Inserta el código html en el cuerpo del editor. Este método solo debería utilizarse en modo edición.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
html |
Almacena el JSON para la vista principal.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
valor |
Object |string
|
Objeto o JSON codificado. |
Inicializa la vista y sus componentes dado su json.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
json |
Object |string
|
Objeto de la vista. | ||
controlador |
controlador |
Instancia del controlador de la vista. | Si | |
vista |
componenteVista |
Instancia de la vista. | Si | |
soloVista |
boolean |
Si es true , buscará e inicializará únicamente el componente de la vista; false , solo los componentes excepto la vista; null (o la omisión del parámetro) procesará todos los componentes. |
Si | null |
Devuelve: string
|undefined
Inicializa la vista dado su json.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
json |
Object |string
|
Objeto de la vista. | ||
controlador |
controlador |
Instancia del controlador de la vista. | Si |
Devuelve: componenteVista
Inicializa los componentes de la vista (excepto el componente Vista propiamente dicho) dado su json.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
json |
Object |string
|
Objeto de la vista. | ||
controlador |
controlador |
Instancia del controlador de la vista. | Si | |
vista |
componenteVista |
Instancia de la vista. | Si |
Devuelve: ui
Crea la instancia del controlador.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
nombre |
||||
principal |
Limpia todos los parámetros de la ui.
Busca el primer componente o elemento con autofoco y da foco al mismo.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
elem |
Node |
Limitar a la descendencia del elemento especificado. | Si |
Devuelve: ui
Prepara la utilidad de auto-seleccionar-todo el contenido de los campos.
Devuelve: ui
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
nombre |
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
nombre |
Devuelve la instancia de la vista (es decir, del componente, no del controlador).
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
nombre |
string |
Nombre de la vista embebible. Si se omite, devolverá la vista principal. | Si |
Devuelve: Componente
Desencadena la actualización de componentes en toda la vista. Este método no redibuja todos los componentes ni reasigna todas las propiedades de cada uno. Está diseñado
para poder solicitar a los componentes que se refresquen o vuelvan a cargar determinadas propiedades, como el origen de datos. Cada componente lo implementa, o no, de
forma específica.
Devuelve: ui
Recarga la página.
Recupera el código HTML y JSON de una vista embebible y envía un objeto {json,html} a la función especificada.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
nombre |
string |
Nombre de la vista. | ||
retorno |
function |
Función de retoro. | ||
precarga |
boolean |string
|
Mostrar precarga. TRUE para la precarga normal, "barra" para utilizar la barra de progreso o FALSE para deshabilitar. | Si | "barra" |
Devuelve: ui
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
nombre |
||||
funcion |
Devuelve el controlador de la vista principal.
Devuelve la instancia del controlador.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
nombre |
string |
Nombre del controlador de vista embebible. Si se omite, devolverá el controlador de la vista principal. | Si |
Devuelve: Controlador
Devuelve el listado de controladores disponibles.
Devuelve el listado de controladores instanciados.
Busca y devuelve un controlador dado su nombre, creándolo si no existe.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
nombre |
string |
Nombre del controlador. | ||
principal |
boolean |
Determina si es el controlador de la vista principal. | Si | false |
unico |
boolean |
Si es false , devolverá la instancia existente en lugar de crear una nueva (singleton). |
Si | false |
Devuelve: controlador
Devuelve la instancia del controlador para la vista dada. No creará el controlador si no existe.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
nombre |
string |
Nombre de la vista. |
Devuelve: controlador
|null
Registra un módulo.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
nombre |
string |
Nombre del módulo. | ||
funcion |
function |
Función. |
Devuelve: ui
Crea y devuelve una nueva instancia del módulo especificado.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
nombre |
string |
Nombre del módulo. |
Devuelve: Modulo
Devuelve el tamaño de pantalla como string: xs|sm|md|lg|xl.
Devuelve todos los posibles tamaños con formato {nombre:ancho máximo}.
Devuelve los nombres de los posibles tamaños como array ordenado de menor a mayor.
Devuelve todos los posibles tamaños con formato {ancho máximo:nombre}.
Inlcuye un archivo js, invocando el callback cuando el archivo haya sido cargado y ejecutado.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
ruta |
||||
funcion |
Inlcuye un archivo CSS.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
ruta |
Determina si se está ejecutando en un dispositivo móvil.
Evalúa una expresión utilizando el intérprete configurado con diferentes objetos predefinidos relacionados a la interfaz y la aplicación.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
valores |
Object |
Valores de las variables en la expresión. | Si |
Propiedad | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
objeto |
* |
Valor de objeto . |
Si | |
controlador |
controlador |
Valor de controlador . |
Si | |
componente |
componente |
Valor de componente . |
Si | |
componentes |
componentes |
Valor de componentes . |
Si | valores.controlador.componentes |
this |
* |
Valor de this , si la expresión resuelve a una función. |
Si | |
valor |
* |
Valor de valor . |
Si |
Registra un enrutador.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
nombre |
string |
|||
funcion |
function |
Devuelve la instancia del enrutador.
Devuelve la instancia del enrutador (alias de ui.obtenerEnrutador()).
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
url |
Navega a la vista o URL especificada.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
ruta |
string |
URL o nombre de vista de destino. | ||
nuevaVentana |
boolean |
Abrir en una nueva ventana. | Si | false |
Devuelve: ui
Cambia la URL hacia la vista o URL especificada, sin navegar hacia ella.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
ruta |
string |
URL o nombre de vista de destino. | ||
nuevaVentana |
boolean |
Abrir en una nueva ventana. | Si | false |
Devuelve: ui
Vuelve a la URL anterior. Este método no invoca el evento 'volver'.
Devuelve: ui
Cambia la URL sin navegar hacia la misma.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
url |
string |
URL de destino. | ||
estado |
Object |
Estado. | Si | null |
Devuelve: ui
Abre una ventana emergente con la vista o URL especificada.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
ruta |
string |
URL o nombre de vista de destino. |
Devuelve: Window
Inicia la descarga de la URL especificada.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
url |
string |
URL. |
Devuelve: ui
Activa o desactiva el diálogo de confirmación antes de navegar a otra URL o salir de la vista actual.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
activar |
boolean |
Activa (true ) o desactiva (false ) este comportamiento. |
Si | true |
mensaje |
string |
Mensaje. Nótese que cuando se utiliza el diálogo nativo, la mayoría de los navegadores actualmente ignora este texto. | Si | "¿Estás seguro de querer continuar?" |
Devuelve: ui
Establece los eventos globales de la interfaz.
Devuelve: ui
Invoca el método correspondiente al evento en todos los controladores. Devuelve true
si la propagación del evento fue detenida.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
nombre |
string |
Nombre del evento. | ||
params |
* |
Parámetros a pasar al método. | Si | |
obj |
controlador |
Ejecutar solo en un controlador en particular, dada su instancia. | Si |
Devuelve: boolean
Invoca el método correspondiente al evento en todos los componentes.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
origen |
Object |
Repositorio de componentes. Especificar null para ejecutar en todos los componentes del sistema. |
||
nombre |
string |
Nombre del evento. | ||
soloImplementados |
boolean |
Si es true , solo invocará aquellos métodos implementados en el componente concreto (no invocará métodos heredados). |
Si | false |
params |
* |
Parámetros a pasar al método. | Si |
Devuelve: boolean
Devuelve la instancia de la propia ventana de Electron.
Devuelve: Object
|null
Si es Cordova o cliente de escritorio, cierra la aplicación.
Devuelve: ui
Devuelve los parámetros de la URL.
Devuelve: Object
Devuelve el valor de un parámetro de la URL, o null si no existe.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
nombre |
string |
Devuelve: string
|null
Inicializa el sistema.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
nombreVista |
||||
opciones |
Prepara las referencias al documento.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
nuevoDoc |
Inicializa la vista y ejecuta su controlador.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
nombre |
string |
Nombre de la vista. | ||
principal |
boolean |
Determina si se trata de la vista principal. | ||
json |
Object |
Objeto JSON decodificado de la vista. | Si | |
html |
string |
Código HTML, en caso de tratarse de una vista secundaria. | Si | |
destino |
Node |
Elemento de destino, en caso de tratarse de una vista secundaria. | Si | |
retorno |
function |
Función de retorno. | Si |
Devuelve: ui
Finaliza la ejecución de la vista e invoca el evento fin
en su controlador y sus componentes.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
vista |
componenteVista |
Vista. |
Devuelve: ui
Elimina todas las referencias a la vista, su controlador y sus componentes. Se espera el llamado a este método desde el controlador
tras responder al evento fin
.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
vista |
componenteVista |
Vista. |
Devuelve: ui
Inicia la ejecución del sistema.
Devuelve: ui
Construye un menú.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
items |
Object[] |
Items del menú. | ||
clase |
string |
Clase CSS. | Si | |
destino |
Node |
Elemento de destino. | Si | ui.obtenerCuerpo() |
Propiedad | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
etiqueta |
string |
Etiqueta. | ||
accion |
function |
Función a ejecutar al seleccionarse la opción. | Si | |
habilitado |
function |boolean
|
Estado del item o función a ejecutar para determinar si el item se encuentra habilitado. | Si | true |
separador |
boolean |
Determina si el item es seguido de un separador. | Si | false |
submenu |
Object[] |
Items del submenú (admiten las mismas propiedades que items). | Si |
Devuelve: Object
Actualiza el estado de los items del menú.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
menu |
Object |
Menú generado con ui.construirMenu(). |
Devuelve: ui
Determina si un elemento o nodo es parte del DOM de un menú que se encuentra abierto.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
elem |
Node |
Elemento a evaluar. |
Devuelve: boolean
Devuelve los menú actualmente abiertos.
Devuelve: Object[]
Abre un menú.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
obj |
Object[] |Object
|
Array de items de menú, un menú generado con ui.construirMenu() o cualquier elemento del DOM compatible. | ||
posicion |
Node |Object
|
Si se especifica un elemento del DOM, se posicionará el menú sobre el mismo; en caso contrario, debe especificarse un objeto con las propiedades {x,y}. | Si | |
clase |
string |
Clase CSS. | Si |
Devuelve: ui
Hace aparecer el elemento en forma animada utilizando animaciones CSS.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
elem |
Node |
Elemento. | ||
retorno |
function |
Función de retorno. | Si |
Devuelve: ui
Hace desaparecer y oculta el elemento en forma animada utilizando animaciones CSS.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
elem |
Node |
Elemento. | ||
retorno |
function |
Función de retorno. | Si |
Devuelve: ui
Oculta el elemento mediante el mismo mecanismo que animarDesaparecer(), pero de forma inmediata.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
elem |
Node |
Elemento. |
Devuelve: ui
Detiene la animación en curso.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
elem |
Node |
Elemento. |
Devuelve: ui
Muestra una animación de precarga.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
tipo |
string |
Tipo de precarga. "barra" mostrará una barra de progreso superior que no bloquee la vista; cualquier otro valor mostrará la precarga normal a pantalla completa. | Si |
Devuelve: ui
Oculta la animación de precarga.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
tipo |
string |
Tipo de precarga. "barra" mostrará una barra de progreso superior que no bloquee la vista; cualquier otro valor mostrará la precarga normal a pantalla completa. | Si |
Devuelve: ui
Construye un cuadro de diálogo.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
parametros |
Object |
Parámetros. |
Propiedad | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
cuerpo |
string |Node
|
Elemento o HTML a incluir en el cuerpo. | Si | |
opciones |
Object[] |
Botones de acción a generar. | Si | |
opciones.etiqueta |
string |
Etiqueta del botón. | Si | |
opciones.clase |
string |
Clase CSS del botón. | Si | |
opciones.predeterminado |
boolean |
Determina si es la acción predeterminada. | Si | |
retorno |
function |
Función de retorno al cerrar el diálogo (Resultado). Recibirá como parámetro el índice del botón, o NULL si fue cancelado. | Si | |
retornoAbierto |
function |
Función de retorno al abrir el diálogo. | Si | |
mostrarCerrar |
boolean |
Determina si se debe mostrar la X para cancelar el diálogo. | Si | false |
eliminar |
boolean |
Determina si el diálogo se debe eliminar luego de cerrado. | Si | false |
modal |
boolean |
Si es true, deshabilitará las posibilidades de cancelar el diálogo. | Si | false |
sobreponer |
boolean |
Si es true, se forzará que quede por encima de todo, incluso de la precarga. | Si | false |
icono |
string |
Ícono. Admite una ruta relativa al directorio recursos de la aplicación actual, una URL absoluta, o uno de los siguientes valores: pregunta , exclamacion , alerta , error , informacion , ubicacion , audio , camara , notificacion , seguridad , ok , problema-red . |
Si | null |
destino |
string |Node
|
Elemento de destino, dentro del cual se creará el diálogo. | Si | document.body |
Devuelve: dialogo
Abre un diálogo construido con construirDialogo().
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
dialogo |
dialogo |
Devuelve: ui
Devuelve el diálogo actualmente abierto.
Devuelve: Dialogo
|null
Devuelve todos los diálogos abiertos.
Devuelve: dialogo[]
Cierra un diálogo construido con construirDialogo().
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
dialogo |
dialogo |
Diálogo. | Si | |
opcion |
number |
Número de opción que cierra el diálogo, o NULL. | Si | null |
omitirAnimacion |
boolean |
Si es true, ierra el diálogo inmediatamente. | Si | false |
eliminar |
boolean |
Eliminar el diálogo luego de cerrar. Si se omite, se tomará de la configuración del diálogo. | Si |
Devuelve: ui
Elimina o destruye un diálogo construido con construirDialogo().
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
dialogo |
dialogo |
Construye un menú.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
items |
Object[] |
Items del menú. | ||
clase |
string |
Clase CSS. | Si | |
destino |
Node |
Elemento de destino. | Si | ui.obtenerCuerpo() |
Propiedad | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
etiqueta |
string |
Etiqueta. | ||
accion |
function |
Función a ejecutar al seleccionarse la opción. | Si | |
habilitado |
function |boolean
|
Estado del item o función a ejecutar para determinar si el item se encuentra habilitado. | Si | true |
separador |
boolean |
Determina si el item es seguido de un separador. | Si | false |
submenu |
Object[] |
Items del submenú (admiten las mismas propiedades que items). | Si |
Devuelve: Object
Actualiza el estado de los items del menú.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
menu |
Object |
Menú generado con ui.construirMenu(). |
Devuelve: ui
Determina si un elemento o nodo es parte del DOM de un menú que se encuentra abierto.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
elem |
Node |
Elemento a evaluar. |
Devuelve: boolean
Devuelve los menú actualmente abiertos.
Devuelve: Object[]
Abre un menú.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
obj |
Object[] |Object
|
Array de items de menú, un menú generado con ui.construirMenu() o cualquier elemento del DOM compatible. | ||
posicion |
Node |Object
|
Si se especifica un elemento del DOM, se posicionará el menú sobre el mismo; en caso contrario, debe especificarse un objeto con las propiedades {x,y}. | Si | |
clase |
string |
Clase CSS. | Si |
Devuelve: ui
¿Probaste Foxtrot? Contanos qué te pareció 🥰 contacto@foxtrot.ar
Índice
Primeros pasos
Gestor de aplicaciones
Editor de vistas
Componentes
Módulos
Comunicación cliente<->servidor
Modelo de datos - ORM
PHPDOC
JSDOC
☝ Comentarios
🤷♂️ Dudas
🤓 Ayuda
⌨ Contribuciones
Escribinos: contacto@foxtrot.ar