Usage | laravel-medialibrary-pro | Spatie SPATIE laravel-medialibrary-pro ======================== spatie.be/open-source [Docs](https://spatie.be/docs) [Laravel-medialibrary-pro](https://spatie.be/docs/laravel-medialibrary-pro/v6) React Usage Version v6 Other versions for crawler [v6](https://spatie.be/docs/laravel-medialibrary-pro/v6) - [ Introduction ](https://spatie.be/docs/laravel-medialibrary-pro/v6/introduction) - [ Requirements ](https://spatie.be/docs/laravel-medialibrary-pro/v6/requirements) - [ License ](https://spatie.be/docs/laravel-medialibrary-pro/v6/license) - [ Getting help ](https://spatie.be/docs/laravel-medialibrary-pro/v6/getting-help) - [ Upgrading ](https://spatie.be/docs/laravel-medialibrary-pro/v6/upgrading) - [ About us ](https://spatie.be/docs/laravel-medialibrary-pro/v6/about-us) - [ ](https://spatie.be/docs/laravel-medialibrary-pro/v6/demo-application) Blade ----- - [ Installation ](https://spatie.be/docs/laravel-medialibrary-pro/v6/blade/installation) - [ Usage ](https://spatie.be/docs/laravel-medialibrary-pro/v6/blade/usage) Livewire -------- - [ Installation ](https://spatie.be/docs/laravel-medialibrary-pro/v6/livewire/installation) - [ Attachments ](https://spatie.be/docs/laravel-medialibrary-pro/v6/livewire/attachments) - [ Collection ](https://spatie.be/docs/laravel-medialibrary-pro/v6/livewire/collection) - [ Uploading to S3 ](https://spatie.be/docs/laravel-medialibrary-pro/v6/livewire/uploading-to-s3) React ----- - [ Installation ](https://spatie.be/docs/laravel-medialibrary-pro/v6/react/installation) - [ Usage ](https://spatie.be/docs/laravel-medialibrary-pro/v6/react/usage) - [ Available props ](https://spatie.be/docs/laravel-medialibrary-pro/v6/react/available-props) - [ Inertia ](https://spatie.be/docs/laravel-medialibrary-pro/v6/react/inertia) - [ Next.js ](https://spatie.be/docs/laravel-medialibrary-pro/v6/react/nextjs) - [ Translations ](https://spatie.be/docs/laravel-medialibrary-pro/v6/react/translations) - [ Vapor support ](https://spatie.be/docs/laravel-medialibrary-pro/v6/react/vapor) - [ Creating custom components ](https://spatie.be/docs/laravel-medialibrary-pro/v6/react/creating-custom-components) Vue.js ------ - [ Installation ](https://spatie.be/docs/laravel-medialibrary-pro/v6/vue/installation) - [ Usage ](https://spatie.be/docs/laravel-medialibrary-pro/v6/vue/usage) - [ Available props ](https://spatie.be/docs/laravel-medialibrary-pro/v6/vue/available-props) - [ Inertia ](https://spatie.be/docs/laravel-medialibrary-pro/v6/vue/inertia) - [ Translations ](https://spatie.be/docs/laravel-medialibrary-pro/v6/vue/translations) - [ Vapor support ](https://spatie.be/docs/laravel-medialibrary-pro/v6/vue/vapor) - [ Creating custom components ](https://spatie.be/docs/laravel-medialibrary-pro/v6/vue/creating-custom-components) Security -------- - [ Authorisation ](https://spatie.be/docs/laravel-medialibrary-pro/v6/security/authorisation) - [ Configure allowed mime types ](https://spatie.be/docs/laravel-medialibrary-pro/v6/security/allowed-mime-types) - [ Rate limiting ](https://spatie.be/docs/laravel-medialibrary-pro/v6/security/rate-limiting) Advanced -------- - [ Customizing CSS ](https://spatie.be/docs/laravel-medialibrary-pro/v6/advanced/customizing) - [ Customize the preview images ](https://spatie.be/docs/laravel-medialibrary-pro/v6/advanced/custom-preview-images) - [ Customize the upload URL ](https://spatie.be/docs/laravel-medialibrary-pro/v6/advanced/customiz-upload-url) - [ Usage in a frontend repository ](https://spatie.be/docs/laravel-medialibrary-pro/v6/advanced/usage-in-a-frontend-repository) Legacy ------ - [ Livewire 2 ](https://spatie.be/docs/laravel-medialibrary-pro/v6/legacy/livewire-2) - [ Laravel Mix ](https://spatie.be/docs/laravel-medialibrary-pro/v6/legacy/laravel-mix) Usage ===== ### On this page 1. [ Your first components ](#content-your-first-components) 2. [ Storing the uploaded file(s) ](#content-storing-the-uploaded-files) 3. [ Validation ](#content-validation) 4. [ Validating requests ](#content-validating-requests) 5. [ Processing requests ](#content-processing-requests) Your first components ----------------------------------------------------------------------------------------------------------------------- The most basic components have a `name` prop. This name will be used to identify the media when it's uploaded to the server. ``` // MyImageUploader.jsx import { MediaLibraryAttachment } from "media-library-pro-react-attachment"; import { MediaLibraryCollection } from "media-library-pro-react-collection"; export default function MyImageUploader() { return ( Submit ); } ``` ### Passing an initial value If your form modifies an existing set of media, you may pass it through in the `initialValue` prop. You can retrieve your initial values in Laravel using `$yourModel->getMedia($collectionName);`, this will also take care of any `old` values after an invalid form submit. ``` Submit ``` Under the hood, these components create hidden `` fields to keep track of the form values on submit. If you would like to submit your values asynchronously, refer to the [Asynchronously submit data](#asynchronously-submit-data) section. ### Setting validation rules You'll probably want to validate what gets uploaded. Use the `validationRules` prop, and don't forget to pass Laravel's validation errors too. The validation errors returned from the server will find errors under the key used in your `name` prop. ``` Submit ``` You can also set the maximum amount of images that users can be uploaded using the `max-items` prop. Don't forget to set the `multiple` prop for the attachment component. ``` Submit ``` See the [Validation rules section](#validation-rules) for a complete list of all possible validation rules. ### Checking the upload state The components keep track of whether they're ready to be submitted, you can use this to disable a submit button while a file is still uploading or when there are frontend validation errors. This value can be tracked by passing a listener method to the `onIsReadyToSubmitChange` prop. If you submit a form while a file is uploading, Laravel will return a HTTP 500 error with an `invalid uuid` message. ``` import { MediaLibraryAttachment } from "media-library-pro-react-attachment"; function AvatarComponent() { const [isReadyToSubmit, setIsReadyToSubmit] = useState(true); return( Submit ) } ``` Storing the uploaded file(s) ---------------------------------------------------------------------------------------------------------------------------------------- Assuming you have properly setup the [Laravel Medialibrary package](https://spatie.be/docs/laravel-medialibrary/v11/introduction) your models will have some helper methods to help you store the files that are uploaded in the Medialibrary Pro components. Imagine your have a Medialibrary Pro component with the name `avatar` your controller method could look like this: ``` namespace App\Http\Controllers; use Illuminate\Http\Request; use Illuminate\Support\Facades\Auth; class ProfileController { public function store(Request $request) { $user = Auth::user(); $user ->addFromMediaLibraryRequest($request->avatar) ->toMediaCollection('avatar'); } } ``` Validation -------------------------------------------------------------------------------------- The `ProfileController` we built assumes users will only upload the exact file types we're looking for. Of course they won't! We need to validate the incoming media before attaching them to our models. The Media Library components provide instant client-side validation. You'll read more about that in the component docs. First, we'll set up server-side validation. To validate uploaded media, we'll use a custom form request. ``` - public function store(Request $request) + public function store(ProfileRequest $request) ``` ``` namespace App\Http\Requests; use Illuminate\Foundation\Http\FormRequest; use Spatie\MediaLibraryPro\Rules\Concerns\ValidatesMedia; class ProfileRequest extends FormRequest { use ValidatesMedia; public function rules() { return [ 'images' => $this ->validateMultipleMedia() ->minItems(1) ->maxItems(5) ->extension('png') ->maxItemSizeInKb(1024) ->attribute('name', 'required') ]; } } ``` --- Every component will pass data in a key of a request. The name of that key is the name you passed to the `name` prop of any of the components. The content of that request key will be an array. For each file uploaded that array will hold an array with these keys. - `name`: the name of the uploaded file - `uuid`: the UUID of a `Media` model. For newly uploaded files that have not been associated to a model yet, the `Media` model will be associated with a `TemporaryUpload` model - `order`: the order in which this item should be stored in a media collection. Validating requests ----------------------------------------------------------------------------------------------------------------- Even though the upload components do some client-side validation, we highly recommend always validating requests on the server as well. You should handle validation in a form request. On the form request you should use the `Spatie\MediaLibraryPro\Rules\Concerns\ValidatesMedia` trait. This will give you access to the `validateSingleMedia` and `validateMultipleMedia` methods. In this example we assume that a component was configured to use the `images` key of the request. We validate that there was at least one item uploaded, but no more than 5. Only `png`s that are up to 1MB in size are allowed. All images should have a name. ``` namespace App\Http\Requests; use Illuminate\Foundation\Http\FormRequest; use Spatie\MediaLibraryPro\Rules\Concerns\ValidatesMedia; class MyRequest extends FormRequest { use ValidatesMedia; public function rules() { return [ 'images' => $this ->validateMultipleMedia() ->minItems(1) ->maxItems(5) ->extension('png') ->maxItemSizeInKb(1024) ->attribute('name', 'required') ]; } } ``` If you are only allowing one uploaded file, you can use the `validateSingleMedia` in much the same way. ``` namespace App\Http\Requests; use Illuminate\Foundation\Http\FormRequest; use Spatie\MediaLibraryPro\Rules\Concerns\ValidatesMedia; class MyRequest extends FormRequest { use ValidatesMedia; public function rules() { return [ 'avatar' => $this ->validateSingleMedia() ->extension('png') ->maxItemSizeInKb(1024) ]; } } ``` These are the available validation methods on `validateSingleMedia() ` and `validateMultipleMedia()` - `minSizeInKb($minSizeInKb)`: validates that a single upload is not smaller than the `$minSizeInKb` given. - `maxSizeInKb($maxSizeInKb)`: validates that a single upload is not greater than the `$minSizeInKb` given. - `extension($extension)`: this rule expects a single extension as a string or multiple extensions as an array. Under the hood, the rule will validate if the value has the mime type that corresponds with the given extension. - `mime($mime)`: this rule expects a single mime type as a string or multiple mime types as an array. - `itemName($rules)`: this rule accepts rules that should be used to validate the name of a media item. - `customProperty($name, $rules)`: this rule accepts a custom property name and rules that should be used to validate the attribute. - `dimensions($width, $height)`: validates that the image has a specific width and height (in pixels). - `width($width)`: validates that the image has a specific width (in pixels). The height is not validated. - `height($height)`: validates that the image has a specific height (in pixels). The width is not validated. - `widthBetween($minWidth, $maxWidth)`: validates that the image width (in pixels) is between the `$minWidth` and `$maxWidth` given (inclusive) - `heightBetween($minHeight, $maxHeight)`: validates that the image height (in pixels) is between the `$minHeight` and `$maxHeight` given (inclusive) These rules can be used on `validateMultipleMedia()`; - `minTotalSizeInKb($maxTotalSizeInKb)`: validates that the combined size of uploads is not smaller than the `$minTotalSizeInKb` given. - `maxTotalSizeInKb($maxTotalSizeInKb)`: validates that the combined size of uploads is not greater than the `$maxTotalSizeInKb` given. ### Validating attributes and custom properties If you're [using custom properties](/docs/laravel-medialibrary/v11/advanced-usage/using-custom-properties), you can validate them with the `customProperty` function. The first argument should be the name of the custom property you are validating. The second argument should be a string or an array with rules you'd like to use. Here's an example where we validate `extra_property` and `another_extra_property`. ``` use Illuminate\Foundation\Http\FormRequest; use Spatie\MediaLibraryPro\Rules\Concerns\ValidatesMedia; class StoreLivewireCollectionCustomPropertyRequest extends FormRequest { use ValidatesMedia; public function rules() { return [ 'name' => 'required', 'images' => $this->validateMultipleMedia() ->customProperty('extra_field', 'required|max:50') ->customProperty('another_extra_property', ['required', 'max:50']) ]; } } ``` Processing requests ----------------------------------------------------------------------------------------------------------------- After you've validated the request, you should persist the changes to the media library. The media library provides two methods for that: `syncFromMediaLibraryRequest` and `addFromMediaLibraryRequest`. Both these methods are available on all [models that handle media](/docs/laravel-medialibrary/v11/basic-usage/preparing-your-model). Either way call the method `toMediaCollection` to update your media-model in the database. This will also ensure that temporary uploads are converted to the appropriate model. ### `addFromMediaLibraryRequest` This method will add all media whose `uuid` is in the request to a media collection of a model. Existing media associated on the model will remain untouched. You should probably use this method only when accepting new uploads. ``` // in a controller public function yourMethod(YourFormRequest $request) { // retrieve model $yourModel ->addFromMediaLibraryRequest($request->get('images')) ->toMediaCollection('images'); flash()->success('Your model has been saved.') return back(); } ``` ### `syncFromMediaLibraryRequest` You should use this method when you are using the `x-media-library-collection` Blade component (or equivalent Vue or React component). Here is an example where we are going to sync the contents of the `images` key in the request to the media library. In this example we use the `images` key, but of course you should use the name that you used. All media associated with `$yourModel` whose `uuid` is not present in the `images` array of the request will be deleted. ``` // in a controller public function yourMethod(YourFormRequest $request) { // retrieve model $yourModel ->syncFromMediaLibraryRequest($request->images) ->toMediaCollection('images'); flash()->success('Your model has been saved.') return back(); } ``` After this code has been executed, the media, whose `uuid` is present in the `images` array of request, will be in the `images collection of `$yourModel`. ``` $yourModel->getMedia('images'); // the media that we just synced will be returned. ``` ### Handling custom properties If you are using properties for your media items you should pass the names of the custom properties you expect to the `withCustomProperties` method. Only these custom properties will be accepted. ``` $yourModel ->syncFromMediaLibraryRequest($request->images) ->withCustomProperties('extra_field', 'another_extra_field') ->toMediaCollection('images'); ``` ### Setting a name If you want to use a specific media name before adding it to disk you can use the `usingName` method. ``` $yourModel ->addFromMediaLibraryRequest($request->images) ->usingName('my custom name') ->toMediaCollection('images'); ``` Alternatively, you can pass a callable to `usingName`. This callable accepts an instance of `Spatie\MediaLibraryPro\MediaLibraryRequestItem` which can be used to get properties of the uploaded file. For this we have to add the `editableName` attribute to the component: ``` ``` The component now will render an editable input field for the name. In this example we're going to set the media name to the lowercase version of the uploaded filename before adding it the media library. ``` $yourModel ->addFromMediaLibraryRequest($request->images) ->usingName(fn(MediaLibraryRequestItem $item) => strtolower($item->name)) ->toMediaCollection('images'); ``` ### Setting a file name If you want to rename an uploaded file before adding it to disk you can use the `usingFileName` method. ``` $yourModel ->addFromMediaLibraryRequest($request->images) ->usingFileName('myFile.jpg') ->toMediaCollection('images'); ``` Alternatively, you can pass a callable to `usingFileName`. This callable accepts an instance of `Spatie\MediaLibraryPro\MediaLibraryRequestItem` which can be used to get properties of the uploaded file. In this example we're going to lowercase the name of the uploaded file before adding it the media library. ``` $yourModel ->addFromMediaLibraryRequest($request->images) ->usingFileName(fn(MediaLibraryRequestItem $item) => strtolower($item->name)) ->toMediaCollection('images'); ```