Objects type for theme setting

Documentation Developer Guides
,
37

Yes, I am referring to limiting the maximum number of items in the objects array.

Currently, this is not supported out of the box, so I extended the functionality in a custom private theme component. Here is the configuration (for reference only):

Configuration for maximum array count limit:

themes/quectel-custom-homepage/settings.yml

banner_images:
  type: objects
  default: []
  schema:
    name: "Carousel"
    max: 9 // New extended configuration to limit the maximum number of items in the array
    identifier: image_url
    properties:
      image_url:
        type: upload
        required: true
      link_url:
        type: string
        min: 0
        max: 1023

Extended code:

themes/quectel-custom-homepage/javascripts/discourse/api-initializers/quectel-custom-homepage.gjs

import { action } from "@ember/object";
import { apiInitializer } from "discourse/lib/api";
import classPrepend from "discourse/lib/class-prepend";
import { i18n } from "discourse-i18n";

export default apiInitializer(() => {
  // Use classPrepend to extend the SchemaSettingNewEditor component to support the max limit for objects type
  // Load this component only in the admin context
  let SchemaSettingNewEditor;
  try {
    SchemaSettingNewEditor =
      require("discourse/admin/components/schema-setting/editor").default;
  } catch {
    // Non-admin users cannot load this component, skip extension
    return;
  }

  classPrepend(SchemaSettingNewEditor, (Superclass) => {
    return class extends Superclass {
      @action
      addItem() {
        // Check if the max limit is reached
        const maxLimit = this.args.setting.max || this.activeSchema?.max;

        if (maxLimit && this.activeData.length >= maxLimit) {
          this.validationErrorMessage = i18n(
            themePrefix("theme_settings.errors.objects_value_not_valid_max"),
            {
              count: maxLimit,
            }
          );
          return;
        }

        return super.addItem(...arguments);
      }

      @action
      addChildItem(propertyName, parentNodeIndex) {
        const propertySchema = this.activeSchema.properties[propertyName];

        // Check if the max limit is reached
        if (
          propertySchema?.max &&
          this.activeData[parentNodeIndex][propertyName].length >=
            propertySchema.max
        ) {
          this.validationErrorMessage = i18n(
            themePrefix("theme_settings.errors.objects_value_not_valid_max"),
            {
              count: propertySchema.max,
            }
          );
          return;
        }

        return super.addChildItem(...arguments);
      }
    };
  });
});

Theme translation configuration:

themes/quectel-custom-homepage/locales/en.yml

en:
  theme_settings:
    errors:
      objects_value_not_valid_max: "The number cannot exceed %{count}"

Actual effect:

image
image1230×753 38.7 KB

  1. Error message
  2. Unable to add more items
1 Like