Download the PHP package arnoson/kirby-vite without Composer
On this page you can find all versions of the php package arnoson/kirby-vite. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
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 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.
Informations about the package kirby-vite
Use Kirby CMS together with Vite
Getting started
The easiest way to get started is using the basic starter kit or the multi-page kit.
Usage
Make sure you have the right setup. Then inside your template files (or anywhere else) you can use the helper functions.
Setup
If you want use the plugin without one of the starter kits, you can add it to your existing kirby setup.
Installation
Development VS Production modes
In development, files are loaded from Vite's dev server. In production, files are injected based on the manifest.json file generated by Vite.
kirby-vite uses a file named .dev (created and removed automatically by vite-plugin-kirby) to determine which mode to use:
- when the file exists, it will run in development mode
- when the file doesn’t exists, it will run in production mode
Config
All configuration is done in the vite.config.js:
vite-plugin-kirby shares part of this config with Kirby, by dynamically creating a site/config/vite.config.php file.
Asset file paths
Sometimes you might want to access the (hashed) file path of your assets, e.g. to preload fonts. You can do so with vite()->file():
Trying
If you try to load a non-existent manifest entry, this plugin will throw an error (if Kirby's debug option is enabled). This is intended behavior, since you usually know which entries exist. But sometimes, especially in a multi-page setup, you may want to try to load an entry only if it exists. You can do this with the try flag:
Query Language
Since version v5.3.0 you can use Kirby's query language in your entry names:
Note: this will throw errors in debug mode if the assets don't exist. So you might want to use Trying to make the assets optional.
Legacy build
Since version 2.4.0 you can easily support legacy browsers that do not support native ESM.
Just add the @vitejs/plugin-legacy plugin to your vite.config.js:
Now call kirby-vite's js() helper as usual.
which will render:
Panel CSS/JS
Since version 5.1.0 and Kirby 4 you can bundle your panel assets alongside your other assets with vite. If you need this feature in Kirby 3, consider kirby-laravel-vite.
Add your panel assets to vite:
And configure Kirby. Make sure to use the ready callback, otherwise you won't be able to call the vite() helpers.
Checkout the example which includes a panel js/css setup.
Known issue
@vitejs/plugin-legacy will inline the css in the legacy js entry. So users with a legacy browser will download the css twice. See this issue.
Contribution
PRs are welcome! If you are contributing it'd be great if you
- use conventional commits, so the release message can be auto-generated (and you are included in it!)
- format your code (if you are using vscode, this should happen automatically on save, otherwise use
npm run format)
For quick manual testing, checkout the /example which uses the local vite and kirby plugin. When adding new features consider adding/improving tests in /packages/kirby-vite/test (right now we're only testing the kirby plugin).
Thanks :~)
Credits
This plugin is highly inspired by Diverently's Laravel Mix Helper for Kirby and André Felipe's vite-php-setup. Many of the fine tunings I owe to Johann Schopplich and his Kirby + Vue 3 Starterkit.
