TypeScript icon, indicating that this package has built-in type declarations

0.40.2 • Public • Published


Elements - icon

Part of the reusable Tradeshift UI Components as Web Components. Demo

NPM Version Downloads per month

<style> table { width:100%; } </style>

➤ Properties

Property Attribute Type Default Description
icon icon String Icon name, ex: 'arrow-up' or inline svg string
src src String Url to svg for icon. It will override the icon property
size size String sizes.MEDIUM 'small' or 'medium' or 'large'
type type String Determining icon color, ex: 'error', 'focus'
circular circular Boolean false Add circular background for icon
rotate rotate Number 90, 180, 270
flip flip String 'h', 'horizontal', 'v', 'vertical'
svgContent svgContent String '' INTERNAL svg content to be rendered inside icon

➤ How to use it

  • Install the package of icon
$ npm i @tradeshift/elements.icon --save
  • Import the component
import '@tradeshift/elements.icon';


<script src="node_modules/@tradeshift/elements.icon/lib/icon.umd.js"></script>
  • Use it like demo

  • Our components rely on having the Open Sans available, You can see the font-weight and font-style you need to load here, or you can just load it from our package (for now)

<link rel="stylesheet" href="node_modules/@tradeshift/elements/src/fonts.css" />

➤ Polyfills

For supporting IE11 you need to add couple of things

  • Don't shim CSS Custom Properties in IE11
<!-- Place this in the <head>, before the Web Component polyfills are loaded -->
	if (!window.Promise) {
		window.ShadyCSS = { nativeCss: true };
You have two options for polyfills library:
  1. Use @open-wc/polyfills-loader
  • Installation
$ npm i @open-wc/polyfills-loader
  • Load it
import loadPolyfills from '@open-wc/polyfills-loader';

loadPolyfills().then(() => import('./my-app.js'));
  1. Use @webcomponents/webcomponentsjs
  • Installation
$ npm i @webcomponents/webcomponentsjs --save
  • Enable ES5 class-less Custom Elements
<script src="/node_modules/@webcomponents/webcomponentsjs/custom-elements-es5-adapter.js"></script>
<script src="/node_modules/@webcomponents/webcomponentsjs/webcomponents-loader.js" defer></script>

➤ How to contribute

Thanks for your interest and help!

  • First thing you need to do is read this [Component Checklist] which contains lots of important information about what you need to consider when you are creating/changing components
General info

You can find some links to useful materials about what we are using and some tutorials and articles that can help you get started.

Polyfill Limitations

You can see a list of limitations that we should watch out for, here

➤ License

  • You can always create forks on GitHub, submit Issues and Pull Requests.
  • You can only use Tradeshift Elements to make apps on a Tradeshift platform, e.g. tradeshift.com.
  • You can fix a bug until the bugfix is deployed by Tradeshift.
  • You can host Tradeshift Elements yourself.
  • If you want to make a bigger change or just want to talk with us, reach out to our team here on GitHub.

You can read the full license agreement in the LICENSE.md.




Package Sidebar


npm i @tradeshift/elements.icon

Weekly Downloads






Unpacked Size

133 kB

Total Files


Last publish


  • jesperterkelsen
  • ngunder
  • tradeshift-larsbojensen
  • wejendorp
  • kian-esmailpour
  • tradeshift-ci
  • aleksandr.elkin
  • ehats
  • tradeshift-public