agerix/iconify
2
0
Fork 0
mirror of https://github.com/iconify/iconify.git synced 2024-12-12 13:47:49 +00:00
Code Issues Releases Activity
34702c534a
iconify/packages/types
History
Vjacheslav Trushkin 2fb77d5bf6 chore: update dependencies
2022-12-26 00:32:45 +02:00
..
.gitignore Add TypeScript as dev dependency to types, move hidden field from icon object, so it affects only JSON structure 2020-11-05 11:35:41 +02:00
.prettierrc Add types to monorepo 2020-04-28 13:16:14 +03:00
license.txt More licenses cleanup 2022-04-20 19:20:04 +03:00
package.json chore: update dependencies 2022-12-26 00:32:45 +02:00
pnpm-lock.yaml Start moving to pnpm 2022-06-19 20:23:03 +03:00
provider.d.ts Restructure types package: types and blank filenames must match to avoid errors in unbuild 2022-03-22 08:58:43 +02:00
provider.js Restructure types package: types and blank filenames must match to avoid errors in unbuild 2022-03-22 08:58:43 +02:00
README.md chore: fix link in types package readme 2022-09-13 09:29:41 +03:00
types.d.ts Add optional tags to IconifyInfo type 2022-08-21 14:35:59 +03:00
types.js Restructure types package: types and blank filenames must match to avoid errors in unbuild 2022-03-22 08:58:43 +02:00

README.md

Iconify Types

Type definitions for using Iconify icon sets with TypeScript.

Files structure

Iconify icon sets are available in several formats:

  • Big JSON files that combine many icons in one file
  • Node.js packages split into individual icons

Icon format

Each icon is represented by the IconifyIcon type. It is a simple object with multiple string, number or boolean attributes.

The only required attribute is:

  • body: string. Value contains inner HTML of an icon as a string, for example <path d="..."/>.

Optional attributes are represented by type IconifyOptional. They are split into several types: dimensions (IconifyDimenisons type) and transformations (IconifyTransformations type).

Dimensions attributes:

  • width: number. viewBox width, number. If missing, value is set to 16.
  • height: number. viewBox height, number. If missing, value is set to 16.
  • left: number. viewBox left, number. If missing, the value is set to 0.
  • top: number. viewBox top, number. If missing, the value is set to 0.

Transformations:

  • rotate: number. Icon rotation. Iconify icons can be rotated in 90 degrees increments, allowing to reuse the same source icon for multiple icons, such as arrow-up being a copy of arrow-left rotated by 90 degrees. Values are 0 for 0 degrees, 1 for 90 degrees, 2 for 180 degrees, 3 for 270 degrees. The default value is 0.
  • hFlip: boolean. Horizontal flip. Similar to the rotation transformation, an icon can be flipped horizontally and vertically. It can be used to quickly create aliases, such as arrow-left being an alias of arrow-right, but with hFlip set to true. The default value is false.
  • vFlip: boolean. Vertical flip. The default value is false.

Example of icon object:

const mdiHandIcon = {
	body: '<path d="M6.58 19h8v3h-8v-3m13.16-7.4c-.19-.2-.45-.32-.74-.32l-.22.03l-3.2 1.69v-1.17l.51-8.93c.03-.55-.39-1.03-.94-1.06c-.55-.03-1.03.39-1.06.94l-.27 4.69h-.24l-1.04.11V2a1 1 0 0 0-1-1c-.54 0-1 .45-1 1v6.41l-.82.37l-.69-5.46c-.07-.55-.57-.94-1.12-.87c-.55.05-.94.55-.87 1.12l.77 6.06l-.38.17c-.13.05-.25.13-.36.2l-1.1-3.89c-.16-.57-.72-.91-1.26-.77c-.53.16-.83.74-.67 1.31l2.57 9.12c0 .03.02.07.03.1l.03.13h.01c.22.57.79 1 1.4 1h6.5c.39 0 .74-.16 1-.43l4.92-4.2l-.76-.77z" fill="currentColor"/>',
	width: 24,
	height: 24,
};

Icon sets format

Iconify icon sets format is available from multiple sources:

  • NPM package @iconify/json that includes all icon sets
  • API responses used by SVG framework

Icon set format structure is available as the IconifyJSON type. It is an object with several fields:

  • prefix: string. Icon set prefix.
  • icons: object. Icons data. Value is an object that represents a set of icons, where the key is an icon name and value is IconifyIcon object (see "Icon format" above).
  • aliases: object. Icon aliases, similar to the icons object (see "Aliases" section below).

Example:

