README.md

Fleekon - Fleek's icon toolkit

Curated list of brand icons generated with Icomoon App, used accross Fleek React apps.

📦 Install

yarn add @fleekhq/fleekon

The package is under the github package registry @FleekHQ organisation.

You need to have NPM configured to fetch packages under the @FleekHQ scope, so if you haven't learned how to, read the docs here.

🤔 Use

Fleekon is a regular React component, that takes the following properties:

• Collection - a json file that represents a set
• Icon - an icon name as described in the collection set or json file
• Size - a numerical value suffixed with the px units
• Color - the desired icon colour
• Classname - an optional, class name for your custom styles

Here's some cause to show it in action:

import React from "react";
import Fleekon from "@fleekHQ/fleekon";
import Plug from 'plug.json';

const App = () => {
  return (
    <div>
      <h1>My application</h1>
      <Fleekon
        collection={Plug}
        icon="box"
        size="18px"
        color="black"
        className="custom-style"
      />
    </div>
  );
};

Learn how to curate, edit and amange the Collection by reading about it here. If you find it difficult, contact the design team to help you!

As stated above, you can style the Icon with regular selectors:

.custom-style {
  color: 'black';
}

.custom-style:hover {
  color: 'deepskyblue';
}

♻️ Reusability

Passing the collection everytime you need an icon is not a great practice, instead have an IconCreator that provides a wrapped version of the icon collection you want to use.

Here's an example of a simple setup for it:

import React from "react";
import Fleekon from "@fleekHQ/fleekon";
import Plug from 'plug.json';

export const Icon = ({
  icon,
  size,
  color,
  className,
}) => (
  <Fleekon
    collection={Plug}
    icon={icon}
    size={size}
    color={color}
    className={className}
  />
);

Here's the wrapped Icon in action:

import React from "react";
import { Icon } from "./example";

const App = () => (
  <div>
    <h1>My application</h1>
    <Icon
      icon="box"
      size="18px"
      color="black"
      className="custom-style"
    />
    <Icon
      icon="qrcode"
      size="18px"
      color="black"
      className="custom-style"
    />
  </div>
);

👄 Curation

Create or edit Icon packages in the Icomoon App by using or downloading the selection.json file.

📚 Storybook

yarn storybook

References

IcoMoon app

Forked React-IcoMoon