Manifest

Create a JSON manifest to import your react component to Uncodie IDE

Get Started

Uncodie Plugin allows you to import any 3rd party react component or library, you can add individual components or select a component from a library, in v1 you can only select 1 component from a library at a time.

JSON Example

{
    "version" : "1.0",
    "description": "Little description of my script or plugin",
    "content":"()=>{}" 
    "parameters": [
        {
            "alias" : "parameterOne",
            "type" : "dynamic",
            "dataType" : "string"
        },
        {
            "alias" : "parameterTwo",
            "type" : "scalar",
            "dataType" : "string"
        }
    ],
    "returnData" : "void",
    "dependencies": [
        {
            "alias" : "axios",
            "exportMode" : "default",
            "version" : "^0.27.2",
            "path": "axios",
            "packageName" : "axios"
        }
    ]
}

Properties

Name	Type	Required	Description
version	number		A version of your plugin or script.
description	string		Brief description of your plugin or script.
content	string		Script content.
parameters	parameter		List of objects to declare the parameters required for your plugin or script. Using the parameter Object Structure.
return_data	string		The type of value that will handle the value that the plugin returns or script.
dependencies	dependency		List as an array of objects with the external dependencies or libraries that the plugin or script need to handle.

Parameter Object

List of objects to declare the parameters required for your plugin or script.

Name	Type	Required	Description
alias	string		Name of your parameter
type	string		Constant from Type Enumeration
description	string		Brief explanation of the usage

Dependency Object

Name	Type	Required	Description
alias	string		Alias to be used for the dependency
exportMode	string		How to export the dependency
version	string		Version of the dependency to be used
path	string		File path for the import
packageName	string		Name for the package.json file

Type Enumeration

Possible Values:

Name	Type	Description
Scalar	string	Select this option to access a static value in the Plugin
Dynamic	string	Select this option to access a data source in the Plugin

Export Mode 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