Prompt file imported from roeldeb/XperienceCommunity-ProjectSettings (.github/prompts/create-project-settings.prompt.md). Copyright stays with the author.

Create Project Settings

Generate strongly-typed project settings using the XperienceCommunity.ProjectSettings package.

Required Information

Before generating code, ensure you have the following information. If any is missing, ask the user:

1. Settings Name (e.g., "Seo", "Email", "Analytics")
2. Settings Properties - List of properties with:
   • Property name
   • Property type (string, bool, int, IEnumerable, etc.)
   • Form component (TextInput, TextArea, CheckBox, NumberInput, ContentItemSelector, etc.)
   • Label text
   • Default value
3. Target Scopes - Which admin pages to create:
   • Global Settings
   • Channel Settings
   • Both

Code Generation Instructions

1. Settings Class

Create in: {LogicProject}/Settings/{SettingsName}Settings.cs

using CMS.ContentEngine;
using Kentico.Xperience.Admin.Base.FormAnnotations;
using XperienceCommunity.ProjectSettings.Classes;

namespace {LogicProjectNamespace}.Settings;

public class {SettingsName}Settings : IProjectSettingsType
{
    public const string PAGE_SLUG = "{settings-slug}";

    public string SettingsSlug => PAGE_SLUG;
    public string SettingsName => "{SettingsName}.Settings";
    public string SettingsDisplayName => "{Settings Display Name}";
    public string SettingsExplanation => "{Description of these settings}";

    // Add properties here with appropriate form components:
    // [TextInputComponent(Label = "...", Order = 1)]
    // [TextAreaComponent(Label = "...", Order = 2)]
    // [CheckBoxComponent(Label = "...", Order = 3)]
    // [NumberInputComponent(Label = "...", Order = 4)]
    // [ContentItemSelectorComponent(ContentTypeName, Label = "...", MinimumItems = 0, MaximumItems = 1, Order = 5)]
    // [WebPageSelectorComponent(TreePath = "...", MaximumPages = 5, Label = "...", Order = 6)]
}

2. Global Settings Page (if needed)

Create in: {WebProject}/UISettings/{SettingsName}GlobalSettingsPage.cs

using Kentico.Xperience.Admin.Base;
using Kentico.Xperience.Admin.Base.Forms;
using Kentico.Xperience.Admin.Base.Forms.Internal;
using XperienceCommunity.ProjectSettings;
using XperienceCommunity.ProjectSettings.Pages;
using {LogicProjectNamespace}.Settings;
using {WebProjectNamespace}.UISettings;

[assembly: UIPage(
    parentType: typeof(ProjectSettingsApplication),
    slug: {SettingsName}Settings.PAGE_SLUG,
    uiPageType: typeof({SettingsName}GlobalSettingsPage),
    name: "{Settings Display Name}",
    templateName: TemplateNames.EDIT,
    order: {order})]

namespace {WebProjectNamespace}.UISettings;

public class {SettingsName}GlobalSettingsPage(
    IFormItemCollectionProvider formItemCollectionProvider,
    IFormDataBinder formDataBinder)
    : GlobalSettingsEditPage<{SettingsName}Settings>(formItemCollectionProvider, formDataBinder)
{
}

3. Channel Settings Page (if needed)

Create in: {WebProject}/UISettings/{SettingsName}ChannelSettingsPage.cs

using CMS.ContentEngine;
using CMS.DataEngine;
using Kentico.Xperience.Admin.Base;
using Kentico.Xperience.Admin.Base.Forms;
using Kentico.Xperience.Admin.Base.Forms.Internal;
using XperienceCommunity.ProjectSettings.Pages;
using {LogicProjectNamespace}.Settings;
using {WebProjectNamespace}.UISettings;

[assembly: UIPage(
    parentType: typeof(ProjectSettingsChannelEditSection),
    slug: {SettingsName}Settings.PAGE_SLUG,
    uiPageType: typeof({SettingsName}ChannelSettingsPage),
    name: "{Settings Display Name}",
    templateName: TemplateNames.EDIT,
    order: {order})]

namespace {WebProjectNamespace}.UISettings;

public class {SettingsName}ChannelSettingsPage(
    IFormItemCollectionProvider formItemCollectionProvider,
    IFormDataBinder formDataBinder,
    IInfoProvider<ChannelInfo> channelInfoProvider)
    : ChannelSettingsEditPage<{SettingsName}Settings>(formItemCollectionProvider, formDataBinder, channelInfoProvider)
{
}

4. Service Registration

Add to Program.cs:

builder.Services.AddProjectSettings<{SettingsName}Settings>();

Component Reference

Components

Selectors

Namespace notes:

• Most attributes: Kentico.Xperience.Admin.Base.FormAnnotations
• WebPageSelectorComponent: Kentico.Xperience.Admin.Websites.FormAnnotations (WebPageRelatedItem is in CMS.Websites)
• EmailSelectorComponent: Kentico.Xperience.Admin.DigitalMarketing.FormAnnotations
• TagSelectorComponent / ContentItemSelectorComponent: Kentico.Xperience.Admin.Base.FormAnnotations or Kentico.Xperience.Admin.Content.FormAnnotations

Example Request

Create settings for "Analytics" with:

• TrackingId (string, TextInput, default: "")
• EnableTracking (bool, CheckBox, default: false)
• ExcludedPaths (string, TextArea, default: "/admin\n/api")

Target: Both global and channel settings

Checklist

• Settings class created with IProjectSettingsType interface
• All properties marked as virtual
• All properties have default values
• PAGE_SLUG constant defined and used consistently
• Global settings page created (if requested)
• Channel settings page created (if requested)
• Both pages use the same slug (if both are created)
• AddProjectSettings<T>() added to Program.cs
• Order values set appropriately for admin navigation