nova-kit / nova-packages-tool
Tool for Laravel Nova Packages Development
Requires
- php: ^7.3 || ^8.0
- laravel/nova: >=4.35.2 <4.36.0
Requires (Dev)
- nova-kit/nova-devtool: ^1.3
- orchestra/testbench: ^6.35 || ^7.29 || ^8.9 || ^9.0
- dev-develop / 2.x-dev
- 1.x-dev
- v1.17.2
- v1.17.1
- v1.17.0
- v1.16.1
- v1.16.0
- v1.15.0
- v1.14.7
- v1.14.6
- v1.14.5
- v1.14.4
- v1.14.3
- v1.14.2
- v1.14.1
- v1.14.0
- v1.13.3
- v1.13.2
- v1.13.1
- v1.13.0
- v1.12.1
- v1.12.0
- v1.11.2
- v1.11.1
- v1.11.0
- v1.10.0
- v1.9.3
- v1.9.2
- v1.9.1
- v1.9.0
- v1.8.0
- v1.7.1
- v1.7.0
- v1.6.4
- v1.6.3
- v1.6.2
- v1.6.1
- v1.6.0
- v1.5.4
- v1.5.3
- v1.5.2
- v1.5.1
- v1.5.0
- v1.4.0
- v1.3.4
- v1.3.3
- v1.3.2
- v1.3.1
- v1.3.0
- v1.2.1
- v1.2.0
- v1.1.4
- v1.1.3
- v1.1.2
- v1.1.1
- v1.1.0
- v1.0.3
- v1.0.2
- v1.0.1
- v1.0.0
- dev-next
This package is auto-updated.
Last update: 2024-09-25 16:21:40 UTC
README
This library provides a versioning laravel-nova
mixins dependency for 3rd party packages built for Laravel Nova.
Why?
laravel-nova
may introduce breaking and none breaking improvements from time to time. To maintain compatibility all 3rd party packages should rebuild their packages each time Laravel Nova released a new version.
By skipping this process and depending on the severity of the changes it may result in your application no longer working and you are locked to an older version and have to wait each affecting 3rd packages to update their code.
Pros
nova-kit/nova-packages-tool
reduces the maintaining hurdle for each 3rd party package utilizinglaravel-nova
.- The
dist
generated file will be reduced since 3rd party package is no longer required to buildlaravel-nova
source code.
Cons
- Each time Laravel Nova made a new release, you need to wait until
nova-kit/nova-packages-tool
make a new compatible release.
Installation
To install through composer, run the following command from terminal:
composer require "nova-kit/nova-packages-tool:^1.0"
Next, make sure your application's composer.json
contains the following command under script.post-autoload-dump
:
{ "script" : { "post-autoload-dump": [ "@php artisan vendor:publish --tag=laravel-assets --ansi --force" ] } }
Usages
First, you need to add webpack.external alias to laravel-nova
and comment the existing reference to vendor/laravel/nova/resources/js/mixins/js/packages.js
under nova.mix.js
:
webpackConfig.externals = { vue: 'Vue', 'laravel-nova': 'LaravelNova', 'laravel-nova-ui': 'LaravelNovaUi' } // webpackConfig.resolve.alias = { // ...(webpackConfig.resolve.alias || {}), // 'laravel-nova': path.join( // __dirname, // 'vendor/laravel/nova/resources/js/mixins/packages.js' // ), // }
This would allow your package to depends on laravel-nova
from external source and no longer compiled it locally.
Theme Switched Event
Instead of manually registering custom MutationObserver
on each package, you can now listen to a single nova-theme-switched
event:
Nova.$on('nova-theme-switched', ({ theme, element }) => { if (theme === 'dark') { element.add('package-dark') } else { element.remove('package-dark') } })
Nightly Build
Those who just can't wait for compatible release you have to option to use our nightly build by running the following command on your Laravel Nova application:
composer require nova-kit/nova-packages-tool:"dev-next as 1.999.999"