Class: ReactiveRecord::WhileLoading

Inherits:
Object
  • Object
show all
Includes:
React::Component, React::IsomorphicHelpers
Defined in:
lib/reactive_record/active_record/reactive_record/while_loading.rb

Overview

To notify React that something is loading use React::WhileLoading.loading! once everything is loaded then do React::WhileLoading.loaded_at message (typically a time stamp just for debug purposes)

Class Method Summary collapse

Instance Method Summary collapse

Methods included from React::Component

#component_did_mount, #component_did_update, #original_component_did_mount, #original_component_did_update, #reactive_record_link_set_while_loading_container_class, #reactive_record_link_to_enclosing_while_loading_container

Class Method Details

.add_style_sheetObject



148
149
150
151
152
153
154
155
# File 'lib/reactive_record/active_record/reactive_record/while_loading.rb', line 148

def add_style_sheet
  @style_sheet ||= %x{
    $('<style type="text/css">'+
      '  .reactive_record_is_loading > .reactive_record_show_when_loaded { display: none; }'+
      '  .reactive_record_is_loaded > .reactive_record_show_while_loading { display: none; }'+
      '</style>').appendTo("head")
  }
end

.has_observers?Boolean

Returns:

  • (Boolean)


95
96
97
# File 'lib/reactive_record/active_record/reactive_record/while_loading.rb', line 95

def self.has_observers?
  React::State.has_observers?(self, :loaded_at)
end

.loaded_at(loaded_at) ⇒ Object



129
130
131
132
# File 'lib/reactive_record/active_record/reactive_record/while_loading.rb', line 129

def loaded_at(loaded_at)
  React::State.set_state(self, :loaded_at, loaded_at)
  @is_loading = false
end

.loading!Object



122
123
124
125
126
127
# File 'lib/reactive_record/active_record/reactive_record/while_loading.rb', line 122

def loading!
  React::RenderingContext.waiting_on_resources = true
  React::State.get_state(self, :loaded_at)
  React::State.set_state(self, :quiet, false)
  @is_loading = true
end

.loading?Boolean

Returns:

  • (Boolean)


118
119
120
# File 'lib/reactive_record/active_record/reactive_record/while_loading.rb', line 118

def loading?
  @is_loading
end

.page_loaded?Boolean

Returns:

  • (Boolean)


138
139
140
# File 'lib/reactive_record/active_record/reactive_record/while_loading.rb', line 138

def page_loaded?
  React::State.get_state(self, :page_loaded)
end

.quiet!Object



142
143
144
145
146
# File 'lib/reactive_record/active_record/reactive_record/while_loading.rb', line 142

def quiet!
  React::State.set_state(self, :quiet, true)
  after(1) { React::State.set_state(self, :page_loaded, true) } unless on_opal_server? or @page_loaded
  @page_loaded = true
end

.quiet?Boolean

Returns:

  • (Boolean)


134
135
136
# File 'lib/reactive_record/active_record/reactive_record/while_loading.rb', line 134

def quiet?
  React::State.get_state(self, :quiet)
end

Instance Method Details

#get_next_while_loading_counterObject



87
88
89
# File 'lib/reactive_record/active_record/reactive_record/while_loading.rb', line 87

def get_next_while_loading_counter
  @while_loading_counter += 1
end

#preload_css(css) ⇒ Object



91
92
93
# File 'lib/reactive_record/active_record/reactive_record/while_loading.rb', line 91

def preload_css(css)
  @css_to_preload << css << "\n"
end

#renderObject



182
183
184
185
186
187
188
189
190
191
# File 'lib/reactive_record/active_record/reactive_record/while_loading.rb', line 182

def render
  props = element_props.dup
  classes = [props[:class], props[:className], "reactive_record_while_loading_container_#{@uniq_id}"].compact.join(" ")
  props.merge!({
    "data-reactive_record_while_loading_container_id" => @uniq_id,
    "data-reactive_record_enclosing_while_loading_container_id" => @uniq_id,
    class: classes
  })
  React.create_element(element_type, props) { loaded_children + loading_children }
end