Skip to content

Commit

Permalink
Dashboard View Read Me
Browse files Browse the repository at this point in the history
  • Loading branch information
devmtm committed Nov 6, 2018
1 parent c827896 commit e8512ce
Showing 1 changed file with 87 additions and 0 deletions.
87 changes: 87 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@

# Nova Custom Views
This package allows you to create customizable views for specific Nova resources.

# Installation

```
composer require devmtm/nova-custom-views
```

Then you need to add the service provider to your config/app.php **after the NovaServiceProvider**:

<pre>
/*
|--------------------------------------------------------------------------
| Autoloaded Service Providers
|--------------------------------------------------------------------------
|
| The service providers listed here will be automatically loaded on the
| request to your application. Feel free to add your own services to
| this array to grant expanded functionality to your applications.
|
*/

'providers' => [

...
App\Providers\NovaServiceProvider::class,
...
<b>devmtm\NovaCustomViews\NovaCustomViewsServiceProvider::class,</b>
...
</pre>


Create a new view
This is the same process as for any other Nova Tool, ResourceTool or Field. You can simply use this command in your terminal:

```
php artisan nova:views resourceName viewName
```

This will create your view component in /nova-components/views/resourceName. If you've installed the dependencies during the previous process, you can directly go ahead and use:

```
cd ./nova-components/views/resourceName && npm run watch
```

Allowed values for viewName are [index | lens | detail | create | update | attach | update-attached]

If you dont provide viewName, it will create all previous nova views.

You can modify any view component inside /nova-components/views/resourceName/resources/js/views

<<<<<<< HEAD
# Example Usage: Creating custom detail view for user resource
=======
# Example Usage
>>>>>>> 536d723f81dc1c2787d426522255e8b11bafa3f0
To create a new view, say user detail view, you can run the command:
```
php artisan nova:views user detail
```
This will create a new path: '/nova-components/views/user' which contains all generated user views.
The new view is extended the default user nova detail view (using vue mixins).
You can modify the default view by going to the path: '/nova-components/views/user/resources/js/views/Detail.vue' and add your custom code as the following:
```
<template>
<div>YOUR_CODE_HERE<div>
</template>
```
<<<<<<< HEAD

# Example Usage: Creating Custom Dashboard
To create a custom dashboard view, you can run the command:
```
php artisan nova:dashboard
```
This will create a new path: '/nova-components/views/dashboard' which contains the custom dashboard component.
The new view is extended the default nova dashboard view (using vue mixins).
You can modify the dashboard view by going to the path: '/nova-components/views/user/resources/js/views/Dashboard.vue' and add your custom code as the following:
```
<template>
<div>YOUR_CODE_HERE<div>
</template>
```
=======
>>>>>>> 536d723f81dc1c2787d426522255e8b11bafa3f0

0 comments on commit e8512ce

Please sign in to comment.