Détail du package

@siemens/ix-icons

siemens27.8kMIT3.1.1

Siemens iX icon library

readme

iX

Siemens Industrial Experience Icons

License: SEE LICENSE IN <LICENSE.md>

Usage

Setting up with Siemens Industrial Experience design system

If you are also using the library Siemens Industrial Experience, no additional project setup will be necessary. The packages @siemens/ix-angular, @siemens/ix-react or @siemens/ix-vue will take care of setting up the icon library for you.

Setting up without Siemens Industrial Experience design system

If you want to use @siemens/ix-icons without @siemens/ix you need to follow these steps:

Using CDN

Place the following <script> near the end of your page, right before the closing </body> tag.

<script type="module" src="https://cdn.jsdelivr.net/npm/@siemens/ix-icons@%5E3.0.0/dist/ix-icons/ix-icons.esm.js"></script>
<script nomodule src="https://cdn.jsdelivr.net/npm/@siemens/ix-icons@%5E3.0.0/dist/ix-icons/ix-icons.js"></script>

Now you can render icons in your applicaton:

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

Using a package manager like npm/pnpm/yarn

First install the package @siemens/ix-icons@latest in your project (e.g. npm install --save @siemens/ix-icons).

Then load the icon component:

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

// Register Web Component <ix-icon></ix-icon>
defineCustomElements();

Prepare your project

  1. Copy SVG Files: Copy all SVG files located under node_modules/@siemens/ix-icons/svg to an asset folder in your project. This allows the ix-icon component to fetch the images.

  2. Alternative Method: Alternatively, you can use the addIcons function to load specific icons directly in your code. For example:

    import { addIcons } from '@siemens/ix-icons';
    import { iconStar } from '@siemens/ix-icons/icons';
    
    addIcons({ iconStar });
    
    <ix-icon name="star"></ix-icon>
    

    You only need to add the same icon once. Additional calls to addIcons will not add redundant copies of the same icons to the collection.

Use the ix-icon component with custom SVG's

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

Development

Installation

pnpm install

Build

pnpm build

🤝 Contributing

Contributions, issues and feature requests are welcome!

📝 License

Copyright © 2019–2025 Siemens AG.

This project is MIT licensed.

changelog

@siemens/ix-icons

3.1.1

Patch Changes

3.1.0

Minor Changes

Patch Changes

3.0.0

Major Changes

  • #65 0d271ac Thanks @danielleroux! - - Add new set of icons

    • Icon replacements:

    | removed | replaced by | | ---------------------------- | ---------------------------- | | add-cirlce-small-filled | add-circle-small-filled | | asset-network-1 | asset-network-filled | | battery-bolt | battery-charge | | battery-upright-bolt | battery-upright-charge | | checkbox-component-checked | checkbox | | corner-arrow-up-left | arrow-up-left | | draw-cirlce | draw-circle | | filter-outline | filter | | folder-new-outline | folder-new | | folder-open-outline | folder-open | | folder-outline | folder | | full-screeen-exit | full-screen-exit | | full-screeen | full-screen | | location-outline | location | | new-indicator-filled | add-circle-small-filled | | new-indicator | add-circle-small | | no-anomaly | anomaly-none | | plant-outline | plant | | tag-cirlce-arrow-down | tag-circle-arrow-down | | tag-cirlce-arrow-down-filled | tag-circle-arrow-down-filled | | thumb-filled | thumb-down-filled | | user-reading-reading | user-reading-filled |

    • Icon landing-page-logo removed without an replacement
  • #65 0d271ac Thanks @danielleroux! - feat: remove prebundled icons

