@iconify/types

What is @iconify/types?

@iconify/types is a TypeScript package that provides type definitions for Iconify JSON data. It is used to ensure type safety when working with Iconify icons in TypeScript projects.

What are @iconify/types's main functionalities?

IconifyJSON

Defines the structure of Iconify JSON data, including properties like prefix, icons, width, and height.

{
  "prefix": "mdi",
  "icons": {
    "home": {
      "body": "<path d='M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z'/>"
    }
  },
  "width": 24,
  "height": 24
}

IconifyIcon

Defines the structure of an individual icon, including properties like body, width, and height.

{
  "body": "<path d='M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z'/>",
  "width": 24,
  "height": 24
}

IconifyAlias

Defines the structure of an icon alias, including properties like parent and hFlip.

{
  "parent": "home",
  "hFlip": true
}

Other packages similar to @iconify/types

react-icons

React Icons provides a collection of popular icon libraries for React applications. Unlike @iconify/types, which focuses on type definitions, react-icons provides ready-to-use React components for icons.

fontawesome-svg-core

FontAwesome SVG Core is a package for using FontAwesome icons in web projects. It provides a comprehensive set of icons and utilities for managing them, but it is specific to FontAwesome, whereas @iconify/types is more generic.

material-icons

Material Icons is a package that provides Google's Material Design icons. It is similar to @iconify/types in that it offers a collection of icons, but it is specific to Material Design.

README

Iconify Types

Type definitions for using Iconify libraries and JSON files with TypeScript.