mirror of
https://github.com/odoo/owl.git
synced 2025-10-06 19:59:41 +07:00
[DOC] improve component documentation
This commit is contained in:
@@ -116,11 +116,30 @@ find a template with the component name (or one of its ancestor).
|
|||||||
type and shape of the (actual) props given to the component. If Owl mode is
|
type and shape of the (actual) props given to the component. If Owl mode is
|
||||||
`dev`, this will be used to validate the props each time the component is
|
`dev`, this will be used to validate the props each time the component is
|
||||||
created/updated. See [Props Validation](#props-validation) for more information.
|
created/updated. See [Props Validation](#props-validation) for more information.
|
||||||
|
|
||||||
|
```js
|
||||||
|
class Counter extends owl.Component {
|
||||||
|
static props = {
|
||||||
|
initialValue: Number,
|
||||||
|
optional: true,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
- **`defaultProps`** (Object, optional): if given, this object define default
|
- **`defaultProps`** (Object, optional): if given, this object define default
|
||||||
values for (top-level) props. Whenever `props` are given to the object, they
|
values for (top-level) props. Whenever `props` are given to the object, they
|
||||||
will be altered to add default value (if missing). Note that it does not
|
will be altered to add default value (if missing). Note that it does not
|
||||||
change the initial object, a new object will be created instead.
|
change the initial object, a new object will be created instead.
|
||||||
|
|
||||||
|
```js
|
||||||
|
class Counter extends owl.Component {
|
||||||
|
static defaultProps = {
|
||||||
|
initialValue: 0
|
||||||
|
};
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
|
|
||||||
We explain here all the public methods of the `Component` class.
|
We explain here all the public methods of the `Component` class.
|
||||||
|
|||||||
Reference in New Issue
Block a user