Minor Changes

  • #83 e2bf758 Thanks @danielleroux! - add table specific icons

    • table-add-column-right
    • table-add-row-below
    • table-insert-column-left
    • table-insert-column-right
    • table-insert-row-above
    • table-insert-row-below
  • #65 0d271ac Thanks @danielleroux! - Allow users to put specific icons into the cache.

  • #83 e2bf758 Thanks @danielleroux! - Convert package to type module

  • #83 e2bf758 Thanks @danielleroux! - - Update shapes of battery icons, affected icons:

    • battery-charge
    • battery-check
    • battery-empty-question
    • battery-exclamation
    • battery-full-check
    • battery-full
    • battery-half
    • battery-low
    • battery-quarter
    • battery-slash
    • battery-three-quarter
    • battery-upright-charge
    • battery-upright-check
    • battery-upright-empty-question
    • battery-upright-exclamation
    • battery-upright-full-check
    • battery-upright-full
    • battery-upright-half
    • battery-upright-low
    • battery-upright-quarter
    • battery-upright-slash
    • battery-upright-three-quarter

    • Update shape of cloud icons, affected icons:

      • cloud-download-add-filled
      • cloud-download-add
      • cloud-download-filled
      • cloud-download-list-filled
      • cloud-download-list
      • cloud-download
      • cloud-filled
      • cloud-new-filled
      • cloud-new
      • cloud-upload-filled
      • cloud-upload
      • cloud
      • cloud-cancelled-filled
      • cloud-cancelled
      • cloud-fail-filled
      • cloud-fail
      • cloud-rain-filled
      • cloud-rain
      • cloud-snow-filled
      • cloud-snow
      • cloud-success-filled
      • cloud-success
      • cloud-thunder-filled
      • cloud-thunder
      • sun-cloud-filled
      • sun-cloud
    • Add new icons

      • error-multiple-filled
      • error-multiple
      • info-multiple-filled
      • info-multiple
      • success-multiple-filled
      • success-multiple
      • warning-multiple-filled
      • warning-multiple
      • warning-rhomb-multiple-filled
      • warning-rhomb-multiple
      • asset-indoor
      • asset-outdoor
      • bug-runtime-filled
      • bug-runtime
      • capacity-check-filled
      • capacity-check
      • capacity-locked-filled
      • capacity-locked
      • capacity-pen-filled
      • capacity-pen
      • clock-person
      • communication-filled
      • communication
      • dashboard-pen-filled
      • dashboard-pen
      • device-manager
      • document-plus-minus-filled
      • document-plus-minus
      • export-check
      • export-failed
      • export-progress
      • extension
      • eye-dropper
      • folder-application-screen
      • folder-tag
      • grid-pen
      • id-filled
      • id
      • java-script-connection
      • list-percentage
      • lock-check
      • move-horizontally
      • move-vertically
      • pen-cancelled-filled
      • pen-cancelled
      • projects
      • remote-access (closes https://github.com/siemens/ix/issues/1673)
      • tag-connection-view
      • tree-two-level
      • trend-flat-curve
      • user-lock-filled
      • user-lock
      • user-management-settings-filled
      • user-management-settings
    • Fix ending of thermometer-filled not rounded

  • #65 0d271ac Thanks @danielleroux! - - Improve logging by including HTML element in output to identify the source component.

    • Update stencil version to 4.27.1

Patch Changes

3.0.0-alpha.1

Minor Changes

3.0.0-alpha.0

Major Changes

  • #65 0d271ac Thanks @danielleroux! - - Add new set of icons

    • Icon replacements:

    | removed | replaced by | | ---------------------------- | ---------------------------- | | add-cirlce-small-filled | add-circle-small-filled | | asset-network-1 | asset-network-filled | | battery-bolt | battery-charge | | battery-upright-bolt | battery-upright-charge | | checkbox-component-checked | checkbox | | corner-arrow-up-left | arrow-up-left | | draw-cirlce | draw-circle | | filter-outline | filter | | folder-new-outline | folder-new | | folder-open-outline | folder-open | | folder-outline | folder | | full-screeen-exit | full-screen-exit | | full-screeen | full-screen | | location-outline | location | | new-indicator-filled | add-circle-small-filled | | new-indicator | add-circle-small | | no-anomaly | anomaly-none | | plant-outline | plant | | tag-cirlce-arrow-down | tag-circle-arrow-down | | tag-cirlce-arrow-down-filled | tag-circle-arrow-down-filled | | thumb-filled | thumb-down-filled | | user-reading-reading | user-reading-filled |

    • Icon landing-page-logo removed without an replacement
  • #65 0d271ac Thanks @danielleroux! - feat: remove prebundled icons

Minor Changes

  • #65 0d271ac Thanks @danielleroux! - Allow users to put specific icons into the cache.

  • #65 0d271ac Thanks @danielleroux! - - Improve logging by including HTML element in output to identify the source component.

    • Update stencil version to 4.27.1

2.2.0

Minor Changes