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

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

import { Localization } from "../../Globalization/Localization.js";
import { BBCodeAttribute } from "./BBCodeAttribute.js";
import { IBBCodeOptions } from "./IBBCodeOptions.js";
/**
 * Represents a bb-code.
 */
export declare class BBCode {
    /**
     * The name of the bb-code.
     */
    private name;
    /**
     * The human-readable name of the bb-code.
     */
    private displayName;
    /**
     * The name of a font-awesome icon for the bb-code-button.
     */
    private icon;
    /**
     * The class-name of the bb-code.
     */
    private className;
    /**
     * The name of the HTML-tag.
     */
    private tagName;
    /**
     * A value indicating whether the HTML-tag is self-closing.
     */
    private isSelfClosing;
    /**
     * A value indicating whether the bb-code is a block-element.
     */
    private isBlockElement;
    /**
     * A value indicating whether the content of the bb-code should be parsed.
     */
    private parseContent;
    /**
     * The attributes of the bb-code.
     */
    private attributes;
    /**
     * Initializes a new instance of the {@link BBCode `BBCode`} class.
     *
     * @param options
     * The options of the bbcode.
     */
    constructor(options: IBBCodeOptions);
    /**
     * Gets or sets the name of the bb-code.
     */
    get Name(): string;
    /**
     * @inheritdoc
     */
    set Name(value: string);
    /**
     * Gets the human-readable name of the bb-code.
     */
    get DisplayName(): Localization;
    /**
     * Gets or sets the name of a font-awesome icon for the bb-code-button.
     */
    get Icon(): string;
    /**
     * @inheritdoc
     */
    set Icon(value: string);
    /**
     * Gets or sets the class-name of the bb-code.
     */
    get ClassName(): string;
    /**
     * @inheritdoc
     */
    set ClassName(value: string);
    /**
     * Gets or sets the name of the HTML-tag.
     */
    get TagName(): string;
    /**
     * @inheritdoc
     */
    set TagName(value: string);
    /**
     * Gets or sets a value indicating whether the HTML-tag is self-closing.
     */
    get IsSelfClosing(): boolean;
    /**
     * @inheritdoc
     */
    set IsSelfClosing(value: boolean);
    /**
     * Gets or sets a value indicating whether the bb-code is a block-element.
     */
    get IsBlockElement(): boolean;
    /**
     * @inheritdoc
     */
    set IsBlockElement(value: boolean);
    /**
     * Gets or sets a value indicating whether the content of the bb-code should be parsed.
     */
    get ParseContent(): boolean;
    /**
     * @inheritdoc
     */
    set ParseContent(value: boolean);
    /**
     * Gets the attributes of the bb-code.
     */
    get Attributes(): BBCodeAttribute[];
}