Skip to content

Commit 735ad90

Browse files
authored
Merge pull request #60 from basemate/update_async_documentation
update async component docs with feedback from RUG-N 17.06.2019
2 parents 6f1d1fd + 2c229e8 commit 735ad90

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/components/async.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ Show [specs](../../spec/usage/components/async_spec.rb)
44

55
As the name suggests, the async component allows us to let our components behave asynchronously!
66

7+
Please be aware that, if not configured otherwise, the async core component does get loaded and displayed on initial pageload!
8+
79
## Parameters
810

911
The async core component accepts the following parameters:
@@ -20,6 +22,12 @@ async rerender_on: 'my_event' do
2022
end
2123
```
2224

25+
**Note:** The `rerender_on` option lets you rerender parts of your UI asynchronously, which is cool. But please consider that, if not configured differently, it a) is **not** _lazily loaded_ and b) does get displayed on initial pageload.
26+
27+
Lazy (or defered) loading is a feature we're working on right now, for details see [here](https://github.com/basemate/matestack-ui-core/issues/58).
28+
29+
If you want to hide the async component on initial pageload and display it later on, read below as this option (`show_on`) is already implemented (and can be combined with `rerender_on`)!
30+
2331
### Show_on
2432

2533
The `show_on` option lets us define an event on which the component gets shown.

0 commit comments

Comments
 (0)