Download the PHP package tapp/blade-uppy without Composer

On this page you can find all versions of the php package tapp/blade-uppy. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package blade-uppy

Uppy blade

This package adds Blade components for Uppy to use in your Laravel Blade views.

Installation

Install the package via Composer

Add required JS libraries

Add in your package.json file the AlpineJS library and all the Uppy libraries you need (or install them directly according to the Uppy site doc):

Add the Uppy libraries in your resources/js/bootstrap.js file:

Add in your resources/js/app.js:

Install the JS libraries:

using Mix:

using Vite:

You can use CDNs for Uppy and AlpineJS, if you prefer.

Publish config file (optional)

Publish the config file with:

The published config file contains the Uppy events that are loaded as components:

Publish view files (optional)

Usage

Uppy uploaders are available as Blade components:

This is the component skeleton (using the s3 blade component as an example, but it's the same for s3-multipart, xhr, tus, and transloadit):

The UI that should be used (dashboard or drag-drop) can be defined with the ui attribute and UI options with uiOptions attribute:

Any plugin can be added using the plugins array attribute, where the key is the plugin name and the value is the plugin options:

Add any event using the events array attribute, where the key is the event name and the value is the event code:

If you need to add extra JS code, use the extraJs attribute:

Uploaders

S3

Add the input.uppy.s3 blade component to your blade view:

S3 Multipart

Add the input.uppy.s3-multipart blade component to your blade view. E.g. using the Dashboard UI:

XHR

Add the input.uppy.xhr blade component to your blade view. E.g. using the Drag and Drop UI:

Tus

Add the input.uppy.tus blade component to your blade view:

Transloadit

Add the input.uppy.transloadit blade component to your blade view:

Available attributes for each component:

Attribute Description Default value
instanceName Uppy instance name uppyUpload
coreOptions Core Uppy instance options {}
uploaderOptions Options used by uploader {}
ui UI for upload (dashboard or drag-drop) dashboard
uiOptions Options that should be passed to the UI {}
:events PHP array with the Uppy events (keys are event names, values are event code) []
:plugins PHP array with the Uppy plugins (keys are plugin name, values are plugin options) []
extraJs Extra JS code ''

Uppy instance name

Use the instanceName attribute to define the Uppy instance name.

Default: uppyUpload

Core Options

Core Uppy options are defined with the coreOptions attribute.

Default:

Uploader Options

Can be defined using uploaderOptions attribute.

Default:

User Interface

ui attribute

Define the User Interface (UI) that should be used (Dashboard or Drag&Drop). Possible values:

E.g.:

Default: dashboard

uiOptions attribute

You may pass the Uppy UI JS options via uiOptions attribute.

E.g.:

Default: {}

Docs:

Dashboard example:

Drag & Drop example:

Plugins

User Interface Elements

UI elements can be added using the plugins attribute associative array, where the key should be the same name as the UI element (E.g. the key for Status Bar element is StatusBar) and the value is the JS options to be passed to the UI element.

UI elements Plugins:

E.g.:

Sources

Define the sources to be used for upload using the plugins associative array attribute.

Source Plugins:

E.g.:

Misc

Another misc plugins can be added using the component's plugins associative array attribute.

Misc Plugins:

For example to use the GoldenRetriever (uppy.use(GoldenRetriever, { serviceWorker: false })) and Compressor (uppy.use(Compressor, { quality: 0.6 })) plugins:

Events

Define the events as a PHP associative array (key is the event name and value is the JS content of the event) passed to events attribute:

Adding extra JS code

You can add some extra JS code using extraJs attribute.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

If you discover any security-related issues, please email [email protected].

Credits

Libraries used in this package:

License

The MIT License (MIT). Please see License File for more information.


All versions of blade-uppy with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4|^8.0
illuminate/contracts Version ^8.0|^9.0|^10.0|^11.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package tapp/blade-uppy contains the following files

Loading the files please wait ....