Skip to content

Commit

Permalink
readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
devsrv committed May 2, 2021
1 parent 12b01c6 commit 9c3c99f
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@

Turn Laravel Livewire Component into Modal.

<img src="https://staging.voyantcs.com/sourav/static/livewire-modal-sample.gif" width="520" />

## 🏷 Features
- Modal triggerred by javascript i.e. opens instantly without waiting for livewire network round trip to finish ( no laggy feeling )
- Skeleton loading indicator
Expand Down Expand Up @@ -58,7 +60,7 @@ php artisan vendor:publish --provider="devsrv\LivewireModal\LivewireModalService

## πŸ§ͺ Usage
#### <img src="https://laravel-livewire.com/favicon.ico" width="30" /> Create Livewire Component
No consideration required, create livewire component as usual. Use livewire's `mount` to handle parameters passed to the modal
No consideration required, create livewire component as usual. Use livewire's `mount` to handle passed parameters

#### πŸš€ Open Modal

Expand Down Expand Up @@ -104,7 +106,7 @@ $this->dispatchBrowserEvent('open-x-modal', ['title' => 'My Modal', 'modal' => '
> πŸ’‘ Modal size supports `sm` `lg` `xl` *// completely optional*
#### 🌈 Bonus
you are free to put content in livewire view file in any structure, but the package provides an blade component for bootstrap modal which you can use as:
you are free to put content in livewire view file in any structure, however the package provides an blade component for bootstrap modal which you can use as:

```html
<x-livewiremodal-modal>
Expand All @@ -120,9 +122,9 @@ you are free to put content in livewire view file in any structure, but the pack
</x-livewiremodal-modal>
```

##### ✌🏼 Two reason to use this component
##### ✌🏼 Two reasons to use this component

🟒 a pretty line progress loading indicator which appears when livewire loading state changes
🟒 a pretty line progress loading indicator which appears in the top when livewire loading state changes

🟒 alert notification message which can be triggered by:
```php
Expand Down

0 comments on commit 9c3c99f

Please sign in to comment.