@echopf/web-sdk NPM

ECHOPF-Web-SDK

Directory

/src/data/

data formatters are contained in this directory. A data formatter for each data types is in /src/data/types/.

/src/form/

form elements are contained in this directory. A form element for each data types is in /src/form/types/.

/src/languages/

The dictionary file for each language is in this directory. They are loaded at /src/provider/EPFProvider via /src/utils/usei18n.

The dictionary file must follow the below rule. If you'd like to add new rule, please consult with the code owner.

Error/{ModuleName}/{ErrorCode} : Define message per module per error code.
UI/{UIName}/{LabelName} : Define label for each UI module.
Model/{ModelName}/{FieldId} : Define label for each model field.
Format/{FormatType} : Define formats.
Common/{LabelName} : Define common labels.

/src/layout/

abbrev.

/src/plugin/

The plugin directory must follow the below directory sturucture.

/plugin/{PluginName}/data/ : Store data formatter related only to the plugin.
/plugin/{PluginName}/form/ : Store form elements related only to the plugin.
/plugin/{PluginName}/languages/ : Store dictionary file for each language related only to the plugin.
/plugin/{PluginName}/view/: Store view components. The view component is used by the user of this framework (used at DynamicLayoutBuilder, /example/ or imported project).
/plugin/{PluginName}/widget/ : Store widget components.

/src/provider/

Store global variables.

AppProvider : Combines other providers. The user of this framework calls this provider initially.
EPFProvider : Store config file related to this framework.
InstancesProvider : Store schema of all EPJ instances used in this framework.
UserProvider : Store & manage user's credentials.

/src/ui/

The UI elements are in this directory. An UI element is used in the other UI elements or View components or Widget components or Form elements. The JSX must be defined in /theme/ui/.

/utils/

abbrev.

/theme/

The JSX or stylesheet files must be defined in this directory in order to separate between logic and visual.

/example/

The example directory is for debugging this framework.