Skip to content
elements.popover / 0.40.0

elements.popover 0.40.0

Install from the command line:
Learn more about npm packages
$ npm install @tradeshift/elements.popover@0.40.0
Install via package.json:
"@tradeshift/elements.popover": "0.40.0"

About this version

Elements - popover

Part of the reusable Tradeshift UI Components as Web Components. Demo

NPM Version Downloads per month

<style> table { width:100%; } </style>

➤ Properties

Property Attribute Type Default Description
opened opened Boolean false Is the popover visible or not
placement placement String Placement, relative to the anchor. Could be 'topLeft', 'topRight', 'bottomLeft', 'bottomRight'
header header String Text in the title
anchor anchor String Anchor element for relative positioning. If you need to position absolutely, leave this empty
positionLeft position-left String Left offset when popover is positioned absolutely. Use any valid css syntax for the 'left' property
positionTop position-top String Top offset when popover is positioned absolutely. Use any valid css syntax for the 'top' property

➤ Slots

Name Description
content Content in the main section of the popover
footer Content in the footer section of the popover, most of the time `ts-button-group`

➤ Events

Name Description Payload
popover-close Emitted when user press the close button in popover

➤ How to use it

  • Install the package of popover
$ npm i @tradeshift/elements.popover --save
  • Import the component
import '@tradeshift/elements.popover';

or

<script src="node_modules/@tradeshift/elements.popover/lib/popover.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:
  1. 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'));
  1. 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>
<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.

Details


Assets

  • elements.popover-0.40.0-npm.tgz

Download activity

  • Total downloads 2,012
  • Last 30 days 0
  • Last week 0
  • Today 0