@jaydioar/ix-wcl-icons

iX Web Component Library Icons (IX-WCL-ICONS)

This repository contains the code for the web component library icons shared among many Engineer.iX web projects.

• iX Web Component Library Icons (IX-WCL-ICONS)
• Usage
  • Add icon library to your project
  • Use system icons
  • Use default icons
• Development

Usage

Add icon library to your project

npm i @jaydioar/ix-wcl-icons@latest

Use system icons

There is a set of system icons bundled into a single javascript file that is used by the XWCL library.. If you want to use them directly you can import the file and use the appropriate icon from the exported object and include it into your html by including it as a data-url... See the following example for React/NextJS:

import icons from '@jaydioar/ix-wcl-icons/dist/icons/system/mono/24/icons.js';

import Image from "next/image";

export default function Home() {
  return (
    <>
      <p className="px-10 py-2 bg-white text-black">

      Fancy house icon from system icon set (loaded via data-uri):  
        <img src={`data:image/svg+xml,${encodeURIComponent(icons['home-24'])}`} />
    </>
  );
}

The system icons also are available as separate svg files inside the default icons folder.

Use default icons

The default icons are available as separate svg files inside the default icons foldes. You can use them directly in your project by including them with a wrapper that bundles the svg content into your javascript code during the build process.

import Horse24 from '@jaydioar/ix-wcl-icons/dist/icons/default/mono/24/horse-24.svg';

import Image from "next/image";

export default function Home() {
  return (
    <>
      <p className="px-10 py-2 bg-white text-black">

      Big horse icon from default icon set (loaded via next/image component):
        <Image src={Horse24}  style={{width: '100px', height: '100px' }} alt="Test" />
      </p>
    </>
  );
}

Alternatively you can copy the svg files from the node_modules folder to your projects asset folder and include them directly in your html. (useful for static site generators like Hugo, Jekyll, etc.)

Development

If you want to develop new icons you can clone this repository and install the dependencies:

git clone [e-mail]:jaydioar/ix-wcl-icons.git
npm install

Please follow the instructions in the [README](README.md file in the root of the repository to get started with development.