Merge pull request #64 from Gustavinho/release/2.1.0

Release/2.1.0

Author: Gustavinho

.github/workflows/laravel.yml ._github/workflows/laravel.yml.github/workflows/laravel.yml renamed to ._github/workflows/laravel.yml

@@ -1,42 +1,46 @@
-anguage: php
+language: php
+
+php:
+  - 7.2
+  - 7.3
+  - 7.4
 
 env:
+  jobs:
+    - LARAVEL=7.0.* TESTBENCH=5.*
+    - LARAVEL=8.0.* TESTBENCH=6.*
   global:
     - DB_CONNECTION=sqlite
     - DB_DATABASE=":memory:"
     - APP_ENV=testing
-  matrix:
-    - LARAVEL='5.5.*' TESTBENCH='3.5.*'
-    - LARAVEL='5.6.*' TESTBENCH='3.6.*'
-    - LARAVEL='5.7.*' TESTBENCH='3.7.*'
-    - LARAVEL='5.8.*' TESTBENCH='3.8.*'
-    - LARAVEL='6.*' TESTBENCH='4.*'
-    - LARAVEL='7.*' TESTBENCH='5.*'
-    - LARAVEL='8.*' TESTBENCH='6.*'
-
-php:
-  - 7.2
-  - 7.3
 
 matrix:
   fast_finish: true
+  exclude:
+    - php: 7.2
+      env: LARAVEL=8.0.* TESTBENCH=6.*
 
 branches:
   only:
   - master
   - dev
   - /^release-.*$/
+  - /^release/.*$/
 
 before_script:
   - composer config discard-changes true
-  - mkdir vendor/orchestra/testbench-core/laravel/app/Http
   - mkdir vendor/orchestra/testbench-core/laravel/app/Http/Livewire
+
 before_install:
   - travis_retry composer self-update
-  - travis_retry composer require "laravel/framework:${LARAVEL}" "orchestra/testbench:${TESTBENCH}" --no-interaction --no-update --dev
+  - rm -rf composer.lock
+  - travis_retry composer require "laravel/framework:${LARAVEL}" "orchestra/testbench:${TESTBENCH}" --no-update
+  - if [ "$LARAVEL" = "8.0.*" ]; then composer require "laravel/legacy-factories" --no-update; fi;
   - cat composer.json
+
 install:
-  - travis_retry composer install --prefer-dist --no-interaction --no-suggest
+  - travis_retry composer install --prefer-dist --no-interaction --no-dev --ignore-platform-reqs
+
 script:
   - phpunit --testdox
 

.travis.yml

@@ -1,5 +1,17 @@
 # Changelog
 
+## [2.1] - 2021-01-10
+### Added
+- Option to customize which assets will be imported
+- The current view instance is passed as a param to the action to be executed
+
+### Changed
+- The filter button was changed by an icon button
+- Updated documentation
+  - Added how to purge `laravel-views` styles
+  - Added how to render components using `Livewire`
+
+
 ## [2.0] - 2020-09-13
 ### Added
 - Added compatibility for Laravel Livewire 2.x

CHANGELOG.md

@@ -1,5 +1,7 @@
 # Laravel views
 
