Pular para o conteúdo
nexus-dialogs
GitHub npm

Plugins e idiomas

Esta página está disponível apenas em espanhol.

Una forma estable de extender la librería sin tocar su código: ganchos que corren con todos los diálogos (también los de form, wizard, confirmDelete…), tipos de campo propios para los formularios y textos en otros idiomas.

#Instalar un plugin

Un plugin es un objeto con un name y, si quieres, install y ganchos:

import { use, type Plugin } from 'nexus-dialogs'

const auditoria: Plugin = {
  name: 'auditoria',
  // Se llama una vez al instalar. Recibe `configure` y `labels`.
  install: ({ configure }) => configure({ defaults: { dismissible: { backdrop: false } } }),
  // Antes de abrir: devuelve las opciones cambiadas (o nada, si solo observas).
  beforeOpen: (o) => ({ ...o, title: o.title ?? 'Aviso' }),
  // Con el diálogo ya en pantalla.
  afterOpen: (ctx, o) => console.log('abrió', o.title, ctx.dialog),
  // Después de cerrar, con el resultado.
  afterClose: (r, o) => registrar({ titulo: o.title, confirmado: r.confirmed, motivo: r.reason }),
}

use(auditoria) // true; con el mismo nombre otra vez no hace nada y devuelve false
FunciónQué hace
use(plugin)Instala el plugin. Devuelve false si ya había uno con ese nombre
unuse(name)Lo quita. Devuelve false si no estaba
plugins()Los nombres de los instalados, en orden

#Cómo se comportan los ganchos

#Tipos de campo propios

Con registerField (en nexus-dialogs/forms) un plugin agrega un tipo que se usa como cualquier otro en form() y wizard():

import { registerField } from 'nexus-dialogs/forms'

const quitar = registerField('rating', (ctx, valor) => {
  const el = document.createElement('input')
  el.id = ctx.id // la etiqueta del campo apunta aquí
  el.type = 'number'
  el.min = '1'
  el.max = '5'
  el.value = String(valor ?? 3)
  return {
    el,
    value: () => Number(el.value),
    focus: () => el.focus(),
    invalid: (on) => el.toggleAttribute('aria-invalid', on),
    validate: () => (Number(el.value) >= 1 ? null : 'Elige de 1 a 5.'),
    summary: () => `${el.value} de 5`, // lo que se ve en la revisión del asistente
  }
})

await form({ title: 'Evalúa', fields: [{ name: 'nota', label: 'Nota', type: 'rating' }] })
quitar() // lo deja de registrar

El control devuelve su el, value(), focus() e invalid(on); validate, summary, group (usa <fieldset> en lugar de <label>) y lazy son opcionales (el tipo CustomControl los describe). La etiqueta, la ayuda y el mensaje de error los pone la librería. No se puede reemplazar un tipo que ya existe: registerField lanza un error.

Como los controles viven dentro del Shadow DOM del diálogo, su CSS debe ir con ellos: un <style> dentro de el, o estilos en línea.

#Textos en otros idiomas

Español e inglés vienen incluidos. Otros idiomas se registran con registerLanguage; lo que no traduzcas se ve en inglés:

import { registerLanguage, configure, pageLanguage } from 'nexus-dialogs'
import { pt, fr } from 'nexus-dialogs/locales' // portugués (Brasil) y francés, listos

registerLanguage('pt', pt)
configure({ lang: 'pt' }) // o configure({ lang: pageLanguage() }) para seguir a <html lang>

#Qué se promete

use, unuse, plugins, la forma de Plugin (name, install, beforeOpen, afterOpen, afterClose), registerField, CustomControl, registerLanguage y labelsFor son API pública: cambiarlos cuenta como cambio que rompe y npm run api:check lo vigila (Versionado y migraciones).