Manifest

Create a json to import any react js component

Get Started

1. Download or clone the following repository that will serve as a template to create plugins for uncodie

2. Publish your project to a git repository that can be downloaded

3. Register the new plugin and correctly configure its manifest

4. Associate the plugin to the project you want to use it

JSON Structure Example

{
    "EnvVars": [],
    "name": "CodeEditor",
    "attrs": [
        { "name": "name", "type": "scalar", "req": true },
        { "name": "value", "type": "dynamic", "req": true }
    ],
    "events": ["getInformation"],
    "isWrapper": false,
    "PackageName": "creator-components",
    "version": "0.0.1",
    "exportType": "named",
    "description": "This is a component library for UnCodie",
    "origin": "https://oauth2:"accessTokenGitlab"@gitlab.com/group/projectName"
}

Properties

Name	Type	Required	Description
name	string		Component name
version	number		A version of your plugin or script.
description	string		Brief description of your plugin or script.
EnvVars	environment_variable		List of environment variables.
parameters	parameter		List of objects to declare the parameters required for your plugin or script. Using the parameter Object Structure.
attrs	attribute		List of parameters as an Array containing the information of the props that the compomnet should recive in the IDE
events	array		List of the events that the component API available for the rest of the app to execute custom logic
isWrapper	boolean		Indicates whether the component can be used as a wrapper to hold other components in the app Layout
packageName	string		Custom name for the package.json file in the importion process
origin	string		URL of the Plugin, if it is a public project it is not necessary to add the accesToken

Attribute Object

Name	Type	Required	Description
name	string		Parameter Name
type	string		Type to enter the value of your parameter, it can be "dynamic" to access the data source or "scalar" to manually enter the value through the Plugin
required	boolean		Whether or not the parameter is a required value to work

Environment Variable Object

Name	Type	Required	Description
key	string		Key name for your var
value	string		Var value

Export Type Enumeration

Possible Values:

Name	Type	Description
Default	string	Select this option when there is only 1 react component in your file
Named	string	Select this option to import the component with the same name value as the manifest "name" parameter from a library containing several react components