Create a new SXA module

An SXA module consists of templates, branches, settings (to store scaffolding items), media library items, renderings, layouts, and so on. Default SXA modules include the rendering sections and grid systems. SXA modules are stored in the Feature , Foundation, or Project folder:

  • /sitecore/System/Settings/Foundation/Headless Experience Accelerator/.

  • /sitecore/System/Settings/Feature/Headless Experience Accelerator/.

  • /sitecore/System/Settings/Project/.

You might want to create a new module, for example, to add a new section in the Experience Editor Toolbox for custom renderings, to add a base template to extend one of the site items and use custom fields, or to invoke a script during site creation.

To add a new module:

  1. Navigate to sitecore/System/Settings, right-click Features, Foundation, or Project, and then click Insert > Headless Module.


    Do not place your custom modules in the Headless Experience Accelerator folder. This folder is overwritten during updates.

  2. In the Create new module dialog box, fill in the following fields:



    Module name

    Enter a name for the new module. This name is used as the folder name for the system areas selected.

    Add to module group

    Select the module folder this module belongs to.

    System areas

    Select the system areas for which container folders should be created.

    Module scaffolding actions

    To install the new module with SXA scaffolding, select Site Collection Setup and/or Site Setup.

  3. Click Proceed.

    Your module is now added and ready for you to customize by adding templates, branches, settings (scaffolding configurations) media library items, renderings, layouts, and so on.

    Depending on which system areas you selected, there are folders in the Media Library, Templates, Branches, Renderings, Layout, or Layouts sections.

    New module folder available in different folders.

Do you have some feedback for us?

If you have suggestions for improving this article,