facebook / relay

Relay is a JavaScript framework for building data-driven React applications.
https://relay.dev
MIT License
18.38k stars 1.82k forks source link

Relay Entrypoints Documentation #3150

Open outerlook opened 4 years ago

outerlook commented 4 years ago

Hi!

Didn't find it as an issue, so I think it would be nice to have one for tracking "Relay Entrypoints API" documentation situation.

https://relay.dev/docs/en/a-guided-tour-of-relay#preloading-data-for-transitions-in-parallel-with-code-client-preloading

In order to do so, we can use Relay EntryPoints, which are a set of APIs for efficiently loading both the code and data dependencies of any view in parallel. Check out our api reference for Entry Points:

It raises some interest on solving this particular parallelization problem. Maybe I didn't get it right, but I didn't find its documentation anywhere. Is this too experimental, and will be improved before releasing some examples?

josephsavona commented 4 years ago

Yup, this feature is currently not covered by the Relay docs; we plan to include EntryPoints when the relay-experimental package is stable. For now, please see our talk about this at ReactConf 2019 and accompanying blog post.

outerlook commented 4 years ago

Thanks, @josephsavona

stale[bot] commented 3 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

damikun commented 3 years ago

Hello any updates on docs to this or any code snippets ?

stale[bot] commented 2 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

dohaicuong commented 2 years ago

Hello any updates on docs to this or any code snippets ?

I managed to put together a working example with entrypoint if you need some reference. https://github.com/dohaicuong/relay-times/tree/master/relay-entrypoint/src/features/posts

steinybot commented 7 months ago

Duplicate here: https://github.com/facebook/relay/issues/3214