Limit max number of composite components

Question

Is there a way to limit the max number of composite items in an SXA composite component like Carousel? For example the carousel has no more then 8 slides. It sounds like SXA does not have anything built in and I'd need to implement some sort of validation. If that is the case can anyone share an example of how to achieve that?

This is on SXA 10.2

Answer 1

You can do it by adding the validation through OnItemCreated event. Where you can specify your template name (for example Carousel) and if its child items exceed the limit then you can show the message and delete the item. The code will look like this.

public void OnItemCreated(object sender, EventArgs args)
{
    var createdArgs = Event.ExtractParameter(args, 0) as ItemCreatedEventArgs;

    if (createdArgs != null)
    {
        if (createdArgs.Item != null)
        {
            var item = createdArgs.Item;

            if (item.Parent != null && 
                item.Parent.TemplateName == "carousel" &&
                item.Parent.Children.Count() > 8)
            {
                SheerResponse.Alert(
                    String.Format("Sorry, you cannot add more than 8 slides to {0}.",
                                      item.Parent.Name), new string[0]);
               
               // write here your logic to delete the item. 
            }
        }
    }
}

This works when you create the item from the content editor and experience editor.

Once you are done with your method then register it using a patch config like this.

<event name="item:created">
    <handler type="MyProject.Sc.Extensions.Events.ItemCreatedEvent, MyProject.Sc.Extensions" method="OnItemCreated" />
</event>

It will look like this.

Hope this helps.