Kentico.Xperience.ComponentIcons 1.0.0

Xperience by Kentico Componennt Icons

Description

A pre-packaged, annotated list of all icons used in Xperience by Kentico Page, Email, and Form Builder components. Great for AI agents building Xperience components!

The icon list is a C# class with doc comments on every icon that clearly describe what the icon looks like. This helps AI agents (and human developers) understand what the icon "looks like".

public static class KenticoIcons
{
    /// <summary>
    /// Lowercase letter "a" in a simple font.
    /// </summary>
    public const string A_LOWERCASE = "icon-a-lowercase";
    /// <summary>
    /// Three horizontal lines with a bordered rectangle above.
    /// </summary>
    public const string ACCORDION = "icon-accordion";
    /// <summary>
    /// Puzzle piece with a plus sign circle badge.
    /// </summary>
    public const string ADD_MODULE = "icon-add-module";
    /// <summary>
    /// Simplified robot figure with antennae and rounded limbs.
    /// </summary>
    public const string ANDROID = "icon-android";
    /// <summary>
    /// Stylized apple with a leaf and a bite taken out
    /// </summary>
    public const string APPLE = "icon-apple";
    // ...
}

You can read about the inspiration for this library in the article Smarter Components: Using Icon Metadata to Guide AI in Kentico Projects.

Requirements

Library Version Matrix

This project has no dependencies and will work with any version of Xperience by Kentico.

Dependencies

• ASP.NET Core 10.0
• Xperience by Kentico

Package Installation

Add the package to any project with component registration attributes, using the .NET CLI.

dotnet add package Kentico.Xperience.ComponentIcons

Quick Start

egister the library's services in your ASP.NET Core application:

// FAQWidget.cs

using Kentico.Content.Web.Mvc;
using Kentico.PageBuilder.Web.Mvc;
using Kentico.Xperience.Admin.Base.FormAnnotations;
using Kentico.Xperience.Admin.Base.Forms;
using Kentico.Xperience.ComponentIcons;

[assembly: RegisterWidget(
    identifier: FAQWidget.IDENTIFIER,
    viewComponentType: typeof(FAQWidget),
    name: FAQWidget.NAME,
    propertiesType: typeof(FAQWidgetProperties),
    Description = "Displays FAQ items in an expandable accordion format",
    IconClass = KenticoIcons.CHECKLIST,
    AllowCache = true)]

namespace App.Components.PageBuilder.Widgets.FAQ;

public class FAQWidget : ViewComponent
{
  // ...
}

Every icon field in KenticoIcons is annotated with a comment describing the visual appearance of the icon. This means you can use an AI agent to select icons for each Widget, Section, etc... in your project by having it analyze the KenticoIcons class.

Full Instructions

View the Usage Guide for more detailed instructions.

Contributing

To see the guidelines for Contributing to Kentico open source software, please see Kentico's CONTRIBUTING.md for more information and follow the Kentico's CODE_OF_CONDUCT.

Instructions and technical details for contributing to this project can be found in Contributing Setup.

License

Distributed under the MIT License. See LICENSE.md for more information.

Support

This project has Kentico Labs limited support.

See SUPPORT.md for more information.

For any security issues see SECURITY.md.