OpalVite Helpers API v1

This directory contains API documentation for OpalVite Concerns v1.

Module Structure

All helpers are located in the OpalVite::Concerns::V1 namespace:

require 'opal_vite/concerns/v1/stimulus_helpers'

class MyController < StimulusController
  include OpalVite::Concerns::V1::StimulusHelpers
end

Available Modules

Module	Description
StimulusHelpers	Stimulus controller integration
DomHelpers	DOM manipulation utilities
Storable	LocalStorage persistence
Toastable	Toast notification system
JsProxyEx	JavaScript object wrappers
VueHelpers	Vue.js 3 integration
ReactHelpers	React integration
URIHelpers	URL encoding/decoding utilities
Base64Helpers	Base64 encoding/decoding utilities
DebugHelpers	Debugging and console logging utilities
ActionCableHelpers	ActionCable WebSocket integration
TurboHelpers	Hotwire Turbo integration

opal_stimulus Compatibility Patch

opal_stimulus 0.2.x builds some JavaScript property names incorrectly for multi-word names. Require the patch right after opal_stimulus to fix them:

require 'opal_stimulus/stimulus_controller'
require 'opal_vite/compat/opal_stimulus'

See opal_stimulus_compat.md for details.

Backward Compatibility

For backward compatibility, you can still use the old paths:

require 'opal_vite/concerns/stimulus_helpers'
include OpalVite::Concerns::StimulusHelpers

However, this will show a deprecation warning. Please migrate to the v1 paths.

Global Aliases

For convenience, top-level aliases are also available:

require 'opal_vite/concerns/v1/stimulus_helpers'
include StimulusHelpers  # Same as OpalVite::Concerns::V1::StimulusHelpers