{
	"prefix": "mdi",
	"icons": {
		"home": {
			"body": "<path d=\"M10 20v-6h4v6h5v-8h3L12 3L2 12h3v8h5z\" fill=\"currentColor\"/>",
			"width": 24,
			"height": 24
		},
		"arrow-left": {
			"body": "<path d=\"M20 11v2H8l5.5 5.5l-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5L8 11h12z\" fill=\"currentColor\"/>",
			"width": 24,
			"height": 24
		}
	}
}

All icon properties except for body are optional and are represented by type IconifyOptional. Type IconifyJSON also extends type IconifyOptional, allowing all optional properties to be placed in the root object.

If an icon is missing a property, look in the root object for the default value. If the root object does not have the default value, use Iconify default value for that property (see list of properties and default values in the "Icon format" section above).

Default values in the root object make it possible to reduce duplication.

Example:

{
	"prefix": "mdi",
	"icons": {
		"home": {
			"body": "<path d=\"M10 20v-6h4v6h5v-8h3L12 3L2 12h3v8h5z\" fill=\"currentColor\"/>"
		},
		"arrow-left": {
			"body": "<path d=\"M20 11v2H8l5.5 5.5l-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5L8 11h12z\" fill=\"currentColor\"/>"
		}
	},
	"width": 24,
	"height": 24
}

In this example, both icons are 24x24, so width and height have been moved to the root object.

Another example:

{
	"prefix": "fa-solid",
	"icons": {
		"arrow-left": {
			"body": "<path d=\"M257.5 445.1l-22.2 22.2c-9.4 9.4-24.6 9.4-33.9 0L7 273c-9.4-9.4-9.4-24.6 0-33.9L201.4 44.7c9.4-9.4 24.6-9.4 33.9 0l22.2 22.2c9.5 9.5 9.3 25-.4 34.3L136.6 216H424c13.3 0 24 10.7 24 24v32c0 13.3-10.7 24-24 24H136.6l120.5 114.8c9.8 9.3 10 24.8.4 34.3z\" fill=\"currentColor\"/>",
			"width": 448
		},
		"arrow-circle-left": {
			"body": "<path d=\"M256 504C119 504 8 393 8 256S119 8 256 8s248 111 248 248s-111 248-248 248zm28.9-143.6L209.4 288H392c13.3 0 24-10.7 24-24v-16c0-13.3-10.7-24-24-24H209.4l75.5-72.4c9.7-9.3 9.9-24.8.4-34.3l-11-10.9c-9.4-9.4-24.6-9.4-33.9 0L107.7 239c-9.4 9.4-9.4 24.6 0 33.9l132.7 132.7c9.4 9.4 24.6 9.4 33.9 0l11-10.9c9.5-9.5 9.3-25-.4-34.3z\" fill=\"currentColor\"/>"
		},
		"barcode": {
			"body": "<path d=\"M0 448V64h18v384H0zm26.857-.273V64H36v383.727h-9.143zm27.143 0V64h8.857v383.727H54zm44.857 0V64h8.857v383.727h-8.857zm36 0V64h17.714v383.727h-17.714zm44.857 0V64h8.857v383.727h-8.857zm18 0V64h8.857v383.727h-8.857zm18 0V64h8.857v383.727h-8.857zm35.715 0V64h18v383.727h-18zm44.857 0V64h18v383.727h-18zm35.999 0V64h18.001v383.727h-18.001zm36.001 0V64h18.001v383.727h-18.001zm26.857 0V64h18v383.727h-18zm45.143 0V64h26.857v383.727h-26.857zm35.714 0V64h9.143v383.727H476zm18 .273V64h18v384h-18z\" fill=\"currentColor\"/>"
		}
	},
	"width": 512,
	"height": 512
}

In this example arrow-circle-left and barcode have width of 512, arrow-left has width of 448. All icons have a height of 512.

Aliases

In addition to icons, another important field in icon set object is aliases.

Aliases object is similar to icons object, except that instead of icon body icons reference another icon.

Each entry has the same attributes as an icon, except for body and has required attribute parent that contains the name of the parent icon. The parent icon must be present in the icon set file.

Example:

{
	"prefix": "fa",
	"icons": {
		"automobile": {
			"body": "<path d=\"M480 960q0-66-47-113t-113-47t-113 47t-47 113t47 113t113 47t113-47t47-113zm36-320h1016l-89-357q-2-8-14-17.5t-21-9.5H640q-9 0-21 9.5T605 283zm1372 320q0-66-47-113t-113-47t-113 47t-47 113t47 113t113 47t113-47t47-113zm160-96v384q0 14-9 23t-23 9h-96v128q0 80-56 136t-136 56t-136-56t-56-136v-128H512v128q0 80-56 136t-136 56t-136-56t-56-136v-128H32q-14 0-23-9t-9-23V864q0-93 65.5-158.5T224 640h28l105-419q23-94 104-157.5T640 0h768q98 0 179 63.5T1691 221l105 419h28q93 0 158.5 65.5T2048 864z\" fill=\"currentColor\"/>",
			"width": 2048,
			"height": 1600
		}
	},
	"aliases": {
		"car": {
			"parent": "automobile"
		}
	}
}

