woltlab-compiler/lib/System/Customization/Presentation/Themes/IThemeOptions.d.ts

A compiler for WoltLab-Package Archives and WoltLab-Package Components

import { ILocalization } from "../../../Globalization/ILocalization";
import { IComponentOptions } from "../../../PackageSystem/IComponentOptions";
import { IFileDescriptorOptions } from "../../../PackageSystem/IFileDescriptorOptions";
import { IImageDirectoryDescriptorOptions } from "./IImageDirectoryDescriptorOptions";
/**
 * Provides options for the `Theme` class.
 */
export interface IThemeOptions extends Partial<IComponentOptions> {
    /**
     * @inheritdoc
     */
    Name: string;
    /**
     * @inheritdoc
     */
    DisplayName: ILocalization;
    /**
     * The thumbnail of the theme.
     */
    Thumbnail?: IFileDescriptorOptions | string;
    /**
     * The high resolution version of the thumbnail.
     */
    HighResThumbnail?: IFileDescriptorOptions | string;
    /**
     * The path to the default cover-photo for user-profiles.
     */
    CoverPhoto?: IFileDescriptorOptions | string;
    /**
     * The name of the file which contains the `scss`-code of the theme.
     */
    CustomScssFileName?: string;
    /**
     * The name of the file which contains `scss`-Variable overrides.
     */
    ScssOverrideFileName?: string;
    /**
     * The name of the file which contains variables of the theme.
     */
    VariableFileName?: string;
    /**
     * The image-directory provided by the theme.
     */
    Images?: IImageDirectoryDescriptorOptions;
}