@tradeshift/elements.note
npm i @tradeshift/elements.note
Tradeshift Elements - Reusable Tradeshift UI Components as Web Components https://tradeshift.github.io/elements
npm i @tradeshift/elements.note
Elements - note
Part of the reusable Tradeshift UI Components as Web Components. Demo
➤ Properties
| Property | Attribute | Type | Default | Description |
|---|---|---|---|---|
| icon | icon | String | ||
| type | type | String | ||
| dir | dir | String | ltr | |
| closeable | closeable | Boolean | false | |
| hidden | hidden | Boolean | false | |
| buttons | buttons | Array |
➤ Slots
| Name | Description |
|---|---|
| default |
➤ Events
| Name | Description |
|---|---|
| close | |
| button-click |
➤ How to use it
- Install the package of note
$ npm i @tradeshift/elements.note --save
- Import the component
import '@tradeshift/elements.note';
or
<script src="node_modules/@tradeshift/elements.note/lib/note.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.
Downloads/wk
82GitHub Stars
13LAST COMMIT
3mos ago
MAINTAINERS
8
CONTRIBUTORS
18
OPEN ISSUES
29
OPEN PRs
1
| Version | Tag | Published |
|---|---|---|
0.38.0 | latest | 2mos ago |
No alternatives found
No tutorials found
Add a tutorialMenu