Dialog

<gstock-dialog> | GstockDialog

Custom Width

Use the --width custom property to set the dialog’s width.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Close Open Dialog 
<gstock-dialog label="Dialog" class="dialog-width" style="--width: 50vw;">
  Lorem ipsum dolor sit amet, consectetur adipiscing elit.
  <gstock-button slot="footer" variant="plain">Close</gstock-button>
</gstock-dialog>

<gstock-button>Open Dialog</gstock-button>

<script type="module">
  const dialog = document.querySelector('.dialog-width');
  const openButton = dialog.nextElementSibling;
  const closeButton = dialog.querySelector('gstock-button[slot="footer"]');

  openButton.addEventListener('click', () => dialog.show());
  closeButton.addEventListener('click', () => dialog.hide());
</script>

Scrolling

By design, a dialog’s height will never exceed that of the viewport. As such, dialogs will not scroll with the page ensuring the header and footer are always accessible to the user.

Scroll down and give it a try! 👇

Close Open Dialog 
<gstock-dialog label="Dialog" class="dialog-scrolling">
  <div style="height: 150vh; border: dashed 2px var(--gstock-legacy-color-grayscale-200); padding: 0 1rem;">
    <p>Scroll down and give it a try! 👇</p>
  </div>
  <gstock-button slot="footer" variant="plain">Close</gstock-button>
</gstock-dialog>

<gstock-button>Open Dialog</gstock-button>

<script type="module">
  const dialog = document.querySelector('.dialog-scrolling');
  const openButton = dialog.nextElementSibling;
  const closeButton = dialog.querySelector('gstock-button[slot="footer"]');

  openButton.addEventListener('click', () => dialog.show());
  closeButton.addEventListener('click', () => dialog.hide());
</script>

Header Actions

The header shows a functional close button by default. You can use the header-actions slot to add additional icon buttons if needed.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Close Open Dialog 
<gstock-dialog label="Dialog" class="dialog-header-actions">
  <gstock-icon-button class="new-window" slot="header-actions" icon="link" variant="plain"></gstock-icon-button>
  Lorem ipsum dolor sit amet, consectetur adipiscing elit.
  <gstock-button slot="footer" variant="plain">Close</gstock-button>
</gstock-dialog>

<gstock-button>Open Dialog</gstock-button>

<script type="module">
  const dialog = document.querySelector('.dialog-header-actions');
  const openButton = dialog.nextElementSibling;
  const closeButton = dialog.querySelector('gstock-button[slot="footer"]');
  const newWindowButton = dialog.querySelector('.new-window');

  openButton.addEventListener('click', () => dialog.show());
  closeButton.addEventListener('click', () => dialog.hide());
  newWindowButton.addEventListener('click', () => window.open(location.href));
</script>

Preventing the Dialog from Closing

By default, dialogs will close when the user clicks the close button, clicks the overlay, or presses the Escape key. In most cases, the default behavior is the best behavior in terms of UX. However, there are situations where this may be undesirable, such as when data loss will occur.

To keep the dialog open in such cases, you can cancel the gstock-request-close-event event. When canceled, the dialog will remain open and pulse briefly to draw the user’s attention to it.

You can use event.detail.source to determine what triggered the request to close. This example prevents the dialog from closing when the overlay is clicked, but allows the close button or Escape to dismiss it.

This dialog will not close when you click on the overlay. Close Open Dialog 
<gstock-dialog label="Dialog" class="dialog-deny-close">
  This dialog will not close when you click on the overlay.
  <gstock-button slot="footer" variant="plain">Close</gstock-button>
</gstock-dialog>

<gstock-button>Open Dialog</gstock-button>

<script type="module">
  const dialog = document.querySelector('.dialog-deny-close');
  const openButton = dialog.nextElementSibling;
  const closeButton = dialog.querySelector('gstock-button[slot="footer"]');

  openButton.addEventListener('click', () => dialog.show());
  closeButton.addEventListener('click', () => dialog.hide());

  // Prevent the dialog from closing when the user clicks on the overlay
  dialog.addEventListener('gstock-request-close-event', event => {
    if (event.detail.source === 'overlay') {
      event.preventDefault();
    }
  });
</script>

Customizing Initial Focus

By default, the dialog’s panel will gain focus when opened. This allows a subsequent tab press to focus on the first tabbable element in the dialog. If you want a different element to have focus, add the autofocus attribute to it as shown below.

Close Open Dialog 
<gstock-dialog label="Dialog" class="dialog-focus">
  <gstock-input autofocus placeholder="I will have focus when the dialog is opened"></gstock-input>
  <gstock-button slot="footer" variant="plain">Close</gstock-button>
</gstock-dialog>

<gstock-button>Open Dialog</gstock-button>

<script type="module">
  const dialog = document.querySelector('.dialog-focus');
  const input = dialog.querySelector('gstock-input');
  const openButton = dialog.nextElementSibling;
  const closeButton = dialog.querySelector('gstock-button[slot="footer"]');

  openButton.addEventListener('click', () => dialog.show());
  closeButton.addEventListener('click', () => dialog.hide());
</script>