├── .styleci.yml
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
├── basic.jpg
├── composer.json
├── config
└── config.php
├── extra-views.jpg
├── preview.gif
├── resources
└── views
│ ├── record-content.blade.php
│ ├── record.blade.php
│ ├── sortable.blade.php
│ ├── status-board.blade.php
│ ├── status-footer.blade.php
│ ├── status-header.blade.php
│ └── status.blade.php
├── src
├── LivewireStatusBoard.php
└── LivewireStatusBoardServiceProvider.php
└── styles.jpg
/.styleci.yml:
--------------------------------------------------------------------------------
1 | preset: laravel
2 |
3 | disabled:
4 | - single_class_element_per_statement
5 |
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # Changelog
2 |
3 | ## 2.1.0 - 2020-01-25
4 |
5 | - Added support for PHP 8
6 |
7 | ## 2.0.0 - 2020-10-14
8 |
9 | - Added Laravel 8 support
10 | - Added Livewire v2 support
11 | - Extracted $ghostClass as parameter for sortable options
12 | - Added $recordContentView for better customization
13 | - Added $recordClickEnabled flag to enable click events on rendered records
14 | - Removed jQuery dependency
15 |
16 | ## 1.0.0 - 2020-06-02
17 |
18 | - Initial Release
19 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contributing
2 |
3 | Contributions are **welcome** and will be fully **credited**.
4 |
5 | Please read and understand the contribution guide before creating an issue or pull request.
6 |
7 | ## Etiquette
8 |
9 | This project is open source, and as such, the maintainers give their free time to build and maintain the source code
10 | held within. They make the code freely available in the hope that it will be of use to other developers. It would be
11 | extremely unfair for them to suffer abuse or anger for their hard work.
12 |
13 | Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
14 | world that developers are civilized and selfless people.
15 |
16 | It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
17 | quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
18 |
19 | ## Viability
20 |
21 | When requesting or submitting new features, first consider whether it might be useful to others. Open
22 | source projects are used by many developers, who may have entirely different needs to your own. Think about
23 | whether or not your feature is likely to be used by other users of the project.
24 |
25 | ## Procedure
26 |
27 | Before filing an issue:
28 |
29 | - Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
30 | - Check to make sure your feature suggestion isn't already present within the project.
31 | - Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
32 | - Check the pull requests tab to ensure that the feature isn't already in progress.
33 |
34 | Before submitting a pull request:
35 |
36 | - Check the codebase to ensure that your feature doesn't already exist.
37 | - Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
38 |
39 | ## Requirements
40 |
41 | If the project maintainer has any additional requirements, you will find them listed here.
42 |
43 | - **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](https://pear.php.net/package/PHP_CodeSniffer).
44 |
45 | - **Add tests!** - Your patch won't be accepted if it doesn't have tests.
46 |
47 | - **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
48 |
49 | - **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.
50 |
51 | - **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
52 |
53 | - **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
54 |
55 | **Happy coding**!
56 |
--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) Andrés Santibáñez
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Livewire Status Board
2 |
3 | Livewire component to show records/data according to their current status
4 |
5 | ### Preview
6 |
7 | 
8 |
9 | ### Installation
10 |
11 | You can install the package via composer:
12 |
13 | ```bash
14 | composer require asantibanez/livewire-status-board
15 | ```
16 |
17 | ### Requirements
18 |
19 | This package uses `livewire/livewire` (https://laravel-livewire.com/) under the hood.
20 |
21 | It also uses TailwindCSS (https://tailwindcss.com/) for base styling.
22 |
23 | Please make sure you include both of this dependencies before using this component.
24 |
25 | ### Usage
26 |
27 | In order to use this component, you must create a new Livewire component that extends from
28 | `LivewireStatusBoard`
29 |
30 | You can use `make:livewire` to create a new component. For example.
31 | ``` bash
32 | php artisan make:livewire SalesOrdersStatusBoard
33 | ```
34 |
35 | In the `SalesOrdersStatusBoard` class, instead of extending from the base Livewire `Component` class,
36 | extend from `LivewireStatusBoard`. Also, remove the `render` method.
37 | You'll have a class similar to this snippet.
38 |
39 | ``` php
40 | class SalesOrdersStatusBoard extends LivewireStatusBoard
41 | {
42 | //
43 | }
44 | ```
45 |
46 | In this class, you must override the following methods to display data
47 | ```php
48 | public function statuses() : Collection
49 | {
50 | //
51 | }
52 |
53 | public function records() : Collection
54 | {
55 | //
56 | }
57 | ```
58 |
59 | As you may have noticed, both methods return a collection. `statuses()` refers to all the different status values
60 | your data may have in different points of time. `records()` on the other hand, stand for the data you want to show
61 | that could be in any of those previously defined `statuses()` collection.
62 |
63 | To show how these two methods work together, let's discuss an example of Sales Orders and their different status
64 | along the sales process: Registered, Awaiting Confirmation, Confirmed, Delivered. Each Sales Order might be in a different
65 | status at specific times. For this example, we might define the following collection for `statuses()`
66 |
67 | ```php
68 | public function statuses() : Collection
69 | {
70 | return collect([
71 | [
72 | 'id' => 'registered',
73 | 'title' => 'Registered',
74 | ],
75 | [
76 | 'id' => 'awaiting_confirmation',
77 | 'title' => 'Awaiting Confirmation',
78 | ],
79 | [
80 | 'id' => 'confirmed',
81 | 'title' => 'Confirmed',
82 | ],
83 | [
84 | 'id' => 'delivered',
85 | 'title' => 'Delivered',
86 | ],
87 | ]);
88 | }
89 | ```
90 |
91 | For each `status` we define, we must return an array with at least 2 keys: `id` and `title`.
92 |
93 | Now, for `records()` we may define a list of Sales Orders that come from an Eloquent model in our project
94 |
95 | ```php
96 | public function records() : Collection
97 | {
98 | return SalesOrder::query()
99 | ->map(function (SalesOrder $salesOrder) {
100 | return [
101 | 'id' => $salesOrder->id,
102 | 'title' => $salesOrder->client,
103 | 'status' => $salesOrder->status,
104 | ];
105 | });
106 | }
107 | ```
108 |
109 | As you might see in the above snippet, we must return a collection of array items where each item must have at least
110 | 3 keys: `id`, `title` and `status`. The last one is of most importance since it is going to be used to match to which
111 | `status` the `record` belongs to. For this matter, the component matches `status` and `records` with the following
112 | comparison
113 |
114 | ```php
115 | $status['id'] == $record['status'];
116 | ```
117 |
118 | To render the component in a view, just use the Livewire tag or include syntax
119 |
120 | ```blade
121 |
122 | ```
123 |
124 | Populate the Sales Order model and you should have something similar to the following screenshot
125 |
126 | 
127 |
128 | You can render any render and statuses of your project using this approach 👍
129 |
130 | ### Sorting and Dragging
131 |
132 | By default, sorting and dragging between statuses is disabled. To enable it, you must include the following
133 | props when using the view: `sortable` and `sortable-between-statuses`
134 |
135 | ```blade
136 |
140 | ```
141 |
142 | `sortable` enables sorting withing each status and `sortable-between-statuses` allow drag and drop from one status
143 | to the other. Adding these two properties, allow you to have drag and drop in place.
144 |
145 | You must also install the following JS dependencies in your project to enable sorting and dragging.
146 | ```bash
147 | npm install sortablejs
148 | ```
149 |
150 | Once installed, make them available globally in the window object. This can be done in the `bootstrap.js` file that
151 | ships with your Laravel app.
152 |
153 | ```javascript
154 | window.Sortable = require('sortablejs').default;
155 | ```
156 |
157 | ### Behavior and Interactions
158 |
159 | When sorting and dragging is enabled, your component can be notified when any of these events occur. The callbacks
160 | triggered by these two events are `onStatusSorted` and `onStatusChanged`
161 |
162 | On `onStatusSorted` you are notified about which `record` has changed position within it's `status`. You are also
163 | given a `$orderedIds` array which holds the ids of the `records` after being sorted. You must override the following
164 | method to get notified on this change.
165 |
166 | ```php
167 | public function onStatusSorted($recordId, $statusId, $orderedIds)
168 | {
169 | //
170 | }
171 | ```
172 |
173 | On `onStatusChanged` gets triggered when a `record` is moved to another `status`. In this scenario, you get notified
174 | about the `record` that was changed, the new `status`, the ordered ids from the previous status and the ordered ids
175 | of the new status the record in entering. To be notified about this event, you must override the following method:
176 |
177 | ```php
178 | public function onStatusChanged($recordId, $statusId, $fromOrderedIds, $toOrderedIds)
179 | {
180 | //
181 | }
182 | ```
183 |
184 | `onStatusSorted` and `onStatusChanged` are never triggered simultaneously. You'll get notified of one or the other
185 | when an interaction occurs.
186 |
187 | You can also get notified when a record in the status board is clicked via the `onRecordClick` event
188 |
189 | ```php
190 | public function onRecordClick($recordId)
191 | {
192 | //
193 | }
194 | ```
195 |
196 | To enable `onRecordClick` you must specify this behavior when rendering the component through the
197 | `record-click-enabled` parameter
198 |
199 | ```blade
200 |
203 | ```
204 |
205 | ### Styling
206 |
207 | To modify the look and feel of the component, you can override the `styles` method and modify the base styles returned
208 | by this method to the view. `styles()` returns a keyed array with Tailwind CSS classes used to render each one of the components.
209 | These base keys and styles are:
210 |
211 | ```php
212 | return [
213 | 'wrapper' => 'w-full h-full flex space-x-4 overflow-x-auto', // component wrapper
214 | 'statusWrapper' => 'h-full flex-1', // statuses wrapper
215 | 'status' => 'bg-blue-200 rounded px-2 flex flex-col h-full', // status column wrapper
216 | 'statusHeader' => 'p-2 text-sm text-gray-700', // status header
217 | 'statusFooter' => '', // status footer
218 | 'statusRecords' => 'space-y-2 p-2 flex-1 overflow-y-auto', // status records wrapper
219 | 'record' => 'shadow bg-white p-2 rounded border', // record wrapper
220 | 'recordContent' => '', // record content
221 | ];
222 | ```
223 |
224 | An example of overriding the `styles()` method can be seen below
225 |
226 | ```php
227 | public function styles()
228 | {
229 | $baseStyles = parent::styles();
230 |
231 | $baseStyles['wrapper'] = 'w-full flex space-x-4 overflow-x-auto bg-blue-500 px-4 py-8';
232 |
233 | $baseStyles['statusWrapper'] = 'flex-1';
234 |
235 | $baseStyles['status'] = 'bg-gray-200 rounded px-2 flex flex-col flex-1';
236 |
237 | $baseStyles['statusHeader'] = 'text-sm font-medium py-2 text-gray-700';
238 |
239 | $baseStyles['statusRecords'] = 'space-y-2 px-1 pt-2 pb-2';
240 |
241 | $baseStyles['record'] = 'shadow bg-white p-2 rounded border text-sm text-gray-800';
242 |
243 | return $baseStyles;
244 | }
245 | ```
246 |
247 | With these new styles, your component should look like the screenshot below
248 |
249 | 
250 |
251 | Looks like Trello, right? 😅
252 |
253 | ### Advanced Styling and Behavior
254 |
255 | Base views of the component can be customized as needed by exporting them to your project. To do this, run the
256 | `php artisan vendor:publish` command and export the `livewire-status-board-views` tag. The command will publish
257 | the base views under `/resources/views/vendor/livewire-status-board`. You can modify these base components as
258 | needed keeping in mind to maintain the `data` attributes and `ids` along the way.
259 |
260 | Another approach is copying the base view files into your own view files and pass them directly to your component
261 |
262 | ```blade
263 |
271 | ```
272 |
273 | Note: Using this approach also let's you add extra behavior to your component like click events on header, footers,
274 | such as filters or any other actions
275 |
276 | ### Adding Extra Views
277 |
278 | The component let's you add a view before and/or after the status board has been rendered. These two placeholders can
279 | be used to add extra functionality to your component like a search input or toolbar of actions. To use them, just pass
280 | along the views you want to use in the `before-status-board-view` and `after-status-board-view` props when displaying
281 | the component.
282 |
283 | ```blade
284 |
288 | ```
289 |
290 | Note: These views are optional.
291 |
292 | In the following example, a `before-status-board-view` has been specified to add a search text box and a button
293 |
294 | 
295 |
296 | ### Testing
297 |
298 | ``` bash
299 | composer test
300 | ```
301 |
302 | ### Changelog
303 |
304 | Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
305 |
306 | ## Contributing
307 |
308 | Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
309 |
310 | ### Security
311 |
312 | If you discover any security related issues, please email santibanez.andres@gmail.com instead of using the issue tracker.
313 |
314 | ## Credits
315 |
316 | - [Andrés Santibáñez](https://github.com/asantibanez)
317 | - [All Contributors](../../contributors)
318 |
319 | ## License
320 |
321 | The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
322 |
--------------------------------------------------------------------------------
/basic.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/asantibanez/livewire-status-board/b19664002279c7a2e6059917f418f88a48866a24/basic.jpg
--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "asantibanez/livewire-status-board",
3 | "description": "Livewire component to show models/data according to its current status",
4 | "keywords": [
5 | "asantibanez",
6 | "livewire-status-board"
7 | ],
8 | "homepage": "https://github.com/asantibanez/livewire-status-board",
9 | "license": "MIT",
10 | "type": "library",
11 | "authors": [
12 | {
13 | "name": "Andrés Santibáñez",
14 | "email": "santibanez.andres@gmail.com",
15 | "role": "Developer"
16 | }
17 | ],
18 | "require": {
19 | "php": "^7.2|^8.0|^8.1|^8.2|^8.3",
20 | "illuminate/support": "^7.0|^8.0|^9.0|^10.0|^11.0",
21 | "livewire/livewire": "^3.0"
22 | },
23 | "require-dev": {
24 | "orchestra/testbench": "^5.0|^6.0|^9.0",
25 | "phpunit/phpunit": "^8.0|^9.0|^10.0"
26 | },
27 | "autoload": {
28 | "psr-4": {
29 | "Asantibanez\\LivewireStatusBoard\\": "src"
30 | }
31 | },
32 | "autoload-dev": {
33 | "psr-4": {
34 | "Asantibanez\\LivewireStatusBoard\\Tests\\": "tests"
35 | }
36 | },
37 | "scripts": {
38 | "test": "vendor/bin/phpunit",
39 | "test-coverage": "vendor/bin/phpunit --coverage-html coverage"
40 |
41 | },
42 | "config": {
43 | "sort-packages": true
44 | },
45 | "extra": {
46 | "laravel": {
47 | "providers": [
48 | "Asantibanez\\LivewireStatusBoard\\LivewireStatusBoardServiceProvider"
49 | ],
50 | "aliases": {
51 | "LivewireStatusBoard": "Asantibanez\\LivewireStatusBoard\\LivewireStatusBoardFacade"
52 | }
53 | }
54 | }
55 | }
56 |
--------------------------------------------------------------------------------
/config/config.php:
--------------------------------------------------------------------------------
1 |
4 | {{ $record['title'] }}
5 |
6 |
--------------------------------------------------------------------------------
/resources/views/record.blade.php:
--------------------------------------------------------------------------------
1 |
2 | {{-- Injected variables $record, $styles --}}
3 |
9 |
10 | @include($recordContentView, [
11 | 'record' => $record,
12 | 'styles' => $styles,
13 | ])
14 |
15 |
16 |
--------------------------------------------------------------------------------
/resources/views/sortable.blade.php:
--------------------------------------------------------------------------------
1 |
2 | @script
3 |
46 | @endscript
47 |
48 |
--------------------------------------------------------------------------------
/resources/views/status-board.blade.php:
--------------------------------------------------------------------------------
1 |
2 |
3 | @includeIf($beforeStatusBoardView)
4 |
5 |
6 |
7 | @foreach($statuses as $status)
8 | @include($statusView, [
9 | 'status' => $status
10 | ])
11 | @endforeach
12 |
13 |
14 |
15 | @includeIf($afterStatusBoardView)
16 |
17 |
18 |
19 | @includeWhen($sortable, 'livewire-status-board::sortable', [
20 | 'sortable' => $sortable,
21 | 'sortableBetweenStatuses' => $sortableBetweenStatuses,
22 | ])
23 |
24 |
4 |
5 |
6 | @include($statusHeaderView, [
7 | 'status' => $status
8 | ])
9 |
10 |
14 |
15 | @foreach($status['records'] as $record)
16 | @include($recordView, [
17 | 'record' => $record,
18 | ])
19 | @endforeach
20 |
21 |
22 |
23 | @include($statusFooterView, [
24 | 'status' => $status
25 | ])
26 |
27 |
28 |