Skip to content

update async component docs with feedback from RUG-N 17.06.2019 #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 20, 2019
Merged

update async component docs with feedback from RUG-N 17.06.2019 #60

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec1eb88
update async component docs with feedback from RUG-N 17.06.2019
pascalwengerter Jun 18, 2019
2c229e8
update async rerender_on description
pascalwengerter Jun 19, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/components/async.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ Show [specs](../../spec/usage/components/async_spec.rb)

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

Please be aware that, if not configured otherwise, the async core component does get loaded and displayed on initial pageload!

## Parameters

The async core component accepts the following parameters:
Expand All @@ -20,6 +22,12 @@ async rerender_on: 'my_event' do
end
```

**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.

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).

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`)!

### Show_on

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