Skip to content

Latest commit

 

History

History
101 lines (65 loc) · 3.85 KB

README.md

File metadata and controls

101 lines (65 loc) · 3.85 KB
Raw

Nova Advanced Image Field

StyleCI Latest Version on Packagist Total Downloads License

This package provides an advanced image field for Nova resources allowing you to upload, crop and resize any image.

It uses Cropper.js with vue-cropperjs on the client and Intervention Image on the server.

screenshot of the advanced image field

Requirements

In order to work, this package requires the following components:

  • Laravel & Nova (2 or 3)
  • Fileinfo Extension

And one of the following libraries:

  • GD Library >=2.0 (default)
  • Imagick PHP extension >=6.5.7

See Intervention requirements for more details.

Getting started

Install the package into a Laravel application with Nova using Composer:

composer require ctessier/nova-advanced-image-field

If you want to use Imagick as the default image processing library, follow the Intervention documentation for Laravel. This will provide you with a new configuration file where you can specify the driver you want.

Code examples

AdvancedImage extends from Image so you can use any methods that Image implements. See the documentation here.

// Show a cropbox with a fixed ratio
AdvancedImage::make('Photo')->croppable(16/9),

// Resize the image to a max width
AdvancedImage::make('Photo')->resize(1920),

// Override the image processing driver for this field only
AdvancedImage::make('Photo')->driver('imagick'),

To serve the image as an avatar / cover art search results, use the AdvancedAvatar class:

AdvancedAvatar::make('Avatar')->croppable(),

API

driver(string $driver)

Override the default driver to be used by Intervention for the image manipulation.

AdvancedImage::make('Photo')->driver('imagick'),

croppable([float $ratio])

Specify if the underlying image should be croppable.

If a numeric value is given as a first parameter, it will be used to define a fixed aspect ratio for the crop box.

AdvancedImage::make('Photo')->croppable(),
AdvancedImage::make('Photo')->croppable(16/9),

resize(int $width = null, [int $height = null]])

Specify the size (width and height) the image should be resized to.

AdvancedImage::make('Photo')->resize(1920),
AdvancedImage::make('Photo')->resize(600, 400),
AdvancedImage::make('Photo')->resize(null, 300),

Note: this method uses Intervention Image resize() with the upsize and aspect ratio constraints.

autoOrientate()

Specify if the underlying image should be orientated.

Rotate the image to the orientation specified in Exif data, if any.

AdvancedImage::make('Photo')->autoOrientate(),

Note: PHP must be compiled in with --enable-exif to use this method. Windows users must also have the mbstring extension enabled. See the Intervention Image documentation for more details.