Skip to content
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

Update 02_build_a_dashboard.rst #11674

Open
wants to merge 1 commit into
base: 18.0
Choose a base branch
from
Open

Update 02_build_a_dashboard.rst #11674

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 8 additions & 6 deletions content/developer/tutorials/discover_js_framework/02_build_a_dashboard.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,21 +199,23 @@ Let's improve the dashboard by adding a few dashboard items to display *real* bu
The `awesome_dashboard` addon provides a `/awesome_dashboard/statistics` route that is meant
to return some interesting information.

To call a specific controller, we need to use the :ref:`rpc service <frontend/services/rpc>`.
It only exports a single function that perform the request: :code:`rpc(route, params, settings)`.
To call a specific controller, we need to use the *rpc* function from `@web/core/network/rpc`.
The `rpc` function takes a route as an argument and performs the request: :code:`rpc(route, params, settings)`.
You can also pass `params` and `settings` as *optional* arguments.
A basic request could look like this:

.. code-block:: js

import { rpc } from "@web/core/network/rpc";
...
setup() {
this.rpc = useService("rpc");
onWillStart(async () => {
const result = await this.rpc("/my/controller", {a: 1, b: 2});
const result = await rpc("/my/controller", {a: 1, b: 2});
// ...
});
}

#. Update `Dashboard` so that it uses the `rpc` service.
#. Update `Dashboard` so that it uses the `rpc` function.
#. Call the statistics route `/awesome_dashboard/statistics` in the `onWillStart` hook.
#. Display a few cards in the dashboard containing:

Expand All @@ -227,7 +229,7 @@ A basic request could look like this:
:align: center

.. seealso::
`Code: rpc service <{GITHUB_PATH}/addons/web/static/src/core/network/rpc_service.js>`_
`Code: rpc function <{GITHUB_PATH}/addons/web/static/src/core/network/rpc.js>`_

5. Cache network calls, create a service
========================================
Expand Down