# Icons

# Overview

We have used Material Design Icons from the Iconify library in the whole template. You may visit the site here (opens new window) and check all the icons here (opens new window). Users are free to use any icon library of their choice.

WARNING

We are using the offline icons with the help of Iconify bundle and we suggest you do the same. If you want to use very few icons from other libraries, then you may use online icons directly from the public API of Iconify.

Heads Up!

The src/iconify-bundle/tsconfig.json file is different from the tsconfig.json file and thus do not delete the src/iconify-bundle/tsconfig.json file from your project; otherwise, you will not be able to generate icon bundle from the yarn build:icons command.

Heads Up!

While using the Tabler icons, fill and stroke related props (like fill, fillOpacity, stroke, strokeWidth, strokeOpacity, etc.) will not work with the Icon component as the <svg> tag doesn't have those attributes.

If anyone wants to add such styling, then they may add them using the style prop or use MUI's Box component and use the sx props with it.

# Iconify Bundle

When Iconify icon component renders an icon, if icon data is not available, the component attempts to load data for an icon from Iconify API.

Even though loading icon data from API is very fast, it is not instant and it requires internet access. By providing icon data for most used icons, you guarantee that icon data is ready when a component needs it, rendering icons instantly.

This also allows rendering icons when internet access is not available and you are no longer relying on third-party service.

The following files are necessary to generate Iconify bundle:

src/iconify-bundle/bundle-icons-react.d.ts (typescript version only)
src/iconify-bundle/bundle-icons-react.js
src/iconify-bundle/bundle-icons-react.ts (typescript version only)
src/iconify-bundle/icons-bundle-react.js
src/iconify-bundle/tsconfig.json
package.json

# How to Generate Bundle?

You can generate the bundle with a wide variety of emojis, flags, brand logos, SVGs & icons and use them even when internet access is not available. To generate such icons, you just need to add your desired icon library, any specific icon(s), a custom JSON file created by you, custom SVG(s) created by you or any emoji(s).

# Generate all icons from an icon library

To add all the icons from an icon library provided by Iconify, you just need to do the following in the src/iconify-bundle/bundle-icons-react.ts file:

# Generate some icons from an icon library

To add some icons from an icon library provided by Iconify, you just need to do the following in the src/iconify-bundle/bundle-icons-react.ts file:

# Generate some icons from different libraries

To add some icons from different libraries provided by Iconify, you just need to do the following in the src/iconify-bundle/bundle-icons-react.ts file:

# Generate some icons from a custom JSON file

To add some icons from a custom JSON file, you need to follow the file format according to this (opens new window) and do the following in the src/iconify-bundle/bundle-icons-react.ts file:

# Generate some icons from some custom SVG files

To add some icons from some custom SVG files, you need to create some SVG files in a single folder inside the src folder and do the following in the src/iconify-bundle/bundle-icons-react.ts file:

# Generate some icons from some custom Emojis

To add some icons from some custom emojis, you need to create some emojis in a single folder inside the src folder and do the following in the src/iconify-bundle/bundle-icons-react.ts file:

# Target & Import

Once you have added all the icons that are necessary for your project, you need to set the file path in which the whole icon bundle gets generated.

Search for the term const target = in the src/iconify-bundle/bundle-icons-react.ts or src/iconify-bundle/bundle-icons-react.js file and set a file path which is suitable for your project. Once the file path is set, you need to update that file path in the src/pages/_app.tsx or src/pages/_app.js file as well. Once the import statement is updated in the src/pages/_app.tsx or src/pages/_app.js file, you can use Iconify React Component anywhere in the template.

We have set the value of target as:

const target = 'src/iconify-bundle/icons-bundle-react.js'

and the import statement as:

import 'src/iconify-bundle/icons-bundle-react'

# Run the command

Once you have set the target and updated the import statement, then you need to run the following command in the root (where your package.json file exists):

# How is the bundle generated?

# TypeScript

The bundle is generated once you have added the icons, set the target, updated the import statement and run the command.

When you run the command, the src/iconify-bundle/bundle-icons-react.ts file is compiled to the src/iconify-bundle/bundle-icons-react.js file. Once the compilation is completed, the compiled file gets all the icon data from Iconify. After retrieving the icon data, the icon data is wrapped in a callback to create a JavaScript file. The callback function used is addCollection() which is provided by the @iconify/react package.

In our case, the final JavaScript file is created as the src/iconify-bundle/icons-bundle-react.js file. In this file, the icon data is collected and wrapped with the addCollection() callback function. So you don't have to handle anything from your side. You just have to import this file into the src/pages/_app.tsx file.

# JavaScript

The bundle is generated once you have added the icons, set the target, updated the import statement and run the command.

When you run the command, the src/iconify-bundle/bundle-icons-react.js file gets all the icon data from Iconify. After retrieving the icon data, the icon data is wrapped in a callback to create a JavaScript file. The callback function used is addCollection() which is provided by the @iconify/react package.

# Usage

# Props

You may visit this docs (opens new window) provided by Iconify to refer to all the props of the Iconify React Component.

# How to use Iconify React Component?

Import the Iconify React Component as given below:

import Icon from 'src/@core/components/icon'

If you want the default font-size of the Iconify React Component as 16px, you need to import the following component:

import { Icon } from '@iconify/react'

Here is an example:

import Icon from 'src/@core/components/icon'

const Component = () => {
  return <Icon icon='tabler:home' />
}

export default Component

In the example given above, tabler is Tabler Icons (icon library provided by Iconify) and home is an icon which is in the tabler icon library.

# Use some different icon library

Suppose you want to use the Font Awesome Solid icon library. Please follow these instructions to add the icons from the Font Awesome Solid icon library. Here is an example to use an icon from the Font Awesome Solid icon library:

import Icon from 'src/@core/components/icon'

const Component = () => {
  return <Icon icon='fa6-solid:bicycle' />
}

export default Component

In the example given above, fa6-solid is Font Awesome Solid icon library and bicycle is an icon which is in the fa6-solid icon library.

# Style an icon using MUI component

Here is an example to change the color of an icon using an MUI component:

import Box from '@mui/material/Box'
import Icon from 'src/@core/components/icon'

const Component = () => {
  return (
    <Box sx={{ display: 'flex', color: theme => theme.palette.primary.main }}>
      <Icon icon='tabler:home' />
    </Box>
  )
}

export default Component

# Use icon from Iconify public API

By default, Iconify icon components use Iconify public API. Iconify icon components also cache loaded icons in the browser cache and/or browser storage, so icon data needs to be loaded only once.

You need internet access to load the icons from the Iconify public API for the first time. Otherwise, the icon will not be rendered on your page and a console error will come.

To render the icons from the Iconify public API, you must not include those icons in the Iconify bundle.

← Layout Content Height Fixed Folder Structure →