In this example car is an alias of automobile, allowing to use the same icon by multiple names.

Another example:

{
	"prefix": "fa",
	"icons": {
		"caret-left": {
			"body": "<path d=\"M576 192v896q0 26-19 45t-45 19t-45-19L19 685Q0 666 0 640t19-45l448-448q19-19 45-19t45 19t19 45z\" fill=\"currentColor\"/>",
			"width": 576,
			"height": 1280
		}
	},
	"aliases": {
		"caret-right": {
			"parent": "caret-left",
			"hFlip": true
		}
	}
}

In this example caret-right is alias of caret-left, but with additional hFlip attribute. It is identical to this:

{
	"prefix": "fa",
	"icons": {
		"caret-left": {
			"body": "<path d=\"M576 192v896q0 26-19 45t-45 19t-45-19L19 685Q0 666 0 640t19-45l448-448q19-19 45-19t45 19t19 45z\" fill=\"currentColor\"/>"
		},
		"caret-right": {
			"body": "<path d=\"M576 192v896q0 26-19 45t-45 19t-45-19L19 685Q0 666 0 640t19-45l448-448q19-19 45-19t45 19t19 45z\" fill=\"currentColor\"/>",
			"hFlip": true
		}
	},
	"width": 576,
	"height": 1280
}
Merging alias attributes

If both icon and alias have same attribute, following rules apply:

  • rotate: attributes are combined. For example, icon has rotate = 1, alias has rotate = 1. Result will have rotate = 2. To prevent overflow, if rotate > 3, rotate = rotate - 4.
  • hFlip and vFlip: attributes are combined. For example, icon has hFlip = true, alias also has hFlip = true (icon.hFlip !== alias.hFlip). Result is false. false + false = false, false + true = true, true + true = false.
  • other attributes are overwritten.

Example:

{
	"prefix": "fa",
	"icons": {
		"caret-left": {
			"body": "<path d=\"M576 192v896q0 26-19 45t-45 19t-45-19L19 685Q0 666 0 640t19-45l448-448q19-19 45-19t45 19t19 45z\" fill=\"currentColor\"/>",
			"hFlip": true,
			"width": 576,
			"height": 1280
		}
	},
	"aliases": {
		"caret-left-compact": {
			"parent": "caret-left",
			"left": 64,
			"width": 448
		},
		"caret-right": {
			"parent": "caret-left",
			"hFlip": true
		}
	}
}

is identical to:

{
	"prefix": "fa",
	"icons": {
		"caret-left": {
			"body": "<path d=\"M576 192v896q0 26-19 45t-45 19t-45-19L19 685Q0 666 0 640t19-45l448-448q19-19 45-19t45 19t19 45z\" fill=\"currentColor\"/>",
			"hFlip": true
		},
		"caret-left-compact": {
			"body": "<path d=\"M576 192v896q0 26-19 45t-45 19t-45-19L19 685Q0 666 0 640t19-45l448-448q19-19 45-19t45 19t19 45z\" fill=\"currentColor\"/>",
			"hFlip": true, // from caret-left
			"left": 64, // overwritten
			"width": 448 // overwritten
		},
		"caret-right": {
			"body": "<path d=\"M576 192v896q0 26-19 45t-45 19t-45-19L19 685Q0 666 0 640t19-45l448-448q19-19 45-19t45 19t19 45z\" fill=\"currentColor\"/>"
			// hFlip = false, which is default value, so it was removed
		}
	},
	"width": 576,
	"height": 1280
}

Metadata

Icon set files might also contain the metadata. That data is used for browsing icons, searching icons, exporting icon sets as fonts.

Metadata is a combination of several types, represented as type IconifyMetaData.

Icon set information

Icon set information is part of the metadata, it includes information about an author and license.

Example:

{
	"prefix": "dashicons",
	"info": {
		"name": "Dashicons",
		"total": 304,
		"author": {
			"name": "WordPress",
			"url": "https://github.com/WordPress/dashicons"
		},
		"license": {
			"title": "GPL 2.0",
			"spdx": "GPL-2.0-only",
			"url": "https://www.gnu.org/licenses/gpl-2.0.html"
		},
		"version": "0.9.0",
		"samples": ["shortcode", "businessperson", "editor-expand"],
		"height": 20,
		"category": "General",
		"palette": false
	},
	"icons": {
		// Icons here
	}
}
Info

