Class: ReactOnRails::ReactComponent::RenderOptions

Inherits:
Object
  • Object
show all
Includes:
Utils::Required
Defined in:
lib/react_on_rails/react_component/render_options.rb

Constant Summary collapse

NO_PROPS = 
{}.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Utils::Required

#required

Constructor Details

#initialize(react_component_name: required("react_component_name"), options: required("options")) ⇒ RenderOptions

TODO: remove the required for named params



16
17
18
19
20
21
22
 
# File 'lib/react_on_rails/react_component/render_options.rb', line 16

def initialize(react_component_name: required("react_component_name"), options: required("options"))
  @react_component_name = react_component_name.camelize

  result = ReactOnRails::ProUtils.disable_pro_render_options_if_not_licensed(options)
  @options = result[:raw_options]
  @explicitly_disabled_pro_options = result[:explicitly_disabled_pro_options]
end

Instance Attribute Details

#explicitly_disabled_pro_options ⇒ Object (readonly)

Returns the value of attribute explicitly_disabled_pro_options.



24
25
26
 
# File 'lib/react_on_rails/react_component/render_options.rb', line 24

def explicitly_disabled_pro_options
  @explicitly_disabled_pro_options
end

#react_component_name ⇒ Object (readonly)

Returns the value of attribute react_component_name.



24
25
26
 
# File 'lib/react_on_rails/react_component/render_options.rb', line 24

def react_component_name
  @react_component_name
end

#request_digest ⇒ Object

Returns the value of attribute request_digest.



11
12
13
 
# File 'lib/react_on_rails/react_component/render_options.rb', line 11

def request_digest
  @request_digest
end

Class Method Details

.generate_request_id ⇒ Object 



146
147
148
 
# File 'lib/react_on_rails/react_component/render_options.rb', line 146

def self.generate_request_id
  SecureRandom.uuid
end

Instance Method Details

#auto_load_bundle ⇒ Object 



78
79
80
 
# File 'lib/react_on_rails/react_component/render_options.rb', line 78

def auto_load_bundle
  retrieve_configuration_value_for(:auto_load_bundle)
end

#client_props ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/react_on_rails/react_component/render_options.rb', line 34

def client_props
  props_extension = ReactOnRails.configuration.rendering_props_extension
  if props_extension.present?
    if props_extension.respond_to?(:adjust_props_for_client_side_hydration)
      return props_extension.adjust_props_for_client_side_hydration(react_component_name,
                                                                    props.clone)
    end

    raise ReactOnRails::Error, "ReactOnRails: your rendering_props_extension module is missing the " \
                               "required adjust_props_for_client_side_hydration method & can not be used"
  end
  props
end

#dom_id ⇒ Object 



52
53
54
55
56
57
58
59
60
 
# File 'lib/react_on_rails/react_component/render_options.rb', line 52

def dom_id
  @dom_id ||= options.fetch(:id) do
    if random_dom_id
      generate_unique_dom_id
    else
      base_dom_id
    end
  end
end

#html_options ⇒ Object 



70
71
72
 
# File 'lib/react_on_rails/react_component/render_options.rb', line 70

def html_options
  options[:html_options].to_h
end

#html_streaming? ⇒ Boolean

Returns:

  • (Boolean) 


137
138
139
140
 
# File 'lib/react_on_rails/react_component/render_options.rb', line 137

def html_streaming?
  # Returns true if the component should be rendered incrementally
  render_mode == :html_streaming
end

#immediate_hydration ⇒ Object 



102
103
104
 
# File 'lib/react_on_rails/react_component/render_options.rb', line 102

def immediate_hydration
  retrieve_configuration_value_for(:immediate_hydration)
end

#internal_option(key) ⇒ Object 



110
111
112
 
# File 'lib/react_on_rails/react_component/render_options.rb', line 110

def internal_option(key)
  options[key]
end

#logging_on_server ⇒ Object 



98
99
100
 
# File 'lib/react_on_rails/react_component/render_options.rb', line 98

