Modules

Common files that each module should have:

  • module.json (where you give the module a name)
  • install.js
  • uninstall.js

As soon as you have these files, the rest is up to you depending on what you would like to customize in the module.

Take a look at some sample modules in the Gitana SDK

Custom Modules

One of the features that make CloudCMS super configurable is the ability to implement custom modules.

Within a custom module, you can define new UI elements that your editorial team can use in their day-to-day activities. These may include:

  • New form controls and field types
  • New layouts, templates and wizards for editorial forms
  • New modal popups and dialog actions
  • New pages that put desired editorial tools all in one place
  • New menus and navigation items

You can also use the module to customize the rules engine which the Cloud CMS UI runs on every render. This rules engine takes into account who the current user is, what they're looking, the capabilities and roles of the current user and much more.

Using the rules engine you can:

  • Hide or show menu items based on what roles the current has in the project
  • Hide or show buttons and actions based on permissions and attributes of the user or the content being viewed
  • Give your editorial users the precise experience they desire (depending on who they are)

Developing Modules

If you're interested in developing modules, we recommend that you check out some of the modules that are already available in our SDK:

Registering Modules

Public Modules

We will soon have a registry of public modules available. These will consist of freely available add-on modules that offer our customers a way to quickly extend the UI with a few easy clicks.