Information block is part of the metadata, it is used for browsing or searching icon sets. It also contains the license for icons in the icon set and information about the author.

Info block is represented by the type IconifyInfo. You can see an example above in "info" property.

IconifyInfo type has the following properties, most of them are optional:

  • name: string. Icon set name. This field is always set.
  • total: number. The total number of icons, optional.
  • version: string. The current version, optional.
  • author: object. Information about the author, always set. Author information has the following properties:
    • name: string. Author name. This field is always set.
    • url: string. Link to icon set, optional. Usually links to GitHub repository.
  • license: object. Information about the license, always set. License information has the following properties:
    • title: string. License title. This field is always set.
    • spdx: string. SPDX license identifier, optional.
    • url: string. Link to the license, optional.
  • samples: string[]. Value is an array of icon names that should be used as samples when showing the icon set in an icon sets list.
  • height: number | number[]. Value is a number or array of numbers, values are pixel grids used in the icon set. If any icons in an icon set do not match the grid, this attribute should not be set.
  • displayHeight: number. The height value that should be used for displaying samples. Value is a number between 16 and 30 (inclusive).
Characters map

Characters map is part of the metadata, it is used for icon sets that are either imported from icon fonts or intended to be exported to icon font.

Characters map allows storing characters for export as well as searching icons by character used in an icon font.

It is a simple object, where the key is character code in hexadecimal form, value is an icon name.

Important: each icon can have multiple characters!

Example:

{
	"prefix": "fa",
	"icons": {
		// Icons here
	},
	"chars": {
		"f000": "glass",
		"f001": "music",
		"f002": "search",
		"f003": "envelope-o",
		"f004": "heart",
		"f005": "star"
		// and so on...
	}
}
Categories

Categories are part of the metadata, used to allow filtering icons when showing the entire icons set.

Categories list is a simple object, where the key is category name, value is the list of icons.

Important: each icon can belong to multiple categories!

{
	"prefix": "fa-solid",
	"icons": {
		// Icons here
	},
	"categories": {
		"Accessibility": [
			"american-sign-language-interpreting",
			"assistive-listening-systems",
			"audio-description",
			"blind",
			"braille",
			"closed-captioning",
			"deaf",
			"low-vision",
			"phone-volume",
			"question-circle",
			"sign-language",
			"tty",
			"universal-access",
			"wheelchair"
		],
		"Alert": [
			"bell",
			"bell-slash",
			"exclamation",
			"exclamation-circle",
			"exclamation-triangle",
			"radiation",
			"radiation-alt",
			"skull-crossbones"
		]
		// and so on...
	}
}
Themes

Themes are part of the metadata, similar to categories, but using prefixes or suffixes to identify icons that belong to a theme.

This is useful when icon set has variations of icons, such as "baseline-", "outline-".

Example:

{
	"prefix": "ic",
	"icons": {
		// Icons here
	},
	"themes": {
		"baseline": {
			"title": "Baseline",
			"prefix": "baseline-"
		},
		"outline": {
			"title": "Outline",
			"prefix": "outline-"
		},
		"round": {
			"title": "Round",
			"prefix": "round-"
		},
		"sharp": {
			"title": "Sharp",
			"prefix": "sharp-"
		},
		"twotone": {
			"title": "Two-Tone",
			"prefix": "twotone-"
		}
	}
}

Each theme can have one of the attributes: prefix or suffix. The prefix must end with -, suffix must start with -.

In an example above, all icons that start with "baseline-", such as "baseline-home", are considered part of the "Baseline" theme.

All attributes

For an example of full icon set files that include metadata, look in icon set files in @iconify/json package or browse it at GitHub: https://github.com/iconify/icon-sets

For an example of individual icons, look in JavaScript files in NPM packages such as @iconify/icons-mdi.

Usage

This repository is intended to be used with any Iconify packages.

At the moment of writing, multiple Iconify packages are written without TypeScript. At the beginning of the year 2020 plan is to rewrite all of them with TypeScript to make sure data is consistent and avoid duplication, this package will be used for sharing types between Iconify packages.

License

This package is licensed under MIT license.

SPDX-License-Identifier: MIT

Previous versions of this package were dual-licensed under Apache 2.0 and GPL 2.0 licence, which was messy and confusing. This was later changed to MIT for simplicity.

© 2021 - 2022 Vjacheslav Trushkin / Iconify OÜ