Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

appendix for #39 and #37 - fix cascading livewire select multiple inputs nulled after repainting #40

Open
wants to merge 16 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ php:
- 7.1
- 7.2
- 7.3
- 8.0

env:
matrix:
Expand Down
49 changes: 47 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,47 @@ Livewire component for dependant and/or searchable select inputs

![preview](https://github.com/asantibanez/livewire-select/raw/master/preview.gif)

### Installation
### Installation & Basic Usage

#### Installing Livewire Select

You can install the package via composer:

```bash
composer require asantibanez/livewire-select
```

#### Including assets

Add the following Blade directives in the head tag, and before the end body tag in your template

```blade
...
@livewireSelectStyles
</head>
<body>
...

@livewireSelectScripts
</body>
</html>
```

Livewire Select includes a set up using different parts of the TALL stack assets like the [Laravel livewire](https://laravel-livewire.com/), [Alpine.js](https://alpinejs.dev/) and [Tailwindcss](https://tailwindcss.com/) styles and scripts.
After adding these directives you may need to clear the view cache.

```bash
php artisan view:clear
```

These directives are fine for a dev environment, however, if you want to use your own livewire, Tailwindcss or Alpine.js setup, you can disable these assets from being loaded with the Laravel views directive.

You can define which assets are included by setting the option parameter in the directive:

```blade
@livewireSelectScripts(livewire-select, livewire-select-multiple)
```

### Requirements

This package uses `livewire/livewire` (https://laravel-livewire.com/) under the hood.
Expand Down Expand Up @@ -179,7 +212,7 @@ You can define the `searchable` attribute on the component to change the behavio
inputs. With `:searchable="true"` your component will change its behavior to allow searching
the options returned in the `options()` method.

```blade
```blade
<livewire:car-model-select
name="car_model_id"
placeholder="Choose a Car Model"
Expand All @@ -191,6 +224,18 @@ Your input will look something like this

![preview](https://github.com/asantibanez/livewire-select/raw/master/searchable.gif)

### Multi-select inputs

You can define the `multiple` attribute on the component to turn the input into a multi-select dropdown using `:multiple="true"`

```blade
<livewire:car-model-select
name="car_model_id"
placeholder="Choose a Car Model"
:multiple="true"
/>
```

To filter the options in the dropdown, you can use the `$searchTerm` parameter in the
`options()` method.

Expand Down
5 changes: 4 additions & 1 deletion resources/views/default.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@ class="{{ $styles['default'] }}"
</option>

@foreach($options as $option)
<option value="{{ $option['value'] }}">
<option
value="{{ $option['value'] }}"
{!! (json_decode($initValueEncoded) && $option['value'] == json_decode($initValueEncoded)) ? 'selected' : '' !!}
>
{{ $option['description'] }}
</option>
@endforeach
Expand Down
103 changes: 103 additions & 0 deletions resources/views/multiple.blade.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
<div
wire:model="value"
x-data="livewireSelectMultiSelectDropdown($el)"
x-init="loadOptions($el.querySelector('.livewire-select-input'))"
@livewireselectoptionsloaded="loadOptions($el.querySelector('.livewire-select-input'));"
>
<select
x-cloak
x-show="false"
name="{{ $name }}"
class="livewire-select-input"
x-bind:value="selectedValues()"
multiple="true"
>
<option value="">
{{ $placeholder }}
</option>
@foreach($options as $option)
<option
value="{{ $option['value'] }}"
{{ (json_decode($initValueEncoded) && in_array($option['value'], json_decode($initValueEncoded))) ? 'selected="selected"' : '' }}
>
{{ $option['description'] }}
</option>
@endforeach
</select>

<div
class="w-full flex flex-col items-center"
>
<div class="w-full block relative">
<div class="flex flex-col items-center relative">
<div @click="open" class="w-full">
<div class="p-1 flex border border-gray-200 bg-white rounded">
<div class="flex flex-auto flex-wrap">
<template x-for="(option,index) in selected" :key="option">
<div class="flex justify-center items-center m-1 font-medium py-1 px-1 bg-white rounded bg-gray-100 border">
<div class="text-xs font-normal leading-none max-w-full flex-initial" x-model="options[option]" x-text="options[option].text"></div>
<div class="flex flex-auto flex-row-reverse">
<div @click.stop="remove(index,option); $dispatch('input', selectedValues())">
<svg class="fill-current h-4 w-4 " role="button" viewBox="0 0 20 20">
<path d="M14.348,14.849c-0.469,0.469-1.229,0.469-1.697,0L10,11.819l-2.651,3.029c-0.469,0.469-1.229,0.469-1.697,0
c-0.469-0.469-0.469-1.229,0-1.697l2.758-3.15L5.651,6.849c-0.469-0.469-0.469-1.228,0-1.697s1.228-0.469,1.697,0L10,8.183
l2.651-3.031c0.469-0.469,1.228-0.469,1.697,0s0.469,1.229,0,1.697l-2.758,3.152l2.758,3.15
C14.817,13.62,14.817,14.38,14.348,14.849z" />
</svg>

</div>
</div>
</div>
</template>
<div x-show="selected.length == 0" class="flex-1">
<input placeholder="Select a option" class="bg-transparent p-1 px-2 appearance-none outline-none h-full w-full text-gray-800">
</div>
</div>
<div class="text-gray-300 w-8 py-1 pl-2 pr-1 border-l flex items-center border-gray-200">

<button type="button" x-show="isOpen() === true" @click="open" class="cursor-pointer w-6 h-6 text-gray-600 outline-none focus:outline-none">
<svg version="1.1" class="fill-current h-4 w-4" viewBox="0 0 20 20">
<path d="M17.418,6.109c0.272-0.268,0.709-0.268,0.979,0s0.271,0.701,0,0.969l-7.908,7.83
c-0.27,0.268-0.707,0.268-0.979,0l-7.908-7.83c-0.27-0.268-0.27-0.701,0-0.969c0.271-0.268,0.709-0.268,0.979,0L10,13.25
L17.418,6.109z" />
</svg>

</button>
<button type="button" x-show="isOpen() === false" @click="close" class="cursor-pointer w-6 h-6 text-gray-600 outline-none focus:outline-none">
<svg class="fill-current h-4 w-4" viewBox="0 0 20 20">
<path d="M2.582,13.891c-0.272,0.268-0.709,0.268-0.979,0s-0.271-0.701,0-0.969l7.908-7.83
c0.27-0.268,0.707-0.268,0.979,0l7.908,7.83c0.27,0.268,0.27,0.701,0,0.969c-0.271,0.268-0.709,0.268-0.978,0L10,6.75L2.582,13.891z
" />
</svg>

</button>
</div>
</div>
</div>
<div class="w-full px-4">
<div x-show.transition.origin.top="isOpen()" class="absolute shadow top-100 bg-white z-40 w-full left-0 rounded" @click.away="close">
<div class="bg-white flex flex-col w-full overflow-y-auto h-64">
<template x-for="(option, index) in options" :key="index" class="overflow-auto">
<div class="cursor-pointer w-full border-gray-100 rounded-t border-b hover:bg-gray-100" @click="if (option.value) { select(index,$event); $dispatch('input', selectedValues()) }">
<div class="flex w-full items-center p-2 pl-2 border-transparent border-l-2 relative">
<div class="w-full items-center flex justify-between">
<div class="mx-2 leading-6" x-model="option" x-text="option.text"></div>
<div x-show="option.selected">
<svg class="fill-current w-4 h-4" viewBox="0 0 20 20">
<path d="M7.197,16.963H7.195c-0.204,0-0.399-0.083-0.544-0.227l-6.039-6.082c-0.3-0.302-0.297-0.788,0.003-1.087
C0.919,9.266,1.404,9.269,1.702,9.57l5.495,5.536L18.221,4.083c0.301-0.301,0.787-0.301,1.087,0c0.301,0.3,0.301,0.787,0,1.087
L7.741,16.738C7.596,16.882,7.401,16.963,7.197,16.963z"></path>
</svg>
</div>
</div>
</div>
</div>
</template>
</div>
</div>
</div>
</div>
</div>
</div>

</div>
23 changes: 16 additions & 7 deletions resources/views/select.blade.php
Original file line number Diff line number Diff line change
@@ -1,13 +1,22 @@
<div>

<div>
<div x-init="$wire.set('value', {{ $initValueEncoded }})">
@if(!$searchable && $shouldShow)
@include($defaultView, [
'name' => $name,
'options' => $options,
'placeholder' => $placeholder,
'styles' => $styles,
])
@if(!$multiple)
@include($defaultView, [
'name' => $name,
'options' => $options,
'placeholder' => $placeholder,
'styles' => $styles,
])
@else
@include($multipleView, [
'name' => $name,
'options' => $options,
'placeholder' => $placeholder,
'styles' => $styles,
])
@endif
@endif
</div>

Expand Down
Loading