@manuth/woltlab-compiler/lib/Customization/BBCodes/IBBCodeOptions.d.ts

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

import { ILocalization } from "../../Globalization/ILocalization.js";
import { IBBCodeAttributeOptions } from "./IBBCodeAttributeOptions.js";
/**
 * Provides options for the {@link BBCode `BBCode`} class.
 */
export interface IBBCodeOptions {
    /**
     * The name of the bb-code.
     */
    Name: string;
    /**
     * The human-readable name of the bb-code.
     */
    DisplayName?: ILocalization;
    /**
     * The name of a font-awesome icon for the bb-code-button.
     */
    Icon?: string;
    /**
     * The class-name of the bb-code.
     */
    ClassName?: string;
    /**
     * The name of the HTML-tag.
     */
    TagName?: string;
    /**
     * A value indicating whether the HTML-tag is self-closing.
     */
    IsSelfClosing?: boolean;
    /**
     * A value indicating whether the bb-code is a block-element.
     */
    IsBlockElement?: boolean;
    /**
     * A value indicating whether the content of the bb-code should be parsed.
     */
    ParseContent?: boolean;
    /**
     * The attributes of the bb-code.
     */
    Attributes?: IBBCodeAttributeOptions[];
}