Explain that props are updated on navigation

[matthewp]

Description (required)

With withastro/astro#10136 transition:persist is changing to update props upon navigation when used on an island. This explains that props will trigger a re-render.

Related issues & labels (optional)

For Astro version: 4.5. See astro PR #10136.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
docs	✅ Ready (Inspect)	Visit Preview	Mar 8, 2024 9:46pm

1 Ignored Deployment

Name	Status	Preview	Updated (UTC)
docs-i18n	⬜️ Ignored (Inspect)		Mar 8, 2024 9:46pm

[sarah11918]

@matthewp - Is this example (in the same section, but just above what you added) still accurate? How are we making clear the distinction between a component's props vs its state?

This change now updates island props upon navigation, so would this counter get set back to 5 by default?

Can you make sure reading this entire section on state, that everything in it still makes sense?

[sarah11918]

Thanks @matthewp !

I took some of the description from the language of the changeset in the implementation PR to provide a use-case, and to include the version it was introduced.

Please also read the entire section now that the default props behaviour has changed, and make sure the existing description here is still accurate, or whether mention of the new default behaviour might need to be corrected earlier, too!

[matthewp]

@sarah11918 It might be a good idea to rename count to initialCount or something, would that make it more clear? In a case like this you are really providing the initial value to the component. The component then keeps the "real" count in its state. That state will not be affected by navigation.

[matthewp]

@sarah11918 reworded things just a little bit, let me know what you think?

[sarah11918]

Approved!