Use model builders

Canvas Sitecore integration allows to define a model builder for component. It can be helpful when item fields isn't enough and you need to prepare data from back-end side.

Model builders#

Implement Uniform.ModelBuilders.IModelBuilder, Uniform.ComponentModel interface

datasourceItem - current datasource item (can be the same as a page item)
<result> - json-serializable object

Register model builder via Sitecore config

@uniformdev/canvas-sitecore package contains a few helpers to work with model builders.

• getModelOrItem function

  CopyCopied!Wrap

• getPageItemId function

  CopyCopied!Wrap

• create an enhancer from createItemEnhancer function

  CopyCopied!Wrap

Implement model builder#

1. In Visual Studio, create a new project

   • Project template: Class Library (.NET Framework)
   • Framework: 4.6.2+

2. Add the Sitecore NuGet repository as a package source in your solution.

3. Add the Uniform NuGet repository as a package source in your solution.

   info

   Contact our support team for a link to this repository.

4. Add a reference to the following packages:

   • Sitecore.Kernel
   • Uniform.ComponentModel

Implement Sample Rendering model and model builder

Register Sample Rendering model builder

Create App_Config\Include\zzz_MySite\MySite.Uniform.Canvas.config config with the following content

Update enhanceComposition function

Item model builder#

Uniform.ModelBuilders.ItemFieldsModelBuilder, Uniform.ComponentModel allows to build simple models without custom code.

Define model dependencies#

Model builders may have implicit Sitecore item dependencies. In order to support incremental cache purge for Data Types, we need to define such kind of dependencies explicitly.

Use Uniform.Models.ModelBuilderResult, Uniform.ComponentModel as model builder result