El Block Kit de EmDash permite a los plugins en sandbox describir su IU de administración como JSON. El host renderiza los bloques — nunca se ejecuta JavaScript proporcionado por el plugin en el navegador.
Cómo funciona
- El usuario navega a una página de administración del plugin
- El admin envía una interacción
page_loada la ruta admin del plugin - El plugin devuelve una
BlockResponseque contiene un array de bloques - El admin renderiza los bloques usando el componente
BlockRenderer - Cuando el usuario interactúa (hace clic en un botón, envía un formulario), el admin envía la interacción de vuelta al plugin
- El plugin devuelve nuevos bloques y el ciclo se repite
// Manejador de ruta admin del plugin
routes: {
admin: {
handler: async (ctx, { request }) => {
const interaction = await request.json();
if (interaction.type === "page_load") {
return {
blocks: [
{ type: "header", text: "My Plugin Settings" },
{
type: "form",
block_id: "settings",
fields: [
{ type: "text_input", action_id: "api_url", label: "API URL" },
{ type: "toggle", action_id: "enabled", label: "Enabled", initial_value: true },
],
submit: { label: "Save", action_id: "save" },
},
],
};
}
if (interaction.type === "form_submit" && interaction.action_id === "save") {
await ctx.kv.set("settings", interaction.values);
return {
blocks: [/* ... bloques actualizados ... */],
toast: { message: "Settings saved", type: "success" },
};
}
},
},
}
Tipos de bloques
| Tipo | Descripción |
|---|---|
header | Encabezado grande en negrita |
section | Texto con elemento accesorio opcional |
divider | Línea horizontal |
fields | Cuadrícula de dos columnas etiqueta/valor |
table | Tabla de datos con formato, ordenamiento, paginación |
actions | Fila horizontal de botones y controles |
stats | Tarjetas de métricas de panel con indicadores de tendencia |
form | Campos de entrada con visibilidad condicional y envío |
image | Imagen a nivel de bloque con leyenda |
context | Pequeño texto de ayuda atenuado |
columns | Diseño de 2-3 columnas con bloques anidados |
Tipos de elementos
| Tipo | Descripción |
|---|---|
button | Botón de acción con diálogo de confirmación opcional |
text_input | Entrada de texto de una o varias líneas |
number_input | Entrada numérica con mín/máx |
select | Selección desplegable |
toggle | Interruptor on/off |
secret_input | Entrada enmascarada para claves API y tokens |
Helpers de construcción
El paquete @emdash-cms/blocks exporta helpers de construcción para código más limpio:
import { blocks, elements } from "@emdash-cms/blocks";
const { header, form, section, stats } = blocks;
const { textInput, toggle, select, button } = elements;
return {
blocks: [
header("SEO Settings"),
form({
blockId: "settings",
fields: [
textInput("site_title", "Site Title", { initialValue: "My Site" }),
toggle("generate_sitemap", "Generate Sitemap", { initialValue: true }),
select("robots", "Default Robots", [
{ label: "Index, Follow", value: "index,follow" },
{ label: "No Index", value: "noindex,follow" },
]),
],
submit: { label: "Save", actionId: "save" },
}),
],
};
Campos condicionales
Los campos del formulario pueden mostrarse condicionalmente según los valores de otros campos:
{
"type": "toggle",
"action_id": "auth_enabled",
"label": "Enable Authentication"
}
{
"type": "secret_input",
"action_id": "api_key",
"label": "API Key",
"condition": { "field": "auth_enabled", "eq": true }
}
El campo api_key solo aparece cuando auth_enabled está activado. Las condiciones se evalúan del lado del cliente sin ida y vuelta.
Pruébalo
Usa el Block Playground para construir y probar interactivamente diseños de bloques.