0.40.2 • Published 2 years ago
@tradeshift/elements.tag v0.40.2
➤ Properties
| Property | Attribute | Type | Default | Description |
|---|---|---|---|---|
| dir | dir | String | ltr | Text direction: 'rtl' or 'ltr' |
| type | type | String | Type: success, warning, warning-lite, danger, blue, blue-lite. Affects background and foreground colors | |
| deletable | deletable | Boolean | false | Can the item be deleted? Displays a remove icon at the end of the tag |
| clickable | clickable | Boolean | false | Should the tag look like clicking it triggers an action? Adds a pointer cursor and hover effect |
| locked | locked | Boolean | false | Is the item locked? Displays a lock icon at the end of the tag |
| labels | labels | Array | Array of labels or 'keys' | |
| values | values | Array | Array of values | |
| busy | busy | Boolean | false | Show busy/loading animation |
➤ Events
| Name | Description | Payload |
|---|---|---|
| delete-tag | Emitted when the delete icon is clicked, if the tag is not busy | event |
| click-tag | Emitted when the tag is clicked | event |
➤ How to use it
- Install the package of tag
$ npm i @tradeshift/elements.tag --save- Import the component
import '@tradeshift/elements.tag';or
<script src="node_modules/@tradeshift/elements.tag/lib/tag.umd.js"></script>Use it like demo
Our components rely on having the
Open Sansavailable, You can see thefont-weightandfont-styleyou 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:
- Installation
$ npm i @open-wc/polyfills-loader- Load it
import loadPolyfills from '@open-wc/polyfills-loader';
loadPolyfills().then(() => import('./my-app.js'));- Installation
$ npm i @webcomponents/webcomponentsjs --save- Enable ES5 class-less Custom Elements
<script src="/node_modules/@webcomponents/webcomponentsjs/custom-elements-es5-adapter.js"></script>- Load appropriate polyfills and shims with
@webcomponents/webcomponentsjs
<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.