直接从标记中调用组件方法
ViewComponentReflex allows you to write reflexes right in your view component code.
It builds upon stimulus_reflex and view_component
You can add reflexes to your component by inheriting from ViewComponentReflex::Component.
This will act as if you created a reflex with the method my_cool_stuff. To call this reflex, add data-reflex="click->MyComponentReflex#my_cool_reflex", just like you're
using stimulus reflex.
ViewComponentReflex will maintain your component's instance variables between renders. You need to include data-key= on your root element, as well
as any element that stimulates a reflex. ViewComponent is inherently state-less, so the key is used to reconcile state to its respective component.
# counter_component.rb
class CounterComponent
In order to reconcile state to components in collections, you can specify a collection_key method that returns some
value unique to that component.
class TodoComponent In case you're rendering a collection of empty models, use a UUID of some sort to address the correct component instance on your page:
class TodoComponent If a new parameter is passed to the component during rendering, it is used instead of what's in state. If you're storing instances in state, you can use this to properly compare them.
def permit_parameter?(initial_param, new_param)
if new_param.instance_of? MyModel
new_param.id == @my_model.id
else
super
end
endReturn an array of instance variables you want to omit from state. Only really useful if you're using the session state adapter, and you have an instance variable that can't be serialized.
def omitted_from_state
[:@form]
endThis shares the same definition as content_tag, except it accepts a reflex as the first parameter.
Would add a click handler to the increment method on your component.
To use a non-click event, specific that with -> notation
increment", :button, "Click me!" %>This helper will give you the data attributes used in the reflex_tag above if you want to build your own elements.
Build your own tag:
Render a ViewComponent
increment")) %>Make sure that you assign the reflex_data_attributes to the correct element in your component.
If you're rendering a component as a collection with MyComponent.with_collection(SomeCollection), you must define this method to return some unique value for the component.
This is used to reconcile state in the background.
def initialize
@my_model = MyModel.new
end
def collection_key
@my_model.id
endStimulate another reflex from within your component. This typically requires the key of the component you're stimulating which can be passed in via parameters.
def initialize(parent_key)
@parent_key = parent_key
end
def stimulate_other
stimulate("OtherComponent#method", { key: @parent_key })
endRefresh a specific element on the page. Using this will implicitly run prevent_render!.
If you want to render a specific element, as well as the component, a common pattern would be to pass selector as one of the parameters
def my_method
refresh! '#my-special-element', selector
endReturns the unique selector for this component. Useful to pass to refresh! when refreshing custom elements.
By default, VCR will re-render your component after it executes your method. prevent_refresh! prevents this from happening.
def my_method
prevent_refresh!
@foo = :bar
end # the rendered page will not reflect this changeRefresh the entire body of the page
def do_some_global_action
prevent_refresh!
session[:model] = MyModel.new
refresh_all!
endStream to a custom channel, rather than the default stimulus reflex one
def do_something
stream_to MyChannel
@foo = :bar
endThis is a key unique to a particular component. It's used to reconcile state between renders, and should be passed as a data attribute whenever a reflex is called
MyComponent#do_something" data-key="">Click me!This is a view helper to properly connect VCR to the component. It outputs
You must wrap your component in this for everything to work properly.
This is called after the state has been inserted in the component. You can use this to run conditional functions after some parameter has superseeded whatever's in state
def after_state_initialized(parameters_changed)
if parameters_changed.include?(:@filter)
calculate_visible_rows
end
endBy default, all public instance methods are available as reflex methods. You can override this to explicitly define which methods should be available as reflexes:
class MyComponent
MyComponent#do_expensive_action" data-key="">Click me!
Reflex
A component needs to be wrapped in `` in order to properly initialize, otherwise the Reflex class won't get created.
## Session is an empty hash
StimulusReflex 3.3 introduced _selector morphs_, allowing you to render arbitrary strings via `ApplicationController.render`, for example:
```rb
def test_selector
morph '#some-container', ApplicationController.render(MyComponent.new(some: :param))
endStimulusReflex 3.4 introduced a fix that merges the current request.env and provides the CSRF token to fetch the session.
These instance variable names are not working and unsafe:
def unsafe_instance_variables
[
:@view_context, :@lookup_context, :@view_renderer, :@view_flow,
:@virtual_path, :@variant, :@current_template, :@output_buffer, :@key,
:@helpers, :@controller, :@request, :@tag_builder, :@initialized_state
]
endPlease use a different name to be able to save them to the session.
If you are getting errors that e.g. MatchData, Singleton etc. can't be dumped, ensure that you do not set any instance variables in your components (or any class you inject into them, for that matter) that cannot be marshaled.
This can be easily remedied though, by providing a list of unmarshalable instance variables and overwriting marshal_dump and marshal_load (from https://stackoverflow.com/a/32877159/4341756):
class MarshalTest
UNMARSHALED_VARIABLES = [:@foo, :@bar]
def marshal_dump
instance_variables.reject{|m| UNMARSHALED_VARIABLES.include? m}.inject({}) do |vars, attr|
vars[attr] = instance_variable_get(attr)
vars
end
end
def marshal_load(vars)
vars.each do |attr, value|
instance_variable_set(attr, value) unless UNMARSHALED_VARIABLES.include?(attr)
end
end
end@sebyx07 provided a solution to use anycable (https://github.com/joshleblanc/view_component_reflex/issues/23#issue-721786338)
Leaving this, might help others:
I tried this with any cable and I had to add this to development.rb Otherwise @instance_variables were nil after a reflex
config.cache_store = :redis_cache_store, { url: "redis://localhost:6379/1", driver: :hiredis }
config.session_store :cache_storeWhen using ViewComponent generated sidecar assets, the stimulus controller won't resolve properly.
To resolve this, override the self.stimulus_controller method in your component to the correct method.
For example, if you have a structure of
components/
example_component/
example_component_controller.js
example_component.html.erb
example_component.rbYou would update your self.stimulus_controller method to
def self.stimulus_controller
"example-component--example-component"
endThanks @omairrazam for this solution
The gem is available as open source under the terms of the MIT License.
State uses session to maintain state as of right now. It also assumes your component view is written with a file extension of either .html.erb, .html.haml or .html.slim.
暂无开放 Issues,或尚未同步最近议题。