2
0
mirror of https://github.com/iconify/iconify.git synced 2024-11-09 23:00:56 +00:00
iconify/packages/types/types.d.ts

273 lines
6.5 KiB
TypeScript
Raw Normal View History

2020-04-28 10:16:14 +00:00
/**
* Icon dimensions.
*
* Used in:
* icon (as is)
* alias (overwrite icon's properties)
* root of JSON file (default values)
*/
export 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)
*/
export 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.
*/
export interface IconifyOptional
extends IconifyDimenisons,
IconifyTransformations {
//
}
2020-04-28 10:16:14 +00:00
/**
* Alias.
*/
export 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.
*/
export interface IconifyIcon extends IconifyOptional {
// Icon body: <path d="..." />, 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;
}
export interface ExtendedIconifyIcon extends IconifyIcon, APIIconAttributes {}
export interface ExtendedIconifyAlias extends IconifyAlias, APIIconAttributes {}
2020-04-28 10:16:14 +00:00
/**
* "icons" field of JSON file.
*/
export interface IconifyIcons {
// Index is name of icon, without prefix. Value is ExtendedIconifyIcon object.
[index: string]: ExtendedIconifyIcon;
2020-04-28 10:16:14 +00:00
}
/**
* "aliases" field of JSON file.
*/
export interface IconifyAliases {
// Index is name of icon, without prefix. Value is ExtendedIconifyAlias object.
[index: string]: ExtendedIconifyAlias;
2020-04-28 10:16:14 +00:00
}
/**
* Icon set information block.
*/
export 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[];
2020-04-28 10:16:14 +00:00
// 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;
2022-08-21 11:35:59 +00:00
// List of tags to group similar icon sets.
tags?: string[];
2020-04-28 10:16:14 +00:00
// 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;
2021-11-17 16:24:36 +00:00
// If true, icon set should not appear in icon sets list.
hidden?: boolean;
2020-04-28 10:16:14 +00:00
}
/**
* Optional themes, old format.
*
* Deprecated because format is unnecessary complicated. Key is meaningless, suffixes and prefixes are mixed together.
2020-04-28 10:16:14 +00:00
*/
export interface LegacyIconifyThemes {
2020-04-28 10:16:14 +00:00
// 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.
*/
export interface IconifyChars {
// Index is character, such as "f000".
// Value is icon name.
[index: string]: string;
}
/**
* Icon categories
*/
export 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.
*/
export 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<string, string>;
suffixes?: Record<string, string>;
2020-04-28 10:16:14 +00:00
}
/**
* JSON structure, contains only icon data
2020-04-28 10:16:14 +00:00
*/
export interface IconifyJSONIconsData extends IconifyDimenisons {
2020-04-28 10:16:14 +00:00
// Prefix for icons in JSON file, required.
prefix: string;
2020-06-01 21:54:37 +00:00
// API provider, optional.
provider?: string;
2020-04-28 10:16:14 +00:00
// 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.
}
2020-04-28 10:16:14 +00:00
/**
* JSON structure.
*
* All optional values can exist in root of JSON file, used as defaults.
*/
export 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;
2020-04-28 10:16:14 +00:00
// Optional list of missing icons. Returned by Iconify API when querying for icons that do not exist.
not_found?: string[];
}
/**
* Structure of exports '@iconify-json/*' packages.
*
* These are small packages, one per icon set, that split JSON structure into multiple files to reduce
* amount of data imported from package.
*/
export interface IconifyJSONPackageExports {
info: IconifyInfo;
icons: IconifyJSON;
metadata: IconifyMetaData;
chars: IconifyChars;
}