feat: add defer-hydration to ssr renderer
#6492
Conversation
nicholasrice
requested review from
awentzel,
chrisdholt,
Falkicon,
EisenbergEffect and
janechu
as code owners
…tps://github.com/microsoft/fast into users/nirice/add-defer-hydration-to-ssr-renderer
|
|
||
| This attribute is added automatically during custom element rendering to all FAST custom elements. If your app does not require orchestrating element hydration, emission of this attribute can be prevented by configuring the renderer: | ||
| ```ts | ||
| const { templateRenderer } = fastSSR({deferHydration: false}); |
There was a problem hiding this comment.
I'm wondering if we should flip the default on this. Seems like most folks working with the library will want to hydrate automatically, yes?
There was a problem hiding this comment.
I went back and forth on it. I think most applications of a reasonable size will want to defer hydration because they'll have services and contexts that will need to get set up, so hydration order will matter. We can still make it opt-in though, if that is a more predictable interface
There was a problem hiding this comment.
I think switching the default to be false is probably more what's expected, especially if someone is getting started.
I think there could be, yes. Either by element CTOR or by element instance. Another approach applications can take is to handle that logic in client-code. For example, hydration modes of "immediate" (remove attribute immediately), "enter" (remove attribute when the element enters the viewport), "interactive" (mouseover, click, focus). These are all features we can explore as follow-ups. I'll make the change to make defer-hydration opt-in. That will make it easier to expand that configuration option with additional types to support CTOR or callback options for fine-grain control. |
nicholasrice
deleted the
users/nirice/add-defer-hydration-to-ssr-renderer
branch
* yield defer-hydration attribute when configured * Make defer-hydration the default behavior, fixing tests * adding disable deferHydration test * update readme * update config comments * fixing documentation * Change files * update API report * make deferHydration false by default Co-authored-by: nicholasrice <nicholasrice@users.noreply.github.com>
Pull Request
📖 Description
This PR adds
defer-hydrationattribute emission to@microsoft/fast-ssr. When configured,@microsoft/fast-elementwill wait until the attribute is removed to hydrate its view and connect its behaviors.🎫 Issues
👩💻 Reviewer Notes
📑 Test Plan
✅ Checklist
General
$ yarn changeComponent-specific
⏭ Next Steps