added information to docs and raise specific error in order to inform about current limitations of the async component usage, will be fixed with the next releases

Author: jonasjabari

app/concepts/matestack/ui/core/page/page.rb

@@ -82,25 +82,28 @@ def show(component_key=nil, only_page=false)
 
       when :only_page
         nodes_to_cell
-        # keys_array = ["div_2","components", "partial_1", "components", "form_1"]
-        # puts @nodes.dig(*keys_array)
         render :page
       when :render_page_with_app
         concept(@app_class).call(:show, @page_id, @nodes)
       when :render_component
-        if component_key.include?("__")
-          keys_array = component_key.gsub("__", "__components__").split("__").map {|k| k.to_s}
-          page_content_keys = keys_array.select{|key| key.match(/^page_content_/)}
-          if page_content_keys.any?
-            keys_array = keys_array.drop(keys_array.find_index(page_content_keys[0])+2)
+        begin
+          if component_key.include?("__")
+            keys_array = component_key.gsub("__", "__components__").split("__").map {|k| k.to_s}
+            page_content_keys = keys_array.select{|key| key.match(/^page_content_/)}
+            if page_content_keys.any?
+              keys_array = keys_array.drop(keys_array.find_index(page_content_keys[0])+2)
+            end
+            node = @nodes.dig(*keys_array)
+            cell = to_cell(component_key, node["component_name"], node["config"], node["argument"], node["components"], node["included_config"])
+            return cell.render_content
+          else
+            node = @nodes[component_key]
+            cell = to_cell(component_key, node["component_name"], node["config"], node["argument"], node["components"], node["included_config"])
+            return cell.render_content
           end
-          node = @nodes.dig(*keys_array)
-          cell = to_cell(component_key, node["component_name"], node["config"], node["argument"], node["components"], node["included_config"])
-          return cell.render_content
-        else
-          node = @nodes[component_key]
-          cell = to_cell(component_key, node["component_name"], node["config"], node["argument"], node["components"], node["included_config"])
-          return cell.render_content
+        rescue
+          raise "Component '#{component_key}' could not be resolved. Notice: Rerendering currently works only on page-level. \
+          You are therefore currently not able to use 'async' within a component for example!"
         end
       end
     end

docs/components/async.md

@@ -6,6 +6,8 @@ As the name suggests, the async component allows us to let our components behave
 
 Please be aware that, if not configured otherwise, the async core component does get loaded and displayed on initial pageload!
 
+**the async component currently only works on page-level --> we're working on it in order support the usage of async within a component [#75](https://github.com/basemate/matestack-ui-core/issues/75)**
+
 ## Parameters
 
 The async core component accepts the following parameters: