Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wire-elements/modal
Livewire component that provides you with a modal that supports multiple child modals while maintaining state.
https://github.com/wire-elements/modal
laravel livewire livewire-components
Last synced: 29 days ago
JSON representation
Livewire component that provides you with a modal that supports multiple child modals while maintaining state.
- Host: GitHub
- URL: https://github.com/wire-elements/modal
- Owner: wire-elements
- License: mit
- Created: 2021-03-30T17:54:40.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-09T09:05:27.000Z (4 months ago)
- Last Synced: 2024-08-05T03:01:31.977Z (3 months ago)
- Topics: laravel, livewire, livewire-components
- Language: PHP
- Homepage:
- Size: 548 KB
- Stars: 1,098
- Watchers: 19
- Forks: 129
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-livewire - Wire Elements Modal
README
## Livewire v3
This is the readme for Livewire v3. **If you are looking for the readme for Livewire v2 [click here](https://github.com/wire-elements/modal/tree/1.0.0).**
### Upgrading from v2
You can use the following command to automate the upgrade process:
```shell
php artisan livewire:upgrade --run-only wire-elements-modal-upgrade
```
Please review the changes and ensure they follow the new convention set by Livewire v3:
```blade
<-- Before -->
Show Users
Show Users
<-- Before -->
Edit User
Edit User
```
The old component name is being deprecated. Replace `@livewire('livewire-ui-modal')` with `@livewire('wire-elements-modal')`.
The config file has been renamed as well. If you've published the config in the past, you will have to do so again and make the necessary changes:
```shell
php artisan vendor:publish --tag=wire-elements-modal-config
```
After upgrading, make sure to clear your view cache:
```shell
php artisan view:clear
```
## About Wire Elements Modal
Wire Elements Modal is a Livewire component that provides you with a modal that supports multiple child modals while maintaining state.
## Installation
Click the image above to read a full article on using the Wire Elements modal package or follow the instructions below.
To get started, require the package via Composer:
```
composer require wire-elements/modal:^2.0
```
## Livewire directive
Add the Livewire directive `@livewire('wire-elements-modal')` directive to your template.
```html
@livewire('wire-elements-modal')
```
## TailwindCSS
The base modal is made with TailwindCSS. If you use a different CSS framework I recommend that you publish the modal template and change the markup to include the required classes for your CSS framework.
```shell
php artisan vendor:publish --tag=wire-elements-modal-views
```
## Creating a modal
You can run `php artisan make:livewire EditUser` to make the initial Livewire component. Open your component class and make sure it extends the `ModalComponent` class:
```php
Edit User
Edit User
Edit User
```
## Passing parameters
To open the `EditUser` modal for a specific user we can pass the user id:
```html
Edit User
Edit User
Edit User
Edit User
```
The parameters are injected into the modal component and the model will be automatically fetched from the database if the type is defined:
```php
user);
}
public function render()
{
return view('livewire.edit-user');
}
}
```
The parameters are also passed to the `mount` method on the modal component.
## Opening a child modal
From an existing modal you can use the exact same event and a child modal will be created:
```html
Delete User
```
## Closing a (child) modal
If for example a user clicks the 'Delete' button which will open a confirm dialog, you can cancel the deletion and return to the edit user modal by dispatching the `closeModal` event. This will open the previous modal. If there is no previous modal the entire modal component is closed and the state will be reset.
```html
No, do not delete
```
You can also close a modal from within your modal component class:
```php
user);
}
public function update()
{
Gate::authorize('update', $this->user);
$this->user->update($data);
$this->closeModal();
}
public function render()
{
return view('livewire.edit-user');
}
}
```
If you don't want to go to the previous modal but close the entire modal component you can use the `forceClose` method:
```php
public function update()
{
Gate::authorize('update', $this->user);
$this->user->update($data);
$this->forceClose()->closeModal();
}
```
Often you will want to update other Livewire components when changes have been made. For example, the user overview when a user is updated. You can use the `closeModalWithEvents` method to achieve this.
```php
public function update()
{
Gate::authorize('update', $this->user);
$this->user->update($data);
$this->closeModalWithEvents([
UserOverview::class => 'userModified',
]);
}
```
It's also possible to add parameters to your events:
```php
public function update()
{
$this->user->update($data);
$this->closeModalWithEvents([
UserOverview::class => ['userModified', [$this->user->id]],
]);
}
```
## Changing modal properties
You can change the width (default value '2xl') of the modal by overriding the static `modalMaxWidth` method in your modal component class:
```php
/**
* Supported: 'sm', 'md', 'lg', 'xl', '2xl', '3xl', '4xl', '5xl', '6xl', '7xl'
*/
public static function modalMaxWidth(): string
{
return 'xl';
}
```
By default, the modal will close when you hit the `escape` key. If you want to disable this behavior to, for example, prevent accidentally closing the modal you can overwrite the static `closeModalOnEscape` method and have it return `false`.
```php
public static function closeModalOnEscape(): bool
{
return false;
}
```
By default, the modal will close when you click outside the modal. If you want to disable this behavior to, for example, prevent accidentally closing the modal you can overwrite the static `closeModalOnClickAway` method and have it return `false`.
```php
public static function closeModalOnClickAway(): bool
{
return false;
}
```
By default, closing a modal by pressing the escape key will force close all modals. If you want to disable this behavior to, for example, allow pressing escape to show a previous modal, you can overwrite the static `closeModalOnEscapeIsForceful` method and have it return `false`.
```php
public static function closeModalOnEscapeIsForceful(): bool
{
return false;
}
```
When a modal is closed, you can optionally enable a `modalClosed` event to be fired. This event will be fired on a call to `closeModal`, when the escape button is pressed, or when you click outside the modal. The name of the closed component will be provided as a parameter;
```php
public static function dispatchCloseEvent(): bool
{
return true;
}
```
By default, when a child modal is closed, the closed components state is still available if the same modal component is opened again. If you would like to destroy the component when its closed you can override the static `destroyOnClose` method and have it return `true`. When a destroyed modal is opened again its state will be reset.
```php
public static function destroyOnClose(): bool
{
return true;
}
```
## Preventing closing the modal on Escape or on click away based on the modal state
When a modal is closed on Escape or click away, `closingModalOnEscape` and `closingModalOnClickAway` are issued. Handle these events to prevent closing a modal based on its state, for example, if there are uncommitted changes.
For example, if a modal has a `isDirty` property, it could have the following handler:
```
@script
$wire.on('closingModalOnEscape', data => {
if ($wire.isDirty && !confirm('{{ __('You have unsaved changes. Are you sure you want to close this dialog?') }}')) {
data.closing = false;
}
});
$wire.on('closingModalOnClickAway', data => {
if ($wire.isDirty && !confirm('{{ __('You have unsaved changes. Are you sure you want to close this dialog?') }}')) {
data.closing = false;
}
});
@endscript
```
## Skipping previous modals
In some cases you might want to skip previous modals. For example:
1. Team overview modal
2. -> Edit Team
3. -> Delete Team
In this case, when a team is deleted, you don't want to go back to step 2 but go back to the overview.
You can use the `skipPreviousModal` method to achieve this. By default it will skip the previous modal. If you want to skip more you can pass the number of modals to skip `skipPreviousModals(2)`.
```php
team = $team;
}
public function delete()
{
Gate::authorize('delete', $this->team);
$this->team->delete();
$this->skipPreviousModal()->closeModalWithEvents([
TeamOverview::class => 'teamDeleted'
]);
}
public function render()
{
return view('livewire.delete-team');
}
}
```
You can also optionally call the `destroySkippedModals()` method to destroy the skipped modals so if any are opened again their state will be reset
## Building Tailwind CSS for production
To purge the classes used by the package, add the following lines to your purge array in `tailwind.config.js`:
```js
'./vendor/wire-elements/modal/resources/views/*.blade.php',
'./storage/framework/views/*.php',
```
Because some classes are dynamically build you should add some classes to the purge safelist so your `tailwind.config.js` should look something like this:
```js
module.exports = {
purge: {
content: [
'./vendor/wire-elements/modal/resources/views/*.blade.php',
'./storage/framework/views/*.php',
'./resources/views/**/*.blade.php',
],
options: {
safelist: {
pattern: /max-w-(sm|md|lg|xl|2xl|3xl|4xl|5xl|6xl|7xl)/,
variants: ['sm', 'md', 'lg', 'xl', '2xl']
}
}
},
darkMode: false, // or 'media' or 'class'
theme: {
extend: {},
},
variants: {
extend: {},
},
plugins: [],
}
```
For TailwindCSS `3x`
```js
export default {
content: [
'./vendor/wire-elements/modal/resources/views/*.blade.php',
'./storage/framework/views/*.php',
'./resources/views/**/*.blade.php',
],
safelist: [
{
pattern: /max-w-(sm|md|lg|xl|2xl|3xl|4xl|5xl|6xl|7xl)/,
variants: ['sm', 'md', 'lg', 'xl', '2xl']
}
],
// other options
}
```
## Configuration
You can customize the Modal via the `wire-elements-modal.php` config file. This includes some additional options like including CSS if you don't use TailwindCSS for your application, as well as the default modal properties.
To publish the config run the vendor:publish command:
```shell
php artisan vendor:publish --tag=wire-elements-modal-config
```
```php
false,
/*
|--------------------------------------------------------------------------
| Include JS
|--------------------------------------------------------------------------
|
| Livewire UI will inject the required Javascript in your blade template.
| If you want to bundle the required Javascript you can set this to false
| and add `require('vendor/wire-elements/modal/resources/js/modal');`
| to your script bundler like webpack.
|
*/
'include_js' => true,
/*
|--------------------------------------------------------------------------
| Modal Component Defaults
|--------------------------------------------------------------------------
|
| Configure the default properties for a modal component.
|
| Supported modal_max_width
| 'sm', 'md', 'lg', 'xl', '2xl', '3xl', '4xl', '5xl', '6xl', '7xl'
*/
'component_defaults' => [
'modal_max_width' => '2xl',
'close_modal_on_click_away' => true,
'close_modal_on_escape' => true,
'close_modal_on_escape_is_forceful' => true,
'dispatch_close_event' => false,
'destroy_on_close' => false,
],
];
```
## Security
If you are new to Livewire I recommend to take a look at the [security details](https://laravel-livewire.com/docs/2.x/security). In short, it's **very important** to validate all information given Livewire stores this information on the client-side, or in other words, this data can be manipulated. Like shown in the examples above, use the `Gate` facade to authorize actions.
## Credits
- [Philo Hermans](https://github.com/philoNL)
- [All Contributors](../../contributors)
## License
WireElements is open-sourced software licensed under the [MIT license](LICENSE.md).
## Beautiful components crafted with Livewire
