Fix and document client lifecycle events (onRouteUpdate...)

[slorber]

📚 Documentation

We have client lifecycle events that allow to hook into the navigation, but it's not documented.

#1591

Example usage in the google analytics plugin:

[imabp]

I would like to work on this issue. Can you guide me @slorber about this.

[slorber]

Hi

Unfortunately I don't have more Infos. This requires reading the source code, understanding what it does exactly, and documenting the exposed api

[saadpasta]

@slorber I like to take this up.

[imabp]

@slorber can you help me with the file locations where to start
I am ready to read the source code and contribute.

[saadpasta]

@imabp Here you go, good luck ✌
https://github.com/facebook/docusaurus/blob/1f00d15c7439fdbfb37d57f0cafdaedb2b34ef41/packages/docusaurus-plugin-google-analytics/src/analytics.js

[saadpasta]

onRouteChange is a navigation hook that would help you do run something when a route change.
For E.g If you want to show a pic of a cat on every route change then you would use this hook. (A very silly example I know 😜)
Make sure you document this in Navigation Guide

[imabp]

🥺 Thankyou @saadpasta for giving me the chance to contribute.😊
😅 As it will be my first contribution in Docusaurus. (if merged)

Yes I noted it. I will get back here itself, if I need any help .
Thank you once again 🤗

[slorber]

@saadpasta thanks for helping @imabp :)

You can look for "onRouteUpdate" in the project's source code to find the relevant entry points to document :)

However this is a v2 feature, so this must be documented in the v2 website ;) (not in the v1 navigation guide)

I'd rather see it there: http://localhost:3000/docs/docusaurus-core

[slorber]

Note: we should rather wait for documenting these things.

onRouteUpdate fires too early (before new route actually has rendered), and the PendingNavigation component implementation looks not very robust (particularly due to doing things in shouldComponentUpdate).

Until we have a better implementation, we should probably keep this undocumented.