https://github.com/ElMassimo/stimulus-vite-helpers

Helpers to easily load all your Stimulus controllers when using Vite.js
https://github.com/ElMassimo/stimulus-vite-helpers

rails stimulusjs vitejs

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/ElMassimo/stimulus-vite-helpers
• Owner: ElMassimo
• Created: 2021-02-12T21:37:12.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-02-21T15:50:05.000Z (7 months ago)
• Last Synced: 2024-07-10T20:22:52.830Z (2 months ago)
• Topics: rails, stimulusjs, vitejs
• Language: TypeScript
• Homepage: https://vite-rails.netlify.app/
• Size: 258 KB
• Stars: 42
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
stimulus-vite-helpers


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




  

    

  

  

    

  






[import.meta.glob]: https://vitejs.dev/guide/features.html#glob-import

[jumpstart]: https://github.com/ElMassimo/jumpstart-vite

[stimulus handbook]: https://stimulus.hotwire.dev/handbook/installing

[stimulus]: https://github.com/hotwired/stimulus

[vite_rails]: https://vite-rails.netlify.app

[vite-plugin-stimulus-hmr]: https://github.com/ElMassimo/vite-plugin-stimulus-hmr

This plugin was extracted out of [Jumpstart Rails with Vite.js][jumpstart], 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 💿

```bash

npx ni stimulus-vite-helpers

```

## Usage 🚀

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

```ts

import { Application } from '@hotwired/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

- [Stimulus]

## License

This library is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).