@manuth/woltlab-compiler/lib/Options/ICategoryOptions.d.ts

A compiler for generating WoltLab-Package `.tar` Archives and other WoltLab-Package Components

import { ILocalization } from "../Globalization/ILocalization.js";
/**
 * Provides options for the {@link Category `Category<TOption, TOptionOptions>`} class.
 */
export interface ICategoryOptions<T> {
    /**
     * The human-readable name of the category.
     */
    DisplayName?: ILocalization;
    /**
     * The description of the category.
     */
    Description?: ILocalization;
    /**
     * A value for ordering the category.
     */
    ShowOrder?: number;
    /**
     * The options of the category.
     */
    Options?: T[];
    /**
     * The options of which at least one needs to be enabled for the category to be shown to the user.
     */
    EnableOptions?: string[];
}