adjusted docs

Author: jonasjabari

CHANGELOG.md

@@ -2,9 +2,15 @@
 
 ## v3.0.0.rc2 Release - 2022-02-15
 
+### Changes
+
+- changed `matestack-ui-core-ref` attr to `matestack-ui-vuejs-ref` for better semantics
+- changed `scoped_ref` method to `matestack_ui_vuejs_ref` for better semantics
+
 ### Bugfixes
 
 - fixed ID rendering on form input components
+- fixed return value of `getElement` method in order to match previous behaviour of `$el`
 
 ## v3.0.0.rc1 Release - 2022-02-11
 

docs/custom-reactivity/custom-vue-js-components.md

@@ -186,17 +186,21 @@ As we're pretty much implementing pure Vue.js components, you can refer to the [
 #### component $refs
 
 * use `this.getRefs()` instead of `this.$refs`
-* user `scoped_ref()` when applying refs to your componen template:
+* use `matestack_ui_vuejs_ref()` when applying refs to your componen template:
 
 ```ruby
 def response
     # ...
     div ref: "some-ref" # <-- not picked up by this.getRefs()
     # ...
-    div "matestack-ui-core-ref": scoped_ref('some-ref')
+    div "matestack-ui-vuejs-ref": matestack_ui_vuejs_ref('some-ref')
 end
 ```
 
 #### component $el
 
-* use `this.getElement()` instead of `this.$el`
+* use `this.getElement()` instead of `this.$el` in order to get the root element defined in your `response` method
+
+#### component template/root element
+
+* use `this.getTemplateElement()` in order to get the template element wrapping the root element defined in your `response` method

docs/custom-reactivity/matestacks-vue.js-apis-wip.md

@@ -65,17 +65,21 @@ As we're pretty much implementing pure Vue.js components, you can refer to the [
 #### component $refs
 
 * use `this.getRefs()` instead of `this.$refs`
-* use `scoped_ref()` when applying refs to your componen template:
+* use `matestack_ui_vuejs_ref()` when applying refs to your componen template:
 
 ```ruby
 def response
     # ...
     div ref: "some-ref" # <-- not picked up by this.getRefs()
     # ...
-    div "matestack-ui-core-ref": scoped_ref('some-ref')
+    div "matestack-ui-vuejs-ref": matestack_ui_vuejs_ref('some-ref')
 end
 ```
 
 #### component $el
 
-* use `this.getElement()` instead of `this.$el`
+* use `this.getElement()` instead of `this.$el` in order to get the root element defined in your `response` method
+
+#### component template/root element
+
+* use `this.getTemplateElement()` in order to get the template element wrapping the root element defined in your `response` method

docs/migrate-to-3.0.md

@@ -383,23 +383,27 @@ end
 ### component $refs
 
 * use `this.getRefs()` instead of `this.$refs`
-* adjust ref specifications in your component templates:
+* use `matestack_ui_vuejs_ref()` when applying refs to your componen template:
 
 ```ruby
 def response
     # ...
     div ref: "some-ref" # <-- not picked up by this.getRefs()
     # ...
-    div "matestack-ui-core-ref": scoped_ref('some-ref')
+    div "matestack-ui-vuejs-ref": matestack_ui_vuejs_ref('some-ref')
 end
 ```
 
 ### component $el
 
-* use `this.getElement()` instead of `this.$el`
+* use `this.getElement()` instead of `this.$el` in order to get the root element defined in your `response` method
 
 \-> Search\&Replace
 
+*Additional Note:*
+
+* use `this.getTemplateElement()` in order to get the template element (`matestack-component-template` tag) wrapping the root element defined in your `response` method
+
 ### component beforeDestroy hook
 
 * `beforeDestroy` was renamed to `beforeUnmount` within vue3