Modules

Modules are the functional units of a Kinvey Studio application and represent logical collections of views. Each application needs at least one module.

In web applications, modules appear as navigation groups by default. You can change their appearance on the Navigation tab.

System Module

With the creation of each application, Kinvey Studio provides the built-in System module which contains predefined, system views.

You cannot add views to the System module. Create one or more custom modules instead and put your views there.

The views offered by the System module include:

  • app-layout (web)—determines the layout of web pages.
  • home (mobile)—a home screen for the mobile app that initially contains information pertaining to Kinvey Studio. You will need to customize or remove it in your production apps.
  • home (web)—a landing page for the web app that initially contains information pertaining to Kinvey Studio. You will need to customize or remove it in your production apps.
  • login (web and mobile)—predefined sign-in page with web and mobile variations
  • register (mobile)—sign-up screen for the mobile app
  • register (web)—sign-up screen for the web app

Adding Modules

  1. On the dashboard, click the card of the application to open it.
  2. Click the plus sign in the upper-left corner.

    The Add Module dialog box appears.

  3. In the Add Module dialog box, enter module details and click Add Module.

    • In Name, provide the name of the module, for example, Main.
    • (Optional) Click the Icon/Color icon to add an icon to the module and to select a color for the icon and the background.
    • (Optional) In Display Name, define the name of the module as it will appear in the menu and on the landing page of the generated web application.
    • (Optional) In Description, provide a short description of the module as it will appear as a tooltip on the landing page of the generated application.

Editing Module Settings

  1. On the dashboard, click the card of the application to open it.
  2. Hover the card of the module whose properties you want to update and click the gear icon.
  3. Click the Settings menu item to open the Edit Module Settings window.
  4. Make your changes and click Save to apply them.

Deleting Modules

  1. On the dashboard, click the card of the application to open it.
  2. Hover the card of the module that you want to delete and click the gear icon.
  3. Click the Delete menu item and then conform the deletion.

Reordering Modules

The order of the modules on the app page corresponds to the order in which they will be rendered by the application at runtime. To reorder the modules, drag and drop them within the list.