+[See live example](http://laravel-views.herokuapp.com)
+
 Laravel package to create beautiful common views like tables using only PHP code, inspired by [Laravel Nova](https://nova.laravel.com/), these views are built with [Laravel Livewire](https://laravel-livewire.com/) and styled using [Tailwind CSS](https://tailwindcss.com/)
 
 ## Table View example
@@ -8,20 +10,16 @@ Laravel package to create beautiful common views like tables using only PHP code
 
 - [Version compatibility](#version-compatibility)
 - [Installation and basic usage](#installation-and-basic-usage)
-    - [Installing laravel views](#installing-laravel-views)
-    - [Publishing assets](#publishing-assets)
-    - [Including assets](#including-assets)
+  - [Installing laravel views](#installing-laravel-views)
+  - [Publishing assets](#publishing-assets)
+  - [Including assets](#including-assets)
 - [First table view](#first-table-view)
-    - [Rendering the table view](#rendering-the-table-view)
+  - [Rendering the table view](#rendering-the-table-view)
 - [Rendering a view](#rendering-a-view)
-    - [From a controller](#from-a-controller)
-    - [Specifying a layout and section](#specifying-a-layout-and-section)
-    - [Send extra data](send-extra-data)
-- [Components customization](#components-customization)
-    - [Component variants using tailwindcss](#component-variants-using-tailwindcss)
-    - [Components full customization](#components-full-customization)
-- [Table view](doc/table-view.md)
-- [Grid view](doc/grid-view.md)
+- [Advanced usage](doc/laravel-views.md)
+- [Views available](#views-available)
+  - [Table view](#table-view)
+  - [Grid view](#grid-view)
 - [Contributing](#contributing)
 - [Roadmap](#roadmap)
 
@@ -40,15 +38,9 @@ composer require laravel-views/laravel-views
 
 ## Publishing assets
 ```bash
-php artisan vendor:publish --tag=public --force
-```
-or you can specify the provider
-```bash
 php artisan vendor:publish --tag=public --provider='LaravelViews\LaravelViewsServiceProvider' --force
 ```
 
-If you are updating this package you might need to republish these assets.
-
 ## Including assets
 Add the following Blade directives in the *head* tag, and before the end *body* tag in your template
 
@@ -65,10 +57,11 @@ Add the following Blade directives in the *head* tag, and before the end *body*
 </html>
 ```
 
-These blade directives are also including [Laravel livewire](https://laravel-livewire.com/) styles and scripts, after that you may need to clear the view cache
+These blade directives are also including [Laravel livewire](https://laravel-livewire.com/) and [Tailwindcss](https://tailwindcss.com/) styles and scripts, after that you may need to clear the view cache
 ```bash
 php artisan view:clear
 ```
+If you are already using your own Tailwindcss setup you can set `laravel-views` to not importing Tailwindcss by default. ([Importing assets](./doc/laravel-views#including-assets))
 
 # First table view
 This is a basic usage of a table view, you can [read the full table view documentation ](doc/table-view.md)
@@ -78,7 +71,7 @@ Once you have installed the package and included the assets you can start to cre
 ```bash
 php artisan make:table-view UsersTableView
 ```
-With this artisan command a UsersTableView.php file will be created inside `app/Http/Livewire` directory.
+With this artisan command a UsersTableView.php file will be created inside the `app/Http/Livewire` directory.
 
 The basic usage needs a data repository (Eloquent query), headers and rows, you can customize the items to be shown, and the headers and data for each row like this example
 ```php
@@ -99,20 +92,36 @@ class UsersTableView extends TableView
 
     public function headers(): array
     {
-        return ['Name', 'Email', 'Created', 'Updated'];
+        return [
+            'Name',
+            'Email',
+            'Created',
+            'Updated'
+        ];
     }
 
     public function row($model)
     {
-        return [$model->name, $model->email, $model->created_at, $model->updated_at];
+        return [
+            $model->name,
+            $model->email,
+            $model->created_at,
+            $model->updated_at
+        ];
     }
 }
 ```
 
 ## Rendering the table view
-The easiest way to render the view is using the facade directly with a blade file
+You can render this view in the same way as you would do it for a livewire component ([Rendering components](https://laravel-livewire.com/docs/2.x/rendering-components)).
+The easiest way to render the view is using the livewire tag syntax:
 ```blade
-{!! LaravelViews::create(App\Http\Livewire\UsersTableView::class)->render() !!}
+<livewire:users-table-view />
+```
+
+You could also use the `@livewire` blade directive.
+```blade
+@livewire('users-table-view')
 ```
 
 At this point, you would be able to see a table with some data, the table view doesn't have any styled container or title as the image example, you can render the table view inside any container you want.
@@ -123,89 +132,22 @@ This is the basic usage of the table view, but you can customize it with more fe
 
 [Read the full table view documentation ](doc/table-view.md)
 
-# Rendering a view
+## Advanced usage
 
-## From a controller
+[Read the advanced laravel-views documentation ](doc/laravel-views.md)
 
-The easiest way to render a view is using the facade directly on the blade file as the example above,
-but it is a better practice if you inject a `LaravelViews` instance as a dependency in your controller.
+## Views available
+### [Table view](doc/table-view.md)
 
-```php
-use use LaravelViews\LaravelViews;
+Dynamic data table with some features like filters, pagination and search input, you can customize the headers, the data to be displayed for each row
 
-public function index(LaravelViews $laravelViews)
-{
-    $laravelViews->create(App\Http\Livewire\UsersTableView::class);
+![](doc/table.png)
 
-    return view('my-view', [
-      'view' => $laravelViews
-    ]);
-}
-```
-And render it in your blade file
-```blade
-{!! $view->render() !!}
-```
-
-## Specifying a layout and section
-You can also return the view directly from your controller and specify the layout and section of your layout
-```php
-use use LaravelViews\LaravelViews;
-
-public function index(LaravelViews $laravelViews)
-{
-    $laravelViews->create(App\Http\Livewire\UsersTableView::class)
-      ->layout('layout', 'section-name');
+### [Grid view](doc/grid-view.md)
 
-    return $laravelViews->render();
-}
-```
-
-## Send extra data
-In the same way that you would send data to your views, you can send more data to the layout file
-```php
-use use LaravelViews\LaravelViews;
-
-public function index(LaravelViews $laravelViews)
-{
-    $laravelViews->create(App\Http\Livewire\UsersTableView::class)
-      ->layout('layout', 'section-name', [
-        'title' => 'My layout title'
-      ]);
-
-    return $laravelViews->render();
-}
-```
-
-# Components customization
-These views are build with [Tailwind CSS](https://tailwindcss.com/) and you can either change the colors of the components following tailwindcss utilities or fully customize all the html of the components
-
-## Component variants using tailwindcss
-If you are using [Tailwind CSS](https://tailwindcss.com/) or if you don't have issues  using Tailwindcss and your own css styles, you can customize some utilities to change the color for each variant of the components publishing a config file
-
-```bash
-php artisan vendor:publish --tag=config
-```
-or you can specify the provider
-```bash
-php artisan vendor:publish --tag=config --provider='LaravelViews\LaravelViewsServiceProvider'
-```
-
-Inside this config file you can change the colors for each component variant. If you are updating this package you might need to republish this config file.
-
-## Components full customization
-
-If you are not using taildwindcss, or if you want to have a full customization over the html components, you can publish all the blade files used for these views.
-
-```bash
-php artisan vendor:publish --tag=views
-```
-or you can specify the provider
-```bash
-php artisan vendor:publish --tag=views --provider='LaravelViews\LaravelViewsServiceProvider'
-```
+Dynamic grid view using card data, same as a TableView this view has features like filters, pagination and a search input, you can also customize the card data as you need
 
-If you are updating this package you might need to republish these views.
+![](doc/grid.png)
 
 ## Contributing
 
@@ -217,10 +159,11 @@ Laravel Views is still under heavy development so I will be adding more awesome
 
 Here's the plan for what's coming:
 
-- *New grid view* to display data as a grid instead of as a table
+- **New list view**
+- **New detail view**
+- **New form view**
+- **New layout view**
 - Add tooltips to actions buttons
-- Add confirmation message on actions
 - Add a download action
 - Add translations
-- Add sortable columns
 - Add links as a UI helpers

README.md

@@ -10,7 +10,7 @@
         }
     ],
     "require": {
-        "livewire/livewire": "^2.0"
+        "livewire/livewire": "2.*"
     },
     "autoload": {
         "psr-4": {
@@ -19,8 +19,9 @@
         }
     },
     "require-dev": {
-        "phpunit/phpunit": "6.0.*|7.0.*|8.5.*",
-        "orchestra/testbench": "3.5.*|3.6.*|3.7.*|3.8.*|4.*|5.*|6.*"
+        "phpunit/phpunit": "7.0.*|8.5.*|9.5.*",
+        "orchestra/testbench": "4.*|5.*|6.*",
+        "laravel/legacy-factories": "^1.1"
     },
     "extra": {
         "laravel": {