Docs: add .astro Syntax guide
#137
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
drwpow
reviewed
Apr 28, 2021
drwpow
reviewed
Apr 28, 2021
|
|
||
| When you finally do need to introduce dynamic functionality, Astro allows you to _bring your own framework_, so you're free to use any component format you'd like without commiting to a holistic architectural approach up-front. "The big question" is deferred until it actually needs to be answered. | ||
|
|
||
| During a long-term project, you might even decide to switch frameworks somewhere down the road. Since Astro decouples decisions about data-loading and static rendering from your framework, that decision has a much smaller impact—try out the new framework on a single page or even mix both frameworks on some pages while you migrate. |
drwpow
reviewed
Apr 28, 2021
| | Requires JS import | No | Yes, `jsxPragma` (`React` or `h`) must be in scope | | ||
| | Fragments | Automatic | Wrap with `<Fragment>` or `<>` | | ||
| | Mutliple frameworks per-file | Yes | No | | ||
| | Modifying `<head>` | Just use `<head>` | Per-framework (`<Head>`, `<svelte:head>`, etc) | |
drwpow
reviewed
Apr 28, 2021
drwpow
approved these changes
Apr 28, 2021
| `.astro` components can also accept props when they are rendered. Public props can be marked using the `export` keyword. | ||
|
|
||
| Local values are overwritten when props are passed, otherwise they are considered the default value. | ||
|
|
There was a problem hiding this comment.
This is a pretty confusing/surprising API. Typically export provides data to other modules, but this inverts that. I’m not sure I have a better solution in mind, but I’ll think on it if there’s interest on the Astro team.
There was a problem hiding this comment.
Fair point. This is borrowed from Svelte's prop syntax. One benefit is that it makes it really easy to statically analyze for IDE support, but I agree that overloading the export keyword isn't great.
Would be interested to hear alternative suggestions! I'll spin up a separate issue.
Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Adds
docs/syntax.mdto provide an overview of the Astro syntaxTesting
N/A
Docs