IconData

An IconData object contains information about an icon. It is most often used to represent an icon that is rendered as a page icon in the Notion UI.

Properties

PropTypeDescription
type*"emoji" | "lucide" | "url" | "text"The type of the icon object.
src*stringThe source of the icon.
colorstringThe color of the icon. This value is used only in "lucide" icons.

Icon Type Objects

Emoji

Properties

PropTypeDescription
type*"emoji"-
src*stringThe emoji.

Example

{
  type: "emoji",
  src: "🚀"
}

Lucide Icon

Properties

PropTypeDescription
type*"emoji"-
src*LucideNameThe name of the Lucide icon.
colorstringThe color of the Lucide icon.

Example

{
  type: "lucide",
  src: "file"
  color: "#7d7d7d"
}

Custom Icon

Properties

PropTypeDescription
type*"url"-
src*stringThe URL of the image.

Example

{
  type: "url",
  src: "https://github.com/shadcn.png"
}

Text-like Icon

Properties

PropTypeDescription
type*"text"-
src*stringThe displayed letter.

Example

{
  type: "text",
  src: "A"
}

On this page