The @fortawesome/fontawesome-common-types npm package provides TypeScript definitions for common types used across the Font Awesome ecosystem. This package is primarily intended for internal use by other Font Awesome packages to ensure consistent type definitions across the suite of Font Awesome tools and components. It includes types for icons, icon styles, and other configurations.

What are @fortawesome/fontawesome-common-types's main functionalities?

IconDefinition

Defines the structure of an icon definition, including its name, style prefix, and SVG path data. This is crucial for ensuring that icons are consistently defined and used across different Font Awesome components.

{"prefix": "fas", "iconName": "user", "icon": [512, 512, [], "f007", "M...Path"]}

IconPrefix

Specifies the available style prefixes for Font Awesome icons, such as solid (`fas`), regular (`far`), light (`fal`), duotone (`fad`), and brands (`fab`). This helps in categorizing icons based on their style and ensuring the correct rendering of the icon.

"fas" | "far" | "fal" | "fad" | "fab"

IconName

Represents the names of available icons. This type is used to ensure that only valid icon names are used within the Font Awesome ecosystem, preventing errors related to undefined or misspelled icons.

"user" | "coffee" | "car" | "apple-alt"

Other packages similar to @fortawesome/fontawesome-common-types

Readme

Source

@fortawesome/fontawesome-common-types - SVG with JavaScript

"I came here to chew bubblegum and install Font Awesome 6 - and I'm all out of bubblegum"

What is this package?

Font Awesome 6 JavaScript packages support TypeScript. This package abstracts out some of the common definitions that those packages use.

Here be dragons

If you are trying to import types from this package we highly recommend you do the following instead as all types in this package are re-exported to the main fontawesome package.

your.ts

import {
  IconName
} from `@fortawesome/fontawesome-svg-core`

const myIcon: IconName = "..."

Issues and support

Start with GitHub issues and ping us on Twitter if you need to.

Keywords

FAQs

What is @fortawesome/fontawesome-common-types?

Is @fortawesome/fontawesome-common-types popular?

Is @fortawesome/fontawesome-common-types well maintained?

Last updated on 02 Apr 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install