Skip to content

Commit

Permalink
Merge pull request #39573 from phillip-kruger/dev-ui-doc-fix
Browse files Browse the repository at this point in the history
Small Dev UI documentation update
  • Loading branch information
cescoffier authored Mar 20, 2024
2 parents 605a000 + ffe8927 commit ad8274e
Showing 1 changed file with 4 additions and 10 deletions.
14 changes: 4 additions & 10 deletions docs/src/main/asciidoc/dev-ui.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -841,14 +841,10 @@ The router is mostly used internally. This uses https://github.com/vaadin/router

See the https://github.com/quarkusio/quarkus/blob/main/extensions/vertx-http/dev-ui-resources/src/main/resources/dev-ui/controller/router-controller.js[controller] for some methods that might be useful.

== Communicating to the backend

[[JsonRPC]]
=== JsonRPC

You can execute methods against the runtime or deployment classpath:
== Communicating to the backend

==== Runtime
=== JsonRPC against the Runtime classpath

You can fetch or stream runtime data (rather than <<Build time data>> discussed earlier) or execute methods against the runtime classpath (as opposed to deployment classpath). There are two parts to getting data during runtime. The Java side in the runtime module, and then the usage in the web component.

Expand Down Expand Up @@ -971,7 +967,7 @@ _clear(name) {
----
<1> The `name` parameter is passed in.

===== Streaming data
==== Streaming data

You can keep a UI screen updated with the latest data by continuously streaming data to the screen. This can be done with `Multi` (Java side) and `Observer` (Javascript side)

Expand Down Expand Up @@ -1019,9 +1015,7 @@ this._observer.cancel(); //<2>

https://github.com/phillip-kruger/quarkus-jokes/blob/main/deployment/src/main/resources/dev-ui/qwc-jokes-web-components.js[Example code]


[[Deployment Time]]
==== Deployment Time
==== JsonRpc against the deployment classpath

In certain cases you might need to execute methods and/or get data against the deployment classpath. This also happens over JsonRPC communication, but in this case you do not create a JsonRPC Service in the runtime module,
you can just supply the code to be run in a supplier in the deployment module. To do this you will produce a `BuildTimeActionBuildItem`, example:
Expand Down

0 comments on commit ad8274e

Please sign in to comment.