feat(dialog): polyfilled property to set implementation type (#633)

Co-authored-by: Enes Yıldırım <enes.yildirim@trendyol.com>

src/components/dialog/bl-dialog.stories.ts

@@ -23,6 +23,9 @@ const meta: Meta = {
  open: {
  control: "boolean",
  },
+ polyfilled: {
+ control: "boolean",
+ },
  caption: {
  control: "text"
  },
@@ -39,6 +42,7 @@ interface DialogArgs {
  className?: string;
  caption?: string;
  open?: boolean;
+ polyfilled?: boolean;
  content?: string;
  primaryAction?: string;
  secondaryAction?: string;
@@ -62,7 +66,8 @@ const BasicTemplate = (args: DialogArgs) => html`
  id=${args.id}
  class="${ifDefined(args.className)}"
  caption="${ifDefined(args.caption)}"
- ?open="${args.open}">
+ ?open="${args.open}"
+ ?polyfilled="${args.polyfilled}">
  ${
  unsafeHTML(args.content)
  }${

src/components/dialog/bl-dialog.test.ts

@@ -351,7 +351,7 @@ describe('bl-dialog', () => {
 
  const closeBtn = el?.shadowRoot?.querySelector('bl-button');
 
- el.addEventListener('bl-dialog-request-close', (ev) => {
+ el.addEventListener('bl-dialog-request-close', ev => {
  ev.preventDefault();
  });
 
@@ -361,7 +361,7 @@ describe('bl-dialog', () => {
 
  await oneEvent(el, 'bl-dialog-request-close');
 
- expect(el.open).to.be.true
+ expect(el.open).to.be.true;
  });
  });
  });

src/components/dialog/bl-dialog.ts

@@ -23,13 +23,17 @@ export default class BlDialog extends LitElement {
  /**
  * Sets dialog open-close status
  */
- @property({ type: Boolean, reflect: true, hasChanged(newVal: boolean, oldVal: boolean | undefined) {
- if (newVal === false && oldVal === undefined) {
- // Assume that the initial value is false
- return false;
- }
- return newVal !== oldVal;
- } })
+ @property({
+ type: Boolean,
+ reflect: true,
+ hasChanged(newVal: boolean, oldVal: boolean | undefined) {
+ if (newVal === false && oldVal === undefined) {
+ // Assume that the initial value is false
+ return false;
+ }
+ return newVal !== oldVal;
+ },
+ })
  open = false;
 
  /**
@@ -38,6 +42,16 @@ export default class BlDialog extends LitElement {
  @property({ type: String })
  caption?: string;
 
+ /**
+ * Determines if dialog currently uses polyfilled version instead of native HTML Dialog. By
+ * default, it uses native Dialog if the browser supports it, otherwise polyfills. You can force
+ * using polyfill by setting this to true in some cases like to show some content on top of dialog
+ * in case you are not able to use Popover API. Be aware that, polyfilled version can cause some
+ * inconsistencies in terms of accessibility and stacking context. So use it with extra caution.
+ */
+ @property({ type: Boolean, reflect: true })
+ polyfilled = !window.HTMLDialogElement;
+
  @query('.dialog')
  private dialog: HTMLDialogElement & DialogElement;
 
@@ -59,23 +73,21 @@ export default class BlDialog extends LitElement {
  * Fires before the dialog is closed with internal actions like clicking close button,
  * pressing Escape key or clicking backdrop. Can be prevented by calling `event.preventDefault()`
  */
- @event('bl-dialog-request-close') private onRequestClose: EventDispatcher<{ source: 'close-button' | 'keyboard' | 'backdrop' }>;
+ @event('bl-dialog-request-close') private onRequestClose: EventDispatcher<{
+ source: 'close-button' | 'keyboard' | 'backdrop';
+ }>;
 
  /**
  * Fires when the dialog is closed
  */
  @event('bl-dialog-close') private onClose: EventDispatcher<object>;
 
  updated(changedProperties: PropertyValues<this>) {
- if (changedProperties.has('open')) {
+ if (changedProperties.has('open') || changedProperties.has('polyfilled')) {
  this.toggleDialogHandler();
  }
  }
 
- private get hasHtmlDialogSupport() {
- return !!window.HTMLDialogElement;
- }
-
  private get _hasFooter() {
  return [...this.childNodes].some(node => node.nodeName === 'BL-BUTTON');
  }
@@ -144,7 +156,7 @@ export default class BlDialog extends LitElement {
  const title = this.caption ? html`<h2 id="dialog-caption">${this.caption}</h2>` : '';
 
  const classes = {
- container: true,
+ 'container': true,
  'has-footer': this._hasFooter,
  };
 
@@ -164,24 +176,24 @@ export default class BlDialog extends LitElement {
  }
 
  render(): TemplateResult {
- return this.hasHtmlDialogSupport
- ? html`
+ return this.polyfilled
+ ? html`<div
+ class="dialog-polyfill"
+ role="dialog"
+ aria-labelledby="dialog-caption"
+ @click=${this.clickOutsideHandler}
+ >
+ ${this.renderContainer()}
+ </div>`
+ : html`
  <dialog
  class="dialog"
  aria-labelledby="dialog-caption"
  @click=${this.clickOutsideHandler}
  >
  ${this.renderContainer()}
  </dialog>
- `
- : html`<div
- class="dialog-polyfill"
- role="dialog"
- aria-labelledby="dialog-caption"
- @click=${this.clickOutsideHandler}
- >
- ${this.renderContainer()}
- </div>`;
+ `;
  }
 }