Package org.polyfrost.oneconfig.api.config.v1.annotations

Annotation Interface TextList

@Retention(RUNTIME) @Target(FIELD) @Documented public @interface TextList
Renders a user-editable list of text inputs. The annotated field must be String[].

Unlike DraggableList, the entries are not a fixed set: the user types each value, and can add and remove rows. The property value is the list of entries in display order.

  • Element Details

    • title

      String title

    • titleTranslation

      @Deprecated boolean titleTranslation
      Deprecated.
      No longer needed. OneConfig now checks whether the given title is a translation key present in the active language, and translates it automatically when it is. Pass the translation key directly as the title and remove this flag.
      Default:
      false

    • description

      String description
      Default:
      ""

    • descriptionTranslation

      @Deprecated boolean descriptionTranslation
      Deprecated.
      No longer needed. OneConfig now checks whether the given description is a translation key present in the active language, and translates it automatically when it is. Pass the translation key directly as the description and remove this flag.
      Default:
      false

    • icon

      String icon
      Default:
      ""

    • category

      String category
      Default:
      "General"

    • categoryTranslation

      @Deprecated boolean categoryTranslation
      Deprecated.
      No longer needed. OneConfig now checks whether the given category is a translation key present in the active language, and translates it automatically when it is. Pass the translation key directly as the category and remove this flag.
      Default:
      false

    • subcategory

      String subcategory
      Default:
      "General"

    • subcategoryTranslation

      @Deprecated boolean subcategoryTranslation
      Deprecated.
      translation keys will be translated by default.
      Default:
      false

    • placeholder

      @TranslatedDefault("oneconfig.textinput.placeholder") String placeholder
      Default:
      "oneconfig.textinput.placeholder"

    • placeholderTranslation

      @Deprecated boolean placeholderTranslation
      Deprecated.
      No longer needed. OneConfig now checks whether the given placeholder is a translation key present in the active language, and translates it automatically when it is. Pass the translation key directly as the placeholder and remove this flag.
      Default:
      false

    • regex

      String regex
      Insert a regex expression which will be used to validate each entry. Entries that do not match are highlighted and are not written to the property.
      Default:
      ""

    • maxEntries

      int maxEntries
      Maximum number of entries the user may add. 0 means unlimited.
      Default:
      0

    • reorderable

      boolean reorderable
      Allow the user to drag entries to reorder them.
      Default:
      true

    • addText

      String addText
      Label of the button that appends a new entry.
      Default:
      "Add"

    • addTextTranslation

      @Deprecated boolean addTextTranslation
      Deprecated.
      No longer needed. OneConfig now checks whether the given addText is a translation key present in the active language, and translates it automatically when it is. Pass the translation key directly as the addText and remove this flag.
      Default:
      false