def logging_on_server
  retrieve_configuration_value_for(:logging_on_server)
end

#prerender ⇒ Object 



74
75
76
 
# File 'lib/react_on_rails/react_component/render_options.rb', line 74

def prerender
  retrieve_configuration_value_for(:prerender)
end

#props ⇒ Object 



30
31
32
 
# File 'lib/react_on_rails/react_component/render_options.rb', line 30

def props
  options.fetch(:props) { NO_PROPS }
end

#raise_non_shell_server_rendering_errors ⇒ Object 



94
95
96
 
# File 'lib/react_on_rails/react_component/render_options.rb', line 94

def raise_non_shell_server_rendering_errors
  retrieve_react_on_rails_pro_config_value_for(:raise_non_shell_server_rendering_errors)
end

#raise_on_prerender_error ⇒ Object 



90
91
92
 
# File 'lib/react_on_rails/react_component/render_options.rb', line 90

def raise_on_prerender_error
  retrieve_configuration_value_for(:raise_on_prerender_error)
end

#random_dom_id ⇒ Object 



48
49
50
 
# File 'lib/react_on_rails/react_component/render_options.rb', line 48

def random_dom_id
  retrieve_configuration_value_for(:random_dom_id)
end

#random_dom_id? ⇒ Boolean

Returns:

  • (Boolean) 


62
63
64
65
66
67
68
 
# File 'lib/react_on_rails/react_component/render_options.rb', line 62

def random_dom_id?
  return false if options[:id]

  return false unless random_dom_id

  true
end

#render_mode ⇒ Object 



118
119
120
121
122
123
124
125
 
# File 'lib/react_on_rails/react_component/render_options.rb', line 118

def render_mode
  # Determines the React rendering strategy:
  # - :sync: Synchronous SSR using renderToString (blocking and rendering in one shot)
  # - :html_streaming: Progressive SSR using renderToPipeableStream (non-blocking and rendering incrementally)
  # - :rsc_payload_streaming: Server Components serialized in React flight format
  #   (non-blocking and rendering incrementally).
  options.fetch(:render_mode, :sync)
end

#replay_console ⇒ Object 



86
87
88
 
# File 'lib/react_on_rails/react_component/render_options.rb', line 86

def replay_console
  retrieve_configuration_value_for(:replay_console)
end

#rsc_payload_streaming? ⇒ Boolean

Returns:

  • (Boolean) 


132
133
134
135
 
# File 'lib/react_on_rails/react_component/render_options.rb', line 132

def rsc_payload_streaming?
  # Returns true if the component should be rendered as a React Server Component
  render_mode == :rsc_payload_streaming
end

#set_option(key, value) ⇒ Object 



114
115
116
 
# File 'lib/react_on_rails/react_component/render_options.rb', line 114

def set_option(key, value)
  options[key] = value
end

#store_dependencies ⇒ Object 



142
143
144
 
# File 'lib/react_on_rails/react_component/render_options.rb', line 142

def store_dependencies
  options[:store_dependencies]
end

#streaming? ⇒ Boolean

Returns:

  • (Boolean) 


127
128
129
130
 
# File 'lib/react_on_rails/react_component/render_options.rb', line 127

def streaming?
  # Returns true if the component should be rendered incrementally
  %i[html_streaming rsc_payload_streaming].include?(render_mode)
end

#throw_js_errors ⇒ Object 



26
27
28
 
# File 'lib/react_on_rails/react_component/render_options.rb', line 26

def throw_js_errors
  options.fetch(:throw_js_errors, false)
end

#to_s ⇒ Object 



106
107
108
 
# File 'lib/react_on_rails/react_component/render_options.rb', line 106

def to_s
  "{ react_component_name = #{react_component_name}, options = #{options}, request_digest = #{request_digest}"
end

#trace ⇒ Object 



82
83
84
 
# File 'lib/react_on_rails/react_component/render_options.rb', line 82

def trace
  retrieve_configuration_value_for(:trace)
end