Bring the power of AlpineJs to the HTML dialog
npm install @fylgja/alpinejs-dialog
Bring the power and simplicity of Alpine.js to the native HTML element.
Live Demo: https://alpinejs-dialog.netlify.app/
You can use this plugin by either installing it using NPM or including it from a CDN.
You can install it from NPM and include it in your bundle:
``bash`
npm install @fylgja/alpinejs-dialog
`js
import Alpine from 'alpinejs';
import dialog from '@fylgja/alpinejs-dialog';
window.Alpine = Alpine;
Alpine.plugin(dialog);
Alpine.start();
`
You can include the CDN version of this plugin as a
`
To utilize the x-htmldialog plugin, add the directive to an HTML
`html`
When the x-htmldialog directive is present on an x-show element:
- It prevents x-show from directly toggling the display style.el.showModal()
- Instead, it uses the native function to display the dialog.x-htmldialog
- The optional value provided to (e.g., "open = false") is executed
when the dialog is closed by pressing the Escape key or clicking outside the dialog (the backdrop).
The x-htmldialog directive supports modifiers to further customize its behavior.
#### noscroll
The noscroll modifier prevents scrolling on the background page while the dialog is open.
`html`
#### closeby
The closeby option gives you fine-grained control over how the dialog can be dismissed. The plugin polyfills this behavior for browsers that do not yet support it natively.
You can set this option in two ways:
1. As an attribute on the
`html`
2. As a modifier on the x-htmldialog directive:
`html`
#### Available Options
* any: The dialog can be closed by any user action, such as pressing the ESC key or clicking on the backdrop.closerequest
* : (Default) The dialog can be dismissed via the ESC key or a "close request" (e.g., a form submission with method="dialog"). It will not close when the backdrop is clicked.none`: The user cannot close the dialog. It must be closed programmatically.
*