Documentos de API

Crear diálogo

Crear diálogo - kintone.createDialog()

Crea y muestra un cuadro de diálogo de mensaje en la página.

Función

Escritorio

kintone.createDialog(config)

Parámetros

Parámetro Tipo Obligatorio Descripción
config Object Obligatorio La configuración del diálogo
config.title String Opcional El título
Si se ignora, no se mostrará.
config.body Objeto elemento Opcional El elemento del cuerpo del diálogo
Si se ignora, no se mostrará.
config.showOkButton Boolean Opcional La visibilidad del botón OK
  • true: Monitor
  • false: No mostrar
Si se ignora, se mostrará.
config.okButtonText String Opcional El texto para mostrar en el botón de OK
Si se ignora, "OK" se mostrará según el idioma del usuario que haya iniciado sesión.
config.showCancelButton Boolean Opcional La visibilidad del botón Cancelar
  • true: Monitor
  • false: No mostrar
Si se ignora, no se mostrará.
config.cancelButtonText String Opcional Texto para mostrar en el botón Cancelar
Si se ignora, "Cancelar" se mostrará según el idioma del usuario que haya iniciado sesión.
config.showCloseButton Boolean Opcional La visibilidad del botón de Cerrar
  • true: Monitor
  • false: No mostrar
Si se ignora, no se mostrará.
Si no se muestra, también se desactiva la función para cerrar el diálogo con la tecla Esc.
config.beforeClose Función Opcional Una función que debe ejecutarse antes de cerrar el diálogo mediante cualquiera de las siguientes operaciones: Botón OK/Botón de cancelar/Botón de cerrar/Tecla Esc
La operación seleccionada por el usuario se pasa como argumento a la función.
  • OK: Se pulsa el botón OK
  • CANCEL: Se pulsa el botón Cancelar
  • CLOSE: Se pulsa el botón de Cerrar o se pulsa la tecla Esc
Si la función devuelve false o un valor que se convierte en false Después de la Promise se resuelve, el diálogo no se cierra

Devuelve

Un Promise objeto.
Los siguientes valores se pueden recuperar cuando el Promise objeto se cumple:

Propiedad Tipo Descripción
mostrar Función Una función asíncrona que muestra el diálogo creado
No tiene argumentos.
El valor de retorno es un Promise objeto.
Cuando el diálogo se cierra, el Promise se resuelve el objeto y se pueden recuperar los siguientes valores:
  • OK: Cuando el usuario pulsa el botón OK
  • CANCEL: Cuando el usuario pulsa el botón Cancelar
  • CLOSE: Cuando el usuario pulsa el botón Cerrar o pulsa la tecla Esc
  • FUNCTION: Cuando se llama la función de cierre
cerrar Función Una función que cierra el diálogo
No tiene argumento ni valor de retorno

Páginas disponibles (escritorio)

Sin embargo, no se puede utilizar en las siguientes páginas:

  • Resultados de la búsqueda
  • Marketplace
  • Configuración del plug-in

Solicitud de muestra

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

const bodyElement = document.createElement('p');
bodyElement.textContent = 'Are you sure you want to delete this record?';

// Create a dialog
const dialog = await kintone.createDialog({
  title: 'Delete Confirmation',
  body: bodyElement,
  okButtonText: 'Delete',
  showCancelButton: true,
  cancelButtonText: 'Cancel',
  showCloseButton: true,
  beforeClose: (action) => {
    if (action === 'OK') {
      console.log('Delete');
    } else {
      console.log('Delete canceled');
    }
  }
});

// Show the dialog
await dialog.show();

Notas

El objeto Element especificado en el config.body el argumento se utiliza directamente como elemento del cuerpo del diálogo.
Realiza el proceso de desinfección según sea necesario.