Elements - aside
Part of the reusable Tradeshift UI Components as Web Components. Demo
<style> table { width:100%; } </style>➤ Properties
Property | Attribute | Type | Default | Description |
---|---|---|---|---|
dir | dir | String | ltr | Direction of the component 'rtl' or 'ltr' |
title | data-title | String | '' | Aside header title |
visible | data-visible | Boolean | false | Show/hide aside |
busy | data-busy | String | If it exist as an attribute, the aside would show a spinner in it with the provided value of this attribute as the message of it | |
noCloseOnEscKey | no-close-on-esc-key | Boolean | false | Disable closing the aside with escape key |
hasFoot | hasFoot | Boolean | false | INTERNAL |
hasPlatformObject | hasPlatformObject | Boolean | false | INTERNAL |
➤ Slots
Name | Description |
---|---|
note | Use this slot name on the `ts-note` in the aside |
platform-object | The section between aside header and content that platform object should be shown with different background color |
main | Main content of the aside that doesn't fit into any other available slots |
footer | Footer content and action buttons goes. You should use the ts-button-group here. |
➤ Events
Name | Description | Payload |
---|---|---|
open | Emitted when the aside is about to be opened | |
close | Emitted when the aside is about to be closed | |
opened | Emitted when the aside has been opened | |
closed | Emitted when the aside has been closed |
➤ How to use it
- Install the package of aside
$ npm i @tradeshift/elements.aside --save
- Import the component
import '@tradeshift/elements.aside';
or
<script src="node_modules/@tradeshift/elements.aside/lib/aside.umd.js"></script>
-
Use it like demo
-
Our components rely on having the
Open Sans
available, You can see thefont-weight
andfont-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:
- 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.