Skip to content

add hint regarding style and script tag locations in layout components #8621

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sarah11918 merged 4 commits into from
Jun 21, 2024
Merged

add hint regarding style and script tag locations in layout components #8621

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2de84ad
add hint regarding style and script tag locations in layout components
Trombach Jun 21, 2024
caea82d
add example `<style>` tag to sample layout
Trombach Jun 21, 2024
6d9f498
link formatting
sarah11918 Jun 21, 2024
35023e8
Merge branch 'main' into main
sarah11918 Jun 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/content/docs/en/basics/layouts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ We conventionally use the term "layout" for Astro components that provide common

But, there is nothing special about a layout component! They can [accept props](/en/basics/astro-components/#component-props) and [import and use other components](/en/basics/astro-components/#component-structure) like any other Astro component. They can include [UI frameworks components](/en/guides/framework-components/) and [client-side scripts](/en/guides/client-side-scripts/). They do not even have to provide a full page shell, and can instead be used as partial UI templates.

However, if a layout component does contain a page shell, its `<html>` element must be the parent of all other elements in the component. All [`<style>`](/en/guides/styling/#styling-in-astro) or [`<script>`](/en/guides/client-side-scripts/#using-script-in-astro) elements must be enclosed by the `<html>` tags.

Layout components are commonly placed in a `src/layouts` directory in your project for organization, but this is not a requirement; you can choose to place them anywhere in your project. You can even colocate layout components alongside your pages by [prefixing the layout names with `_`](/en/guides/routing/#excluding-pages).

## Sample Layout
Expand Down Expand Up @@ -43,6 +45,11 @@ const { title } = Astro.props;
</article>
<Footer />
</body>
<style>
Copy link
Copy Markdown
Member

@sarah11918 sarah11918 Jun 21, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SMRT! 🙌

h1 {
font-size: 2rem;
}
</style>
</html>
```

Expand Down