[DOC] remove old references to comp for useRef hook

Going from owl 1.0 to 2.0, we removed the possibility of having a
reference to a component. However, the documentation was not properly
updated to reflect that.
This commit is contained in:
Géry Debongnie
2023-04-13 09:43:36 +02:00
committed by Sam Degueldre
parent aa19897031
commit 5d40cc112d
+7 -8
View File
@@ -112,17 +112,16 @@ of a component, rendered by Owl. It only work on a html element tagged by the
```xml ```xml
<div> <div>
<input t-ref="someDiv"/> <input t-ref="someInput"/>
<span>hello</span> <span>hello</span>
</div> </div>
``` ```
In this example, the component will be able to access the `div` and the component In this example, the component will be able to access the `input` with the `useRef` hook:
`SubComponent` with the `useRef` hook:
```js ```js
class Parent extends Component { class Parent extends Component {
inputRef = useRef("someComponent"); inputRef = useRef("someInput");
someMethod() { someMethod() {
// here, if component is mounted, refs are active: // here, if component is mounted, refs are active:
@@ -139,18 +138,18 @@ The `t-ref` directive also accepts dynamic values with string interpolation
`t-component` directives). For example, `t-component` directives). For example,
```xml ```xml
<div t-ref="component_{{someCondition ? '1' : '2'}}"/> <div t-ref="div_{{someCondition ? '1' : '2'}}"/>
``` ```
Here, the references need to be set like this: Here, the references need to be set like this:
```js ```js
this.ref1 = useRef("component_1"); this.ref1 = useRef("div_1");
this.ref2 = useRef("component_2"); this.ref2 = useRef("div_2");
``` ```
References are only guaranteed to be active while the parent component is mounted. References are only guaranteed to be active while the parent component is mounted.
If this is not the case, accessing `el` or `comp` on it will return `null`. If this is not the case, accessing `el` on it will return `null`.
### `useSubEnv` and `useChildSubEnv` ### `useSubEnv` and `useChildSubEnv`