Skip to content

Commit

Permalink
docs(readme): handle typos
Browse files Browse the repository at this point in the history
Minor edits
  • Loading branch information
RichardScottOZ committed Dec 4, 2022
1 parent 6fdc5a5 commit 12879f2
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.rst
Expand Up @@ -90,7 +90,7 @@ Optional dependencies
-----------------------------------------------------------

When installing trame using pip (`pip install trame`) you will get the core infrastructure for any trame application to work but more advanced usage may require additional dependencies.
The list below capture which may need to add depending on your usage:
The list below captures what may need to add depending on your usage:

* **pywebview** : Needed for desktop usage (--app)
* **jupyterlab** : Needed to run inside jupyter-lab
Expand All @@ -117,27 +117,26 @@ and are prefixed with `on_*`.
* **on_client_exited** : Linked to browser "beforeunload" event
* **on_server_exited** : Trame is exiting its event loop

* **on_server_reload** : If callback registered it is use for reloading server side modules
* **on_server_reload** : If callback registered it is used for reloading server side modules


Reserved state entries
--------------------------------------------------------------------------

The shared state allow us to synchronize the server with the client.
Rather than creating another mechanism to handle similar needs throughout
the application we purposely reuse that state for internal purpose.
To prevent any conflict with any user we are prefixing our internal
the application we purposely reuse that state internally. To prevent any conflict with any user we are prefixing our internal
variable with `trame__*`. In general those state values should not be use
or changed by the user except for the one listed below:

Read/Write:
- **trame__favicon**: Update it to replace the displayed favicon in your
browser. The content needs to be a image encoded url.
browser. The content needs to be an image encoded url.
- **trame__title**: Update it to replace your page title
(tab name / window name).

Read-only:
- **trame__busy**: Provide information if we have pending request waiting
- **trame__busy**: Provide information if we have pending requests waiting
for the server to respond.
- **tts**: Template Time Stamp to regenerate sub elements when a template
gets updated. Usually used as `:key="tts"` to force some component
Expand Down

0 comments on commit 12879f2

Please sign in to comment.