fllstx / ix-icons

Icon web font library for @siemens/ix

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

iX

Siemens Industrial Experience Icons

npm node yarn License: SEE LICENSE IN <LICENSE.md>

Usage

Using icons within your project. You need to:

  • Install @siemens/ix-icons e.g. npm install --save @siemens/ix-icons
  • Load styling e.g. @siemens/ix-icons/dist/scss/ix-icons.css
import { defineCustomElements } from '@siemens/ix-icons/loader';

(async () => {
  await defineCustomElements();
})();

Use icon via string name

<ix-icon name="rocket"></ix-icon>

Use icon via import

import { rocket } from '@siemens/ix-icons/icons';

<ix-icon name={rocket}></ix-icon>;

Use ix-icon component with custom svg's

<ix-icon name="/your/asset/path/my-icon.svg"></ix-icon>;

Development

Installation

yarn install

Build

yarn build

🤝 Contributing

Contributions, issues and feature requests are welcome!

📝 License

Copyright © 2019–2023 Siemens AG.

This project is MIT licensed.

About

Icon web font library for @siemens/ix

License:MIT License


Languages

Language:TypeScript 98.1%Language:HTML 1.1%Language:JavaScript 0.3%Language:SCSS 0.3%Language:CSS 0.1%