stimulus-vite-helpers

Vite.js helpers for the Stimulus JavaScript framework

Usage no npm install needed!

<script type="module">
  import stimulusViteHelpers from 'https://cdn.skypack.dev/stimulus-vite-helpers';
</script>

README

stimulus-vite-helpers

Helpers to easily load all your Stimulus controllers when using Vite.js


This plugin was extracted out of Jumpstart Rails with Vite.js, a starter template that you can use to start your next Rails app.

If you are looking for a simple way to integrate Vite.js in Rails, check out vite_rails.

If you would like to enable HMR for your Stimulus controllers, check out vite-plugin-stimulus-hmr.

Installation 💿

npx ni stimulus-vite-helpers

Usage 🚀

You can now register your Stimulus controllers using Vite's globEager and the registerControllers helper:

import { Application } from 'stimulus'
import { registerControllers } from 'stimulus-vite-helpers'

const application = Application.start()
const controllers = import.meta.globEager('./**/*_controller.js')
registerControllers(application, controllers)

For more information, check the Stimulus handbook.

Special Thanks

License

The gem is available as open source under the terms of the MIT License.