import * as tailwindcss_types_config from 'tailwindcss/types/config';
declare const collectionNames: readonly ["material-symbols", "material-symbols-light", "ic", "mdi", "mdi-light", "line-md", "solar", "tabler", "mingcute", "ri", "mynaui", "iconamoon", "iconoir", "lucide", "lucide-lab", "uil", "tdesign", "si", "bx", "bxs", "majesticons", "gg", "flowbite", "basil", "pixelarticons", "pixel", "akar-icons", "ci", "proicons", "typcn", "meteor-icons", "prime", "circum", "fe", "eos-icons", "bitcoin-icons", "humbleicons", "uim", "uit", "uis", "gridicons", "mi", "cuida", "weui", "duo-icons", "svg-spinners", "hugeicons", "lets-icons", "streamline-ultimate", "streamline-plump", "streamline-sharp", "mage", "stash", "lineicons", "wordpress", "icon-park-outline", "icon-park-solid", "icon-park-twotone", "jam", "streamline-cyber", "guidance", "carbon", "ion", "famicons", "ant-design", "lsicon", "gravity-ui", "cil", "roentgen", "ep", "charm", "quill", "bytesize", "bi", "streamline-pixel", "streamline-block", "rivet-icons", "nimbus", "formkit", "fluent", "ph", "teenyicons", "clarity", "streamline-freehand", "ix", "octicon", "memory", "system-uicons", "radix-icons", "zondicons", "uiw", "codex", "ei", "heroicons", "sidekickicons", "pepicons-pop", "pepicons-print", "pepicons-pencil", "f7", "pajamas", "garden", "streamline", "streamline-flex", "fa7-solid", "fa7-regular", "picon", "ooui", "maki", "temaki", "oui", "nrk", "dinkie-icons", "qlementine-icons", "streamline-ultimate-color", "streamline-plump-color", "streamline-freehand-color", "streamline-kameleon-color", "streamline-stickies-color", "fluent-color", "streamline-color", "streamline-flex-color", "streamline-sharp-color", "streamline-cyber-color", "icon-park", "marketeq", "vscode-icons", "codicon", "material-icon-theme", "file-icons", "devicon", "devicon-plain", "catppuccin", "skill-icons", "unjs", "simple-icons", "logos", "streamline-logos", "cib", "fa7-brands", "bxl", "nonicons", "arcticons", "cbi", "brandico", "entypo-social", "token", "token-branded", "cryptocurrency", "cryptocurrency-color", "openmoji", "twemoji", "noto", "fluent-emoji-flat", "fluent-emoji-high-contrast", "noto-v1", "emojione", "emojione-monotone", "emojione-v1", "fxemoji", "streamline-emojis", "circle-flags", "flag", "flagpack", "cif", "gis", "map", "geo", "game-icons", "fad", "academicons", "wi", "meteocons", "healthicons", "medical-icon", "covid", "la", "eva", "dashicons", "flat-color-icons", "entypo", "foundation", "raphael", "icons8", "iwwa", "gala", "heroicons-outline", "heroicons-solid", "fa6-solid", "fa6-regular", "fa6-brands", "fa-solid", "fa-regular", "fa-brands", "fa", "fluent-mdl2", "fontisto", "icomoon-free", "subway", "oi", "wpf", "simple-line-icons", "et", "el", "vaadin", "grommet-icons", "whh", "si-glyph", "zmdi", "ls", "bpmn", "flat-ui", "vs", "topcoat", "il", "websymbol", "fontelico", "ps", "feather", "mono-icons", "pepicons", "fluent-emoji"];
/** All the available icon collections when you have `@iconify/json` installed */
type CollectionNames = typeof collectionNames[number];
/**
* Icon dimensions.
*
* Used in:
* icon (as is)
* alias (overwrite icon's properties)
* root of JSON file (default values)
*/
interface IconifyDimenisons {
// Left position of viewBox.
// Defaults to 0.
left?: number;
// Top position of viewBox.
// Defaults to 0.
top?: number;
// Width of viewBox.
// Defaults to 16.
width?: number;
// Height of viewBox.
// Defaults to 16.
height?: number;
}
/**
* Icon transformations.
*
* Used in:
* icon (as is)
* alias (merged with icon's properties)
*/
interface IconifyTransformations {
// Number of 90 degrees rotations.
// 0 = 0, 1 = 90deg and so on.
// Defaults to 0.
// When merged (such as alias + icon), result is icon.rotation + alias.rotation.
rotate?: number;
// Horizontal flip.
// Defaults to false.
// When merged, result is icon.hFlip !== alias.hFlip
hFlip?: boolean;
// Vertical flip. (see hFlip comments)
vFlip?: boolean;
}
/**
* Combination of dimensions and transformations.
*/
interface IconifyOptional
extends IconifyDimenisons,
IconifyTransformations {
//
}
/**
* Alias.
*/
interface IconifyAlias extends IconifyOptional {
// Parent icon index without prefix, required.
parent: string;
// IconifyOptional properties.
// Alias should have only properties that it overrides.
// Transformations are merged, not overridden. See IconifyTransformations comments.
}
/**
* Icon.
*/
interface IconifyIcon extends IconifyOptional {
// Icon body: , required.
body: string;
// IconifyOptional properties.
// If property is missing in JSON file, look in root object for default value.
}
/**
* Icon with optional parameters that are provided by API and affect only search
*/
interface APIIconAttributes {
// True if icon is hidden.
// Used in icon sets to keep icons that no longer exist, but should still be accessible
// from API, preventing websites from breaking when icon is removed by developer.
hidden?: boolean;
}
interface ExtendedIconifyIcon extends IconifyIcon, APIIconAttributes {}
interface ExtendedIconifyAlias extends IconifyAlias, APIIconAttributes {}
/**
* "icons" field of JSON file.
*/
interface IconifyIcons {
// Index is name of icon, without prefix. Value is ExtendedIconifyIcon object.
[index: string]: ExtendedIconifyIcon;
}
/**
* "aliases" field of JSON file.
*/
interface IconifyAliases {
// Index is name of icon, without prefix. Value is ExtendedIconifyAlias object.
[index: string]: ExtendedIconifyAlias;
}
/**
* Icon set information block.
*/
interface IconifyInfo {
// Icon set name.
name: string;
// Total number of icons.
total?: number;
// Version string.
version?: string;
// Author information.
author: {
// Author name.
name: string;
// Link to author's website or icon set website.
url?: string;
};
// License
license: {
// Human readable license.
title: string;
// SPDX license identifier.
spdx?: string;
// License URL.
url?: string;
};
// Array of icons that should be used for samples in icon sets list.
samples?: string[];
// Icon grid: number or array of numbers.
height?: number | number[];
// Display height for samples: 16 - 24
displayHeight?: number;
// Category on Iconify collections list.
category?: string;
// List of tags to group similar icon sets.
tags?: string[];
// Palette status. True if icons have predefined color scheme, false if icons use currentColor.
// Ideally, icon set should not mix icons with and without palette to simplify search.
palette?: boolean;
// If true, icon set should not appear in icon sets list.
hidden?: boolean;
}
/**
* Optional themes, old format.
*
* Deprecated because format is unnecessary complicated. Key is meaningless, suffixes and prefixes are mixed together.
*/
interface LegacyIconifyThemes {
// Key is unique string.
[index: string]: {
// Theme title.
title: string;
// Icon prefix or suffix, including dash. All icons that start with prefix and end with suffix belong to theme.
prefix?: string; // Example: 'baseline-'
suffix?: string; // Example: '-filled'
};
}
/**
* Characters used in font.
*/
interface IconifyChars {
// Index is character, such as "f000".
// Value is icon name.
[index: string]: string;
}
/**
* Icon categories
*/
interface IconifyCategories {
// Index is category title, such as "Weather".
// Value is array of icons that belong to that category.
// Each icon can belong to multiple categories or no categories.
[index: string]: string[];
}
/**
* Meta data stored in JSON file, used for browsing icon set.
*/
interface IconifyMetaData {
// Icon set information block. Used for public icon sets, can be skipped for private icon sets.
info?: IconifyInfo;
// Characters used in font. Used for searching by character for icon sets imported from font, exporting icon set to font.
chars?: IconifyChars;
// Categories. Used for filtering icons.
categories?: IconifyCategories;
// Optional themes (old format).
themes?: LegacyIconifyThemes;
// Optional themes (new format). Key is prefix or suffix, value is title.
prefixes?: Record;
suffixes?: Record;
}
/**
* JSON structure, contains only icon data
*/
interface IconifyJSONIconsData extends IconifyDimenisons {
// Prefix for icons in JSON file, required.
prefix: string;
// API provider, optional.
provider?: string;
// List of icons, required.
icons: IconifyIcons;
// Optional aliases.
aliases?: IconifyAliases;
// IconifyDimenisons properties that are used as default viewbox for icons when icon is missing value.
// If viewbox exists in both icon and root, use value from icon.
// This is used to reduce duplication.
}
/**
* JSON structure.
*
* All optional values can exist in root of JSON file, used as defaults.
*/
interface IconifyJSON extends IconifyJSONIconsData, IconifyMetaData {
// Last modification time of icons. Unix time stamp in seconds.
// Time is calculated only for icon data, ignoring metadata.
// Used to invalidate icons cache in components.
lastModified?: number;
// Optional list of missing icons. Returned by Iconify API when querying for icons that do not exist.
not_found?: string[];
}
type GenerateOptions = {
/**
* Scale relative to the current font size (1em).
*
* @default 1
*/
scale?: number;
/**
* Extra CSS properties applied to the generated CSS.
*
* @default `{}`
*/
extraProperties?: Record;
/**
* Stroke width applied to the generated CSS.
*
* @default `undefined`
*/
strokeWidth?: number;
};
declare function getIconCollections(include: T[] | "all"): Record | Record;
type Optional = Pick, K> & Omit;
type CollectionNamesAlias = {
[key in CollectionNames]?: string;
};
type IconsPluginOptions = {
collections?: Record>;
/**
* alias to customize collection names
* @default {}
*/
collectionNamesAlias?: CollectionNamesAlias;
/**
* Class prefix for matching icon rules.
*
* @default `i`
*/
prefix?: string;
} & GenerateOptions;
declare const iconsPlugin: (iconsPluginOptions?: IconsPluginOptions) => {
handler: tailwindcss_types_config.PluginCreator;
config?: Partial;
};
declare const dynamicIconsPlugin: (iconsPluginOptions?: Omit) => {
handler: tailwindcss_types_config.PluginCreator;
config?: Partial;
};
declare const _default: {
(options: IconsPluginOptions): {
handler: tailwindcss_types_config.PluginCreator;
config?: Partial;
};
__isOptionsFunction: true;
};
export { type CollectionNames, type IconsPluginOptions, collectionNames, _default as default, dynamicIconsPlugin, getIconCollections, iconsPlugin };