Détail du package

stimulus-vite-helpers

ElMassimo366.6kMIT3.1.0

Vite.js helpers for the Stimulus JavaScript framework

stimulus, stimulusjs, rails, ruby

readme

<samp>stimulus-vite-helpers</samp>

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 <kbd>vite_rails</kbd>.

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

Installation 💿

npx ni stimulus-vite-helpers

Usage 🚀

You can now register your Stimulus controllers using Vite's import.meta.glob and the registerControllers helper:

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

const application = Application.start()
const controllers = import.meta.glob('./**/*_controller.js', { eager: true })
registerControllers(application, controllers)

For more information, check the Stimulus handbook.

Special Thanks

License

This library is available as open source under the terms of the MIT License.

changelog

stimulus-vite-helpers 3.0.1 (2022-09-12)

  • Allow matching controllers without prefix in sidecar directories (fix #3).

stimulus-vite-helpers 1.0.4 (2021-05-24)

  • Fix regexp to avoid namespacing controllers incorrectly (fix #1).

stimulus-vite-helpers 1.0.3 (2021-03-21)

  • Add keywords and fix repo URL.

stimulus-vite-helpers 1.0.2 (2021-02-18)

  • Allow a /components prefix to the filename for simpler integration when using view components.

stimulus-vite-helpers 1.0.1 (2021-02-15)

  • Allow a /controllers prefix to the filename so that the helpers can be used in the Stimulus HMR plugin.

stimulus-vite-helpers 1.0.0 (2021-02-12)

  • Initial version