Merge pull request #3 from kirschbaum-development/dev

Add the meta field

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to `livewire-filters` will be documented in this file.
 
-## 0.1 - 202X-XX-XX
+## 0.2 - 2022-02-28
 
-- initial release
+- Added the `meta` field to `Filter` class
+
+## 0.1 - 2022-02-28
+
+- Initial release

README.md

@@ -198,6 +198,10 @@ If you would like to set the value of a filter, you can pass the value or an arr
 
 When defining a filter, you should use the `default` method to set the initial value of the filter. This will store the initial value on the object as well to help with determining the status of active filters as well as resetting the filter to its original state. Calling the `default` method without any arguments will return the initial value that you specified when you defined the filter.
 
+### `meta(array $values)`
+
+If you would like to set additional information on the filter to be used in the view file, you can pass an array of values into the `meta` method. Calling the `meta` method without any arguments will return the current array of meta information.
+
 ## Events
 
 ### `livewire-filters-reset`

src/Filter.php

@@ -8,7 +8,8 @@ public function __construct(
         public string $key,
         public ?array $options = [],
         public mixed $value = '',
-        public mixed $initialValue = ''
+        public mixed $initialValue = '',
+        public array $meta = []
     ) {
     }
 

src/FilterComponent.php

@@ -10,13 +10,16 @@ abstract class FilterComponent extends Component
 
     public string $key = '';
 
+    public array $meta = [];
+
     public array $options = [];
 
     public mixed $value;
 
     public function mount(Filter $filter): void
     {
         $this->key = $filter->key();
+        $this->meta = $filter->meta();
         $this->options = $filter->options();
         $this->value = $filter->value();