Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dillingham/nova-button
Add buttons on Nova index, detail and lens views.
https://github.com/dillingham/nova-button
laravel laravel-nova laravel-nova-field
Last synced: 3 days ago
JSON representation
Add buttons on Nova index, detail and lens views.
- Host: GitHub
- URL: https://github.com/dillingham/nova-button
- Owner: dillingham
- License: mit
- Created: 2019-01-05T06:10:42.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-20T05:11:49.000Z (about 1 year ago)
- Last Synced: 2025-01-04T00:11:46.452Z (17 days ago)
- Topics: laravel, laravel-nova, laravel-nova-field
- Language: PHP
- Homepage:
- Size: 1.12 MB
- Stars: 265
- Watchers: 5
- Forks: 33
- Open Issues: 34
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
## Nova Button
Thanks for everyone who used this package and contributed.
I haven't used Nova in many years so I'm unable to maintain this.
I'm so glad to see active forks though!
- https://github.com/dnwjn/nova-button
- https://github.com/sietse85/nova-button
---
[](https://packagist.org/packages/dillingham/nova-button)
[](https://packagist.org/packages/dillingham/nova-button) [](https://twitter.com/sir_brian_d)
Nova package for rendering buttons on index, detail and lens views.
Use buttons to trigger backend events, navigate nova routes or visit links.
### Installation
```bash
composer require dillingham/nova-button
```
### Usage
```php
use NovaButton\Button;
```
```php
public function fields(Request $request)
{
return [
ID::make('ID', 'id')->sortable(),
Text::make('Name', 'name'),
Button::make('Notify'),
];
}
```
Quick links: [Button Styles](https://github.com/dillingham/nova-button#button-styles) | [Event text / style](https://github.com/dillingham/nova-button#button-state) | [Navigation](https://github.com/dillingham/nova-button#button-navigation) | [CSS classes](https://github.com/dillingham/nova-button#button-classes) | [Lens example](https://github.com/dillingham/nova-button#example)
---
### Backend events
By default, clicking the button will trigger a backend event via ajax.
Default event: `NovaButton\Events\ButtonClick`
The event will receive the resource model it was triggered from & the key
- `$event->resource` = `model`
- `$event->key` = `"notify"`
Adding a custom key
```php
Button::make('Notify', 'notify-some-user')
```
Adding a custom event
```php
Button::make('Notify')->event('App\Events\NotifyRequested')
```
You register listeners in your EventServiceProvider
### Nova Routes
You can also choose to navigate any of the Nova routes
```php
Button::make('Text')->route('vuejs-route-name', ['id' => 1])
Button::make('Text')->index('App\Nova\User')
Button::make('Text')->detail('App\Nova\User', $this->user_id)
Button::make('Text')->create('App\Nova\User')
Button::make('Text')->edit('App\Nova\User', $this->user_id)
Button::make('Text')->lens('App\Nova\User', 'users-without-confirmation')
```
You can also enable a resource's filters
```php
Button::make('Text')->index('App\Nova\Order')->withFilters([
'App\Nova\Filters\UserOrders' => $this->user_id,
'App\Nova\Filters\OrderStatus' => 'active',
])
```
### Links
```php
Button::make('Text')->link('https://nova.laravel.com')
Button::make('Text')->link('https://nova.laravel.com', '_self')
```
### Visiblity
You will likely want to show or hide buttons depending on model values
```php
Button::make('Activate')->visible($this->is_active == false),
Button::make('Deactivate')->visible($this->is_active == true),
```
Also [field authorization](https://nova.laravel.com/docs/1.0/resources/authorization.html#fields) via canSee() & [showing / hiding fields](https://nova.laravel.com/docs/1.0/resources/fields.html#showing-hiding-fields) hideFromIndex(), etc
### Reload
After events are triggered, reload the page.
```php
Button::make('Notify')->reload()
```
If you click many buttons, reloading will wait for all buttons to finish.
If an error occurs, it will not reload the page.
### Confirm
You can require a confirmation for descructive actions
```php
Button::make('Cancel Account')->confirm('Are you sure?'),
Button::make('Cancel Account')->confirm('title', 'content'),
```
### Button state
When using events, you want visual feedback for the end user.
This is especially useful for long running listeners.
```php
Button::make('Remind User')->loadingText('Sending..')->successText('Sent!')
```
| Event | Text | Style |
| -- | -- | -- |
| loading | `loadingText('Loading..')` | `loadingStyle('grey-outline')` |
| success | `successText('Done!')` | `successStyle('success')` |
| error | `errorText('Failed')` | `errorStyle('danger')` |
Defaults defined in the `nova-button` config. Add methods when you want to change for specific resources
### Button styles
This package makes use of [tailwind-css](https://tailwindcss.com) classes / default: `link`
```php
Button::make('Confirm')->style('primary')
```
| Fill | Outline | Link |
|---|---|---|
| primary | primary-outline | primary-link |
| success | success-outline | success-link |
| danger | danger-outline | danger-link |
| warning | warning-outline | warning-link |
| info | info-outline | info-link |
| grey | grey-outline | grey-link |
Each key adds classes from the `nova-button` config
```php
'primary' => 'btn btn-default btn-primary'
```
### Style config
Publish the nova-button config to add / edit [available styles & defaults](https://github.com/dillingham/nova-button/blob/master/config/nova-button.php)
```
php artisan vendor:publish --tag=nova-button -- force
```
### Button classes
You can also add classes manually
```php
Button::make('Refund')->classes('some-class')
```
Also able to style the following css classes
```css
.nova-button
.nova-button-{resource-name}
.nova-button-success
.nova-button-error
.nova-button-loading
```
---
# Example
Use [lenses](https://nova.laravel.com/docs/1.0/lenses/defining-lenses.html) with buttons for a very focused user experience
```php
select(['users.id', 'users.name'])
->whereNull('email_verified_at');
}
public function fields(Request $request)
{
return [
ID::make('ID', 'id'),
Text::make('Name', 'name'),
Button::make('Mark As Confirmed'),
];
}
}
```
Register a listener for `\NovaButton\Events\ButtonClick` in your [EventServiceProvider](https://laravel.com/docs/5.7/events)
```php
key == 'mark-as-confirmed') {
$event->resource->email_verified_at = now();
$event->resource->save();
}
}
}
```
No `key` check required when you register an event for this listener
```php
Button::make('Confirm')->event('App\Events\ConfirmClick')
```
# Telescope inspection
---
# Author
Hi 👋, Im Brian Dillingham, creator of this Nova package [and others](https://novapackages.com/collaborators/dillingham)
Hope you find it useful. Feel free to reach out with feedback.
Follow me on twitter: [@sir_brian_d](https://twitter.com/sir_brian_d)