Elements - select-menu
Part of the reusable Tradeshift UI Components as Web Components.
Demo
➤ Properties
| Property | Attribute | Type | Default | Description |
|---|
| dir | dir | String | ltr | Direction of the component 'rtl' or 'ltr'. |
| disabled | disabled | Boolean | false | Is component disabled or not. |
| items | items | Array | | List of available options. Item must have 'id' and 'title', it can also have an 'icon' which is the name of the icon |
| filteredItems | filtered-items | Array | | List of filtered options based on the select filter input value. items should be updated to always include all filtered items. |
| multiselect | multiselect | Boolean | false | Allow users to select several options or not. |
| noApplyButton | no-apply-button | Boolean | false | Do not show the apply button and directly emit select-menu-changed when the selection changes.
Only affects the behaviour when multiselect is enabled, for single selection this is the default behavior. |
| selected | selected | Array | [] | List of selected items' ids |
| translations | translations | Object | | Translated messages for the user locale |
| loading | loading | Boolean | false | Set component in loading state and render a spinner instead of list of items |
| caseSensitive | case-sensitive | Boolean | false | Make client side filtering case sensitive which by default is case-insensitive |
| dirty | dirty | Boolean | false | INTERNAL Does component has uncommited changes or not. |
| currentSelection | currentSelection | Array | [] | INTERNAL List of currently selected changes that user not commited yet. |
| filterValue | filterValue | String | '' | INTERNAL Latest input value that was used to filter. |
| showSelectedOnly | showSelectedOnly | Boolean | false | INTERNAL Filter to show only selected items. |
➤ Events
| Name | Description | Payload |
|---|
| select-menu-changed | Emitted when user applies the selected changes | |
➤ How to use it
- Install the package of selectMenu
$ npm i @tradeshift/elements.select-menu --save
import '@tradeshift/elements.select-menu';
or
<script src="node_modules/@tradeshift/elements.select-menu/lib/select-menu.umd.js"></script>
<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:
- Use
@open-wc/polyfills-loader
$ npm i @open-wc/polyfills-loader
import loadPolyfills from '@open-wc/polyfills-loader';
loadPolyfills().then(() => import('./my-app.js'));
- Use
@webcomponents/webcomponentsjs
$ 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
You can find some links to useful materials about what we are using and some tutorials and articles that can help you get started.
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.
