Skip to content
react-icons-ng / 5.2.0

react-icons-ng 5.2.0

Install from the command line:
Learn more about npm packages
$ npm install @onemind-services-llc/react-icons-ng@5.2.0
Install via package.json:
"@onemind-services-llc/react-icons-ng": "5.2.0"

About this version


Redefine the visual elegance of your React projects with react-icons-ng. Stemming from the prestigious legacy of react-icons/react-icons, our forked library enriches your design experience by offering an astounding collection of over 60,000 icons. This vast addition ensures we outshine the original repository in diversity and adaptability.

Harness the power of ES6 imports and embed into your projects only the icons that resonate with your vision. With react-icons-ng, not only do you get unparalleled icon variety but also a streamlined development workflow. Dive into the dynamic world of React icons and make your applications visually captivating.

πŸš€ Installation (for Modern Projects)

Before proceeding, please note that the NPM registry for this package is hosted on GitHub. You need to configure your NPM client to use GitHub Packages registry for this package. For more information, see "Configuring npm for use with GitHub Packages".

yarn add @onemind-services-llc/react-icons-ng
# or
npm install @onemind-services-llc/react-icons-ng --save

How to Use?

import { FaBeer } from "@onemind-services-llc/react-icons-ng/fa";

function Question() {
  return (
    <h3>
      How about a <FaBeer />?
    </h3>
  );
}

⚠️ NOTE: Each icon package resides in its dedicated subfolder under @onemind-services-llc/react-icons-ng.

For instance, if you wish to employ an icon from Material Design, your import should be:

import { ICON_NAME } from '@onemind-services-llc/react-icons-ng/md';

πŸš€ Installation (for MeteorJS, GatsbyJS, etc.)

Opt for this if your project scales up significantly. Bear in mind, though, this approach might prolong the installation time.

yarn add @onemind-services-llc/react-icons-ng-pack
# or
npm install @onemind-services-llc/react-icons-ng-pack --save

How to Use?

import { FaBeer } from "@onemind-services-llc/react-icons-ng-pack/fa/FaBeer";

function Question() {
  return (
    <h3>
      Fancy a <FaBeer />?
    </h3>
  );
}

Icons

