Crear una plantilla
Una plantilla es propietaria de una definición de salida: dimensiones, campos editables, contenido, variantes, recursos y función de renderizado. Mantén la primera implementación en un solo template.tsx; divídela únicamente cuando el archivo resulte difícil de mantener.
-
Crea el archivo de la plantilla.
Añade un directorio en minúsculas y kebab-case bajo
src/templates/y exporta por defecto el resultado dedefineTemplate().src/templates/social-card/template.tsx import { defineTemplate, field } from '@mauriciodmo/framekit'export default defineTemplate({meta: {title: 'Social card',description: 'A square card for social posts',marketingDescription: 'Present the message and motivate an action',tags: ['social', 'promotion']},width: 1080,height: 1080,fields: {title: field.text({label: 'Title',required: true,minLength: 1,maxLength: 80}),accentColor: field.color({label: 'Accent color',defaultValue: '#173d31'})},content: {default: {title: 'Your next story starts here'}},variants: {default: 'default',labels: {default: 'Default'}},render ({ data, width, height }) {return (<articlestyle={{width,height,display: 'flex',alignItems: 'center',justifyContent: 'center',padding: 72,background: '#10271f',color: data.accentColor,fontSize: 72}}>{data.title}</article>)}}) -
Valida la definición.
Ventana de terminal pnpm framekit checkLa comprobación regenera el registro, valida la definición, resuelve cada variante de contenido sin modificaciones y valida los datos resultantes. Detecta metadatos, dimensiones, opciones de campos, valores de contenido y restricciones numéricas no válidos antes de usar la plantilla.
-
Regenera mientras desarrollas.
Ventana de terminal pnpm framekit generatepnpm framekit devgenera antes de iniciar y observa los cambios bajosrc/.pnpm framekit buildtambién genera mediante su paso de comprobación.pnpm framekit startes de solo lectura con respecto a la generación y espera una compilación de producción existente.
La definición de plantilla, los campos y la referencia de plantillas documentan los contratos completos. Cuando una definición crezca, consulta Dividir una definición de plantilla.