Socket
Book a DemoInstallSign in
Socket

@tradeshift/elements.confirmation-prompt

Package Overview
Dependencies
Maintainers
8
Versions
28
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@tradeshift/elements.confirmation-prompt

latest
Source
npmnpm
Version
0.40.2
Version published
Maintainers
8
Created
Source

Tradeshift

Elements - confirmation-prompt

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

NPM Version Downloads per month

table { width:100%; }

➤ Properties

PropertyAttributeTypeDefaultDescription
visibledata-visibleBooleanfalseDialog can be toggled by add/removing this attribute
headerdata-headerStringHeader of the modal
titledata-titleStringTitle on top of the text part
texttextStringText content of the modal
textFieldLabeltext-field-labelStringLabel of the text field component
textFieldPlaceholdertext-field-placeholderStringPlaceholder of the text field component
helpTextMessageshelp-text-messagesArrayArray of messages to pass to help-text component. See help-text component for more info
helpTextTitlehelp-text-titleStringIf you have more than one help text message, you should pass a title to it. See help-text component for more info
translationstranslationsObjectCan be used for customizing the buttons text and providing translations for them
textToMatchtext-to-matchStringText that the user need to type for confirmation
matchedmatchedBooleanfalseINTERNAL

➤ Slots

NameDescription
titleIf in rare cases you need to have more complex title than text property, you can override the title by using this slot
contentIf in rare cases you need to have more complex content than text property, you can override the text by using this slot

➤ Events

NameDescriptionPayload
acceptEmitted when the user choose the accept option
cancelEmitted when the user choose the cancel option
closeEmitted when the user dismiss the modal, includes cancel button click, close button click, backdrop cover click

➤ How to use it

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

or

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

FAQs

Package last updated on 03 Nov 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts