unplugin-iconify/dist/types.d.cts

Unplugin for iconify.

import { IconCSSIconSetOptions } from '@iconify/utils/lib/css/types';
import { IconifyJSON } from '@iconify/types';

interface CSSGenerator extends Pick<IconCSSIconSetOptions, 'iconSelector'> {
    /** When you want to get runtime css hash, you must use `id` */
    id?: string;
    /** Add extra icon sets, non-official supported */
    iconSets?: Record<string, IconifyJSON>;
    /**
     * Specific iconify icons to export, including `iconSets` to export.
     *
     * For example:
     *
     * ```ts
     * ["bx", "bxs"]
     * ```
     *
     * or
     *
     * ```ts
     * {
     *   "bx": ["badge", "brightness"]
     *   "bxs": ["badge", "brightness"]
     *   "bxs": /./
     * }
     * ```
     *
     * or
     *
     * ```ts
     * {
     *   "bx": ["badge", "brightness"]
     *   "bxs": /./
     * }
     * ```
     */
    exportIcons?: string[] | Record<string, string[] | RegExp>;
    /**
     * Custom selector for export icons, defaults to ".icon--{prefix}--{name}". Variable "{prefix}" is replaced with icon set prefix, "{name}" with icon name.
     *
     * ref: https://iconify.design/docs/libraries/utils/get-icons-css.html#options
     */
    iconSelector?: string;
    /** icons CSS output path, under public directory in common. */
    outputPath: string | ((cssHash: string) => string);
}
interface Options {
    /**
     * Debug mode, default `false`
     */
    debug?: boolean;
    /**
     * Iconify icon sets CSS generator
     *
     * Generate corresponding CSS file for every config item.
     */
    cssGenerators?: CSSGenerator[];
}

export { CSSGenerator, Options };