[//]: # START_VERSION

Icon Library License Version Count
Ant Design Icons MIT @ant-design/icons-svg@4.0.0-184-gd7c5ad5 789
BoxIcons MIT 9ffa9136e8681886bb7bd2145cd4098717ce1c11 1634
Bootstrap Icons MIT v1.11.2-10-g74e13a5 2716
css.gg MIT 2.1.1-1-gdeea4fa 704
Circum Icons MPL-2.0 license v2.0.2-2-geeef620 288
Coolicons CC BY 4.0 License v4.1-1-g1a92717 442
CoreUI Icons MIT v3.0.0-3-g4b1f387 556
EOS Icons MIT v5.4.0-4-ga21c4b9 156
Font Awesome 5 CC BY 4.0 License 5.15.4-3-gafecf2a 1612
Font Awesome 6 CC BY 4.0 License 6.5.1 2037
Flat Color Icons MIT v1.0.2-27-g8eccbbb 329
Feather MIT v4.29.1-2-g593b3bf 287
Fluent System Icons MIT 1.1.224 4289
Github Octicons icons MIT v19.8.0 273
US Government Icons SIL OFL 1.1 1.6.0-2-g1d9f467 136
Game Icons CC BY 3.0 12920d6565588f0512542a3cb0cdfd36a497f910 4040
Grommet-Icons Apache License Version 2.0 v4.12.0 635
Health Icons MIT 57df21dda664a633479e4fc2fe50227dba963734 1797
Heroicons MIT v2.0.18-5-gf937b6f 885
Iconoir MIT v7.1.0-1-g044843a 1512
IcoMoon Free CC BY 4.0 License d006795ede82361e1bac1ee76f215cf1dc51e4ca 491
Ionicons 5 MIT 5.5.4 1332
Jam Icons MIT 3.1.0-2-gc8501b1 940
Icons8 Line Awesome MIT v1.2.1-10-g78a1012 1544
Lucide ISC 0.295.0-2-ge32db96 1346
MingCute icons Apache License Version 2.0 v2.88 2670
Material Design icons Apache License Version 2.0 4.0.0-92-g70c7b5e1f6 4341
Material Design icons 2 Apache License Version 2.0 4a40d68d9addf7604d82157626ea53946e3d1cb9 7367
Openmoji CC BY-SA 4.0 14.0.0-269-gd04602d 4147
Phosphor Icons MIT v2.0.2-6-g21d20a9 7488
Polaris MIT @shopify/polaris-migrator@0.26.6-2-gbc4272a2 580
Remix Icon Apache License Version 2.0 v3.7.0-1-g1cbc904 2671
Radix Icons MIT @radix-ui/react-icons@1.3.0-1-g94b3fcf 318
Simple Icons CC0 1.0 Universal 4.14.0-2045-g16954ac 2894
Simple Line Icons MIT v2.5.5 189
Tabler Icons MIT v2.44.0 4908
Themify Icons MIT v0.1.2-2-g9600186 352
Typicons CC BY-SA 3.0 v2.1.2 336
VS Code Icons CC BY 4.0 0.0.35-13-g88424ed 446
Weather Icons SIL OFL 1.1 2.0.12-7-gbb80982 219

Total Count of Icons: 69696

[//]: # END_VERSION

You can add more icons by submitting pull requests or creating issues.

πŸ”§ Configuration

Easily customize react-icons-ng properties utilizing the React Context API.

Prerequisite: Ensure you have React 16.3 or a later version.

import { IconContext } from "@onemind-services-llc/react-icons-ng";

<IconContext.Provider value={{ color: "blue", className: "global-class-name" }}>
  <div>
    <FaFolder />
  </div>
</IconContext.Provider>;
Key Default Description
color undefined (inherit) Icon color
size 1em Icon size
className undefined Add custom classes
style undefined Inline styles, can override size and color
attr undefined Extra attributes, may be overwritten by others
title undefined Describes the icon for accessibility purposes

🎨 CSS Adjustments

Icons no longer come with the vertical-align: middle styling by default. For alignment adjustments, utilize the IconContext to specify a className or apply an inline style directly.

Set Global Inline Styling:

<IconContext.Provider value={{ style: { verticalAlign: 'middle' } }}>

Define Global className Styling:

Component:

<IconContext.Provider value={{ className: 'react-icons-ng' }}>

CSS:

.react-icons-ng {
  vertical-align: middle;
}

πŸ’‘ Contributing

Execute ./build-script.sh to build the entire project. For additional details, review the CI scripts.

πŸ›  Development Workflow:

yarn
cd packages/react-icons-ng
yarn fetch  # Retrieves icon sources
yarn build

πŸ“Ί Preview Setup:

cd packages/react-icons-ng
yarn fetch
yarn build

cd ../preview
yarn start

πŸŽ₯ Demo Insights:

Our demo utilizes the Create React App framework with react-icons-ng as an integrated dependency, allowing seamless testing.

cd packages/react-icons-ng
yarn fetch
yarn build

cd ../demo
yarn start

πŸ–Ό Why React SVG Components Over Fonts?

SVG enjoys universal support across major browsers. Using react-icons-ng, you can deliver only required icons to users, reducing loading times and clearly identifying utilized icons in your project.

🌐 Related Projects:

πŸ“œ License:

Released under the MIT License.

Note: Icons originate from various projects, so it's crucial to review the respective project licenses.

Details


Assets

  • react-icons-ng-5.2.0.tgz

Download activity

  • Total downloads 13
  • Last 30 days 0
  • Last week 0
  • Today 0