@tradeshift/elements.search NPM

➤ Properties

Property	Attribute	Type	Default	Description
autofocus	autofocus	Boolean	false	Shoud the search be auto focused once page loaded
dir	dir	String	ltr	Direction 'rtl' or 'ltr'
focused	focused	Boolean	false	Set the focus on element
idleTime	idle-time	Number	300	timeout in ms for the 'idle' event
placeholder	placeholder	String	'Search...'	Message when an input is empty
value	value	String	''	The current value
translations	translations	Object		Translated messages for the user locale. @type {{ loading: string, no_items: string }}
hasDropdown	has-dropdown	Boolean	false	Should dropdown items be rendered or not
loading	loading	Boolean	false	Show loading spinner when waiting for drodwon items
dropdownItems	dropdown-items	Array	[]	Dropdown items to show when user clicks on search component
opened	opened	Boolean	false	INTERNAL Opens the dropdown

➤ Events

Name	Description	Payload
idle	Emitted when the user not change input value for a provided timeout	search input value
change	Emitted on every user's change in a search input or when user selects an item from the provided `dropdownItems`	search input value
search	Emitted when the user press the 'Enter' key	search input value

➤ How to use it

Install the package of search

$ npm i @tradeshift/elements.search --save

Import the component

import '@tradeshift/elements.search';

<script src="node_modules/@tradeshift/elements.search/lib/search.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:

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'));

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>

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.

@tradeshift/elements @tradeshift/elements.icon @tradeshift/elements.overlay @tradeshift/elements.select-menu

@everything-registry/sub-chunk-930

2 years ago

2 years ago

2 years ago

2 years ago