Part of the reusable webapp-suite UI Components as Web Components.
Demo
## ➤ Properties
| Property | Attribute | Type | Default | Description |
| --- | --- | --- | --- | --- |
| visible | data-visible | Boolean | false | Dialog can be toggled by add/removing this attribute |
| text | text | String | | Text content of the modal |
| icon | icon | String | | If you need a different icon that default ones, you can use one of Elements icon names |
| type | type | String | dialogTypes.INFO | `info`, `warning`, `danger` |
| translations | translations | Object | | can be used for customizing the buttons text and translations |
| focused | focused | String | 'cancel' | set the default focus on the button, either `accept` or `cancel` |
| primary | primary | String | | either `accept` or `cancel` can be used to change the button type, based on the dialog type, by default both are secondary |
| renderButtons | renderButtons | Boolean | false | INTERNAL |
## ➤ Slots
| Name | Description |
| --- | --- |
| content | If in rare cases you need to have more complex content than text property, you can override the text by using this slot |
| extra-buttons | To add more options to the dialog, between accept and cancel buttons |
## ➤ Events
| Name | Description | Payload |
| ------ | ---------------------------------------------- | ------- |
| accept | Emitted when the user choose the accept option | |
| cancel | Emitted when the user choose the cancel option | |
## ➤ How to use it
- Install the package of dialog
```shell
$ npm i @webapp-suite/elements.dialog --save
```
- Import the component
```js
import '@webapp-suite/elements.dialog';
```
or
```html
```
- Use it like [demo]("https://webapp-suite.github.io/elements/?path=/story/ts-dialog--default")
- Our components rely on having the `Open Sans` available, You can see the `font-weight` and `font-style` you need to load [here](https://github.com/webapp-suite/elements/blob/master/packages/core/src/fonts.css), or you can just load it from our package (for now)
```html
```
## ➤ Polyfills
For supporting IE11 you need to add couple of things
- Don't shim CSS Custom Properties in IE11
```html
```
##### You have two options for polyfills library:
1. Use [`@open-wc/polyfills-loader`](https://github.com/open-wc/open-wc/tree/master/packages/polyfills-loader)
- Installation
```shell
$ npm i @open-wc/polyfills-loader
```
- Load it
```js
import loadPolyfills from '@open-wc/polyfills-loader';
loadPolyfills().then(() => import('./my-app.js'));
```
2. Use [`@webcomponents/webcomponentsjs`](https://github.com/webcomponents/polyfills/tree/master/packages/webcomponentsjs)
- Installation
```hell
$ npm i @webcomponents/webcomponentsjs --save
```
- Enable ES5 class-less Custom Elements
```html
```
- Load appropriate polyfills and shims with [`@webcomponents/webcomponentsjs`](https://github.com/webcomponents/webcomponentsjs)
```html
```
## ➤ How to contribute
Thanks for your interest and help!
- First thing you need to do is read this [[Component Checklist](https://github.com/webapp-suite/elements/wiki/Component-checklist)] which contains lots of important information about what you need to consider when you are creating/changing components
##### [General info](https://github.com/webapp-suite/elements/wiki/Useful-materials-starter)
You can find some [links to useful materials](https://github.com/webapp-suite/elements/wiki/Useful-materials-starter) about what we are using and some tutorials and articles that can help you get started.
## ➤ [Polyfill Limitations](https://github.com/webapp-suite/elements/wiki/Polyfill-Limitations)
You can see a list of limitations that we should watch out for, [here](https://github.com/webapp-suite/elements/wiki/Polyfill-Limitations)
## ➤ License
- You can always create forks on GitHub, submit Issues and Pull Requests.
- You can only use webapp-suite Elements to make apps on a webapp-suite platform, e.g. webapp-suite.com.
- You can fix a bug until the bugfix is deployed by webapp-suite.
- You can host webapp-suite 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](https://github.com/webapp-suite/elements/blob/master/LICENSE.md).
---
_Source: https://npm.io/package/@webapp-suite/elements.dialog · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
