Skip to content

Commit 2929f5f

Browse files
committed
adjusted docs
1 parent 109f351 commit 2929f5f

File tree

4 files changed

+27
-9
lines changed

4 files changed

+27
-9
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,15 @@
22

33
## v3.0.0.rc2 Release - 2022-02-15
44

5+
### Changes
6+
7+
- changed `matestack-ui-core-ref` attr to `matestack-ui-vuejs-ref` for better semantics
8+
- changed `scoped_ref` method to `matestack_ui_vuejs_ref` for better semantics
9+
510
### Bugfixes
611

712
- fixed ID rendering on form input components
13+
- fixed return value of `getElement` method in order to match previous behaviour of `$el`
814

915
## v3.0.0.rc1 Release - 2022-02-11
1016

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

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -186,17 +186,21 @@ As we're pretty much implementing pure Vue.js components, you can refer to the [
186186
#### component $refs
187187

188188
* use `this.getRefs()` instead of `this.$refs`
189-
* user `scoped_ref()` when applying refs to your componen template:
189+
* use `matestack_ui_vuejs_ref()` when applying refs to your componen template:
190190

191191
```ruby
192192
def response
193193
# ...
194194
div ref: "some-ref" # <-- not picked up by this.getRefs()
195195
# ...
196-
div "matestack-ui-core-ref": scoped_ref('some-ref')
196+
div "matestack-ui-vuejs-ref": matestack_ui_vuejs_ref('some-ref')
197197
end
198198
```
199199

200200
#### component $el
201201

202-
* use `this.getElement()` instead of `this.$el`
202+
* use `this.getElement()` instead of `this.$el` in order to get the root element defined in your `response` method
203+
204+
#### component template/root element
205+
206+
* 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

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,17 +65,21 @@ As we're pretty much implementing pure Vue.js components, you can refer to the [
6565
#### component $refs
6666

6767
* use `this.getRefs()` instead of `this.$refs`
68-
* use `scoped_ref()` when applying refs to your componen template:
68+
* use `matestack_ui_vuejs_ref()` when applying refs to your componen template:
6969

7070
```ruby
7171
def response
7272
# ...
7373
div ref: "some-ref" # <-- not picked up by this.getRefs()
7474
# ...
75-
div "matestack-ui-core-ref": scoped_ref('some-ref')
75+
div "matestack-ui-vuejs-ref": matestack_ui_vuejs_ref('some-ref')
7676
end
7777
```
7878

7979
#### component $el
8080

81-
* use `this.getElement()` instead of `this.$el`
81+
* use `this.getElement()` instead of `this.$el` in order to get the root element defined in your `response` method
82+
83+
#### component template/root element
84+
85+
* 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

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -383,23 +383,27 @@ end
383383
### component $refs
384384

385385
* use `this.getRefs()` instead of `this.$refs`
386-
* adjust ref specifications in your component templates:
386+
* use `matestack_ui_vuejs_ref()` when applying refs to your componen template:
387387

388388
```ruby
389389
def response
390390
# ...
391391
div ref: "some-ref" # <-- not picked up by this.getRefs()
392392
# ...
393-
div "matestack-ui-core-ref": scoped_ref('some-ref')
393+
div "matestack-ui-vuejs-ref": matestack_ui_vuejs_ref('some-ref')
394394
end
395395
```
396396

397397
### component $el
398398

399-
* use `this.getElement()` instead of `this.$el`
399+
* use `this.getElement()` instead of `this.$el` in order to get the root element defined in your `response` method
400400

401401
\-> Search\&Replace
402402

403+
*Additional Note:*
404+
405+
* use `this.getTemplateElement()` in order to get the template element (`matestack-component-template` tag) wrapping the root element defined in your `response` method
406+
403407
### component beforeDestroy hook
404408

405409
* `beforeDestroy` was renamed to `beforeUnmount` within vue3

0 commit comments

Comments
 (0)