@tradeshift/elements.app-icon
npm i @tradeshift/elements.app-icon

@tradeshift/elements.app-icon

Tradeshift Elements - Reusable Tradeshift UI Components as Web Components https://tradeshift.github.io/elements

by Tradeshift

0.38.0 (see all)TypeScript:Built-In
npm i @tradeshift/elements.app-icon
Readme

Tradeshift

Elements - app-icon

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

NPM Version Downloads per month

table { width:100%; }

➤ Properties

PropertyAttributeTypeDefaultDescription
sizesizeStringSize of the app icon, available variants: ''(default), 'large'
srcsrcStringSpecifies the URL of an image
altaltStringSpecifies an alternate text for an image

➤ How to use it

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

or

<script src="node_modules/@tradeshift/elements.app-icon/lib/app-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 -->
<script>
    if (!window.Promise) {
        window.ShadyCSS = { nativeCss: true };
    }
</script>
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.

Downloads/wk

4

GitHub Stars

13

LAST COMMIT

3mos ago

MAINTAINERS

8

CONTRIBUTORS

18

OPEN ISSUES

29

OPEN PRs

1
VersionTagPublished
0.38.0
latest
2mos ago
No alternatives found
No tutorials found
Add a tutorial