Configuración general de módulos de extensión en el archivo manifest

Los módulos de extensión de FormIt están formados por un componente central clave que recibe el nombre de archivo manifest.json.

El archivo manifest es un objeto JSON que indica a la infraestructura de FormIt los archivos que se deben recuperar y el tipo de módulo de extensión que se debe crear.

Propiedades y estructura del archivo manifest.json

Un archivo manifest.json presenta la siguiente estructura. Tiene propiedades adicionales en función de si se trata de un módulo de extensión basado en barra de herramientas o un módulo de extensión basado en panel HTML.

{
    "PluginName": "[PluginName]",
    "PluginType": "[PluginType]"
    "PluginDescription": "[PluginDescription]",
    "Scripts": [
        "PLUGINLOCATION/[script1].js",
        "PLUGINLOCATION/[script2].js",
        ...
        "PLUGINLOCATION/[scriptn].js"
    ]
}               

Un módulo de extensión típico incluye estas propiedades JSON:

  • "PluginName" representa el nombre del módulo de extensión para fines internos y de visualización, incluido para Plugin Manager.

  • "PluginType" representa el tipo de módulo de extensión, lo que permite a los usuarios saber en la descripción de Plugin Manager lo que deben buscar al instalar el módulo de extensión.

  • "PluginDescription" se muestra en Plugin Manager para indicar las funciones del módulo de extensión.

  • "Scripts" muestra las secuencias de comandos externas necesarias asociadas con el módulo de extensión que se cargará en la aplicación FormIt y que pueden ejecutarse cuando se llame a las funciones del módulo de extensión.

Para empezar a desarrollar el módulo de extensión, cree un archivo manifest.json en la carpeta del módulo de extensión. A continuación, deberá decidir si va a crear un módulo de extensión basado en barra de herramientas o panel.

Nota: El uso de PLUGINLOCATION en todo el archivo manifest.json anterior es esencial y distingue entre mayúsculas y minúsculas. FormIt reemplazará PLUGINLOCATION por la ubicación del servidor para el módulo de extensión.

Last updated