Document limitations of island prop serialization

[ascorbic]

📚 Subject area/topic

Islands

📋 Suggested page

• guides/framework-components
• guides/server-islands

📋 General description or bullet points (if proposing new content)

The framework components guide documents the fact that you can't pass functions to client components, but it doesn't document any of the other restrictions. It also doesn't document any of these for server islands. Values must be serializable, and the following types are supported: plain object, number, string, Array, Map, Set, RegExp, Date, BigInt, URL, Uint8Array, Uint16Array, Uint32Array, Infinity. Circular references and functions are not supported.

🖥️ Reproduction of code samples in StackBlitz

No response

[sarah11918]

Thanks Matt! Where are our framework/island fans? Who wants to help update docs??

[branberry]

Hey Sarah! I'm still an Astro newbie, but I'd be open to giving this a go.

[sarah11918]

Hey @branberry , sounds great!

I'll just note that we are closing up shop on v4 docs at the moment, so any new content should be made in a PR to the 5.0.0-beta branch!

Also, as we have a lot of moving parts getting ready for v5, we would prefer not to have longstanding draft PRs open and sticking around, so feel free to use this space for questions/discussions and others are welcome to chime in. When you feel confident that you have a PR ready to go for review, then we'd happily accept a PR that is closer to finished rather than WIP! 🙌

[branberry]

Gotcha! Thank you for letting me know. I'll make sure to withhold my PR until it's all ready for review 👍

[sarah11918]

@branberry Happy new year! Just wondering whether you're still interested in working on this!

[branberry]

Hi @sarah11918! Thank you for bumping this. Yes, I am still interested in working on this, apologies for the delay! It fell off of my radar, but I have a bit more bandwidth to work on this again.