Assets allow you to extend or add additional functionality to Nova without the overhead of cards or resource tools. For example, you may wish to override a custom error component to match your branding or intercept Inertia interactions and provide additional data to routes.

Defining Assets

Assets may be generated using the nova:asset Artisan command. By default, all new assets will be placed in the nova-components directory of your application. When generating an asset using the nova:asset command, the asset name you pass to the command should follow the Composer vendor/package format:

php artisan nova:asset acme/analytics

When generating an asset, Nova will prompt you to install the assets NPM dependencies, compile its dependencies, and update your application's composer.json file. All custom assets are registered with your application as a Composer "path" repository.

Nova assets include all of the scaffolding necessary to build your asset. Each asset even contains its own composer.json file and is ready to be shared with the world on GitHub or the source control provider of your choice.

Registering Assets

Nova assets are automatically loaded through the use of Laravel's auto-loader, so no additional registration is required.

Compiling Assets

Your Nova asset contains a webpack.mix.js file, which is generated when Nova creates your custom asset. You may build your custom asset using the NPM dev and prod commands:

# Compile your assets for local development...
npm run dev

# Compile and minify your assets...
npm run prod

In addition, you may run the NPM watch command to auto-compile your assets when they are changed:

npm run watch