Skip to content
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

Jump to bottom

Add support for mobile safe areas #436

Draft
wants to merge 10 commits into
base: main
Choose a base branch
from
Draft

Add support for mobile safe areas #436

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
bafc11e
feat: add support for mobile safe areas
HiDeoo Jul 31, 2023
6d19bc3
Merge branch 'main' into hd-css-safe-areas
HiDeoo Aug 1, 2023
2209686
feat: improve mobile safe areas support
HiDeoo Aug 1, 2023
07cd5db
Merge branch 'main' into hd-css-safe-areas
HiDeoo Aug 5, 2023
f2d54c3
feat: improve content panel mobile safe areas support
HiDeoo Aug 5, 2023
24f908f
feat: improve toc mobile safe areas support
HiDeoo Aug 5, 2023
74942fd
fix: toc list mobile safe areas padding
HiDeoo Aug 5, 2023
14ee57e
feat: improve toc list mobile safe areas support
HiDeoo Aug 5, 2023
be864d0
refactor: remove some ltr selectors
HiDeoo Aug 5, 2023
4fca751
feat: improve sidebar mobile safe areas support
HiDeoo Aug 5, 2023
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
5 changes: 5 additions & 0 deletions .changeset/large-beans-draw.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@astrojs/starlight': patch
---

Add support for [mobile safe areas](https://webkit.org/blog/7929/designing-websites-for-iphone-x/)
4 changes: 3 additions & 1 deletion packages/starlight/components/ContentPanel.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@

<style>
.content-panel {
padding: 1.5rem var(--sl-content-pad-x);
padding: var(--sl-content-pad-y) var(--sl-safe-content-pad-right) var(--sl-content-pad-y)
var(--sl-safe-content-pad-left);
}
.content-panel + .content-panel {
border-top: 1px solid var(--sl-color-hairline);
padding-bottom: var(--sl-safe-content-pad-bottom);
}
.container {
max-width: var(--sl-content-width);
Expand Down
2 changes: 1 addition & 1 deletion packages/starlight/components/HeadSEO.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ const headDefaults: z.input<ReturnType<typeof HeadConfigSchema>> = [
{ tag: 'meta', attrs: { charset: 'utf-8' } },
{
tag: 'meta',
attrs: { name: 'viewport', content: 'width=device-width, initial-scale=1' },
attrs: { name: 'viewport', content: 'width=device-width, initial-scale=1, viewport-fit=cover' },
},
{ tag: 'title', content: title },
{ tag: 'link', attrs: { rel: 'canonical', href: canonical?.href } },
Expand Down
9 changes: 8 additions & 1 deletion packages/starlight/components/Header.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,15 @@ const { locale } = Astro.props;
:global(:root:not([data-has-toc])) {
--__toc-width: 0rem;
}
:global([dir='rtl']) .header {
--__sl-safe-nav-pad-x: var(--sl-safe-nav-pad-right);
}
.header {
--__sidebar-width: max(0rem, var(--sl-content-inline-start, 0rem) - var(--sl-nav-pad-x));
--__sl-safe-nav-pad-x: var(--sl-safe-nav-pad-left);
--__sidebar-width: max(
0rem,
var(--sl-content-inline-start, 0rem) - var(--__sl-safe-nav-pad-x)
);
--__main-column-fr: calc(
(
100% + var(--__sidebar-pad, 0rem) - var(--__toc-width, var(--sl-sidebar-width)) -
Expand Down
4 changes: 2 additions & 2 deletions packages/starlight/components/Sidebar.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ const { sidebar, locale } = Astro.props;
<style>
.sidebar {
height: 100%;
padding: 1rem var(--sl-sidebar-pad-x);
padding: 1rem var(--sl-safe-sidebar-pad-right) 1rem var(--sl-safe-sidebar-pad-left);
flex-direction: column;
gap: 1rem;
}
Expand All @@ -36,7 +36,7 @@ const { sidebar, locale } = Astro.props;

@media (min-width: 50rem) {
.sidebar > :global(:nth-last-child(2)) {
padding-bottom: 1rem;
padding-bottom: var(--sl-safe-sidebar-pad-bottom);
}
}
</style>
2 changes: 1 addition & 1 deletion packages/starlight/components/TableOfContents/MobileTableOfContents.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ const t = useTranslations(locale);
align-items: center;
height: var(--sl-mobile-toc-height);
border-bottom: 1px solid var(--sl-color-hairline-shade);
padding: 0.5rem 1rem;
padding: 0.5rem var(--sl-safe-mobile-toc-pad-right) 0.5rem var(--sl-safe-mobile-toc-pad-left);
font-size: var(--sl-text-xs);
outline-offset: var(--sl-outline-offset-inside);
}
Expand Down
6 changes: 5 additions & 1 deletion packages/starlight/components/TableOfContents/TableOfContentsList.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,18 +46,22 @@ const { toc, isMobile = false, depth = 0 } = Astro.props;
background-color: var(--sl-color-text-accent);
}
.isMobile a {
--pad-inline: 1rem;
--pad-inline: var(--sl-mobile-toc-list-pad-x);
display: flex;
justify-content: space-between;
gap: var(--pad-inline);
border-top: 1px solid var(--sl-color-gray-6);
border-radius: 0;
padding-block: 0.5rem;
padding-right: var(--sl-safe-mobile-toc-list-pad-right);
color: var(--sl-color-text);
font-size: var(--sl-text-sm);
text-decoration: none;
outline-offset: var(--sl-outline-offset-inside);
}
:global([dir='rtl']) .isMobile a {
padding-left: var(--sl-safe-mobile-toc-list-pad-left);
}
.isMobile:first-child > li:first-child > a {
border-top: 0;
}
Expand Down
9 changes: 6 additions & 3 deletions packages/starlight/layout/PageFrame.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ const t = useTranslations(locale);
width: 100%;
height: var(--sl-nav-height);
border-bottom: 1px solid var(--sl-color-hairline-shade);
padding: var(--sl-nav-pad-y) var(--sl-nav-pad-x);
padding-inline-end: var(--sl-nav-pad-x);
padding: var(--sl-safe-nav-pad-top) var(--sl-safe-nav-pad-right) var(--sl-nav-pad-y)
var(--sl-safe-nav-pad-left);
background-color: var(--sl-color-bg-nav);
}

Expand Down Expand Up @@ -78,7 +78,10 @@ const t = useTranslations(locale);

@media (min-width: 50rem) {
:global([data-has-sidebar]) .header {
padding-inline-end: var(--sl-nav-pad-x);
padding-right: var(--sl-safe-nav-pad-right);
}
:global([dir='rtl'][data-has-sidebar]) .header {
padding-left: var(--sl-safe-nav-pad-left);
}
.sidebar-pane {
--sl-sidebar-visibility: visible;
Expand Down
56 changes: 56 additions & 0 deletions packages/starlight/style/props.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,14 @@
--sl-nav-pad-x: 1rem;
--sl-nav-pad-y: 0.75rem;
--sl-mobile-toc-height: 3rem;
--sl-mobile-toc-pad-x: 1rem;
--sl-mobile-toc-list-pad-x: 1rem;
--sl-sidebar-width: 18.75rem;
--sl-sidebar-pad-x: 1rem;
--sl-sidebar-pad-bottom: 1rem;
--sl-content-width: 45rem;
--sl-content-pad-x: 1rem;
--sl-content-pad-y: 1.5rem;
--sl-menu-button-size: 2rem;
--sl-nav-gap: var(--sl-content-pad-x);
/* Offset required to show outline inside an element instead of round the outside */
Expand All @@ -108,6 +112,21 @@
--sl-z-index-menu: 5;
--sl-z-index-navbar: 10;
--sl-z-index-skiplink: 20;

/* Safe areas values */
--sl-safe-nav-pad-left: var(--sl-nav-pad-x);
--sl-safe-nav-pad-right: var(--sl-nav-pad-x);
--sl-safe-nav-pad-top: var(--sl-nav-pad-y);
--sl-safe-sidebar-pad-left: var(--sl-sidebar-pad-x);
--sl-safe-sidebar-pad-right: var(--sl-sidebar-pad-x);
--sl-safe-sidebar-pad-bottom: var(--sl-sidebar-pad-bottom);
--sl-safe-content-pad-left: var(--sl-content-pad-x);
--sl-safe-content-pad-right: var(--sl-content-pad-x);
--sl-safe-content-pad-bottom: var(--sl-content-pad-y);
--sl-safe-mobile-toc-pad-left: var(--sl-mobile-toc-pad-x);
--sl-safe-mobile-toc-pad-right: var(--sl-mobile-toc-pad-x);
--sl-safe-mobile-toc-list-pad-left: var(--sl-mobile-toc-list-pad-x);
--sl-safe-mobile-toc-list-pad-right: var(--sl-mobile-toc-list-pad-x);
}

:root[data-theme='light'],
Expand Down Expand Up @@ -179,3 +198,40 @@
--sl-mobile-toc-height: 0rem;
}
}

@supports (padding: max(0px)) {
:root {
--sl-safe-nav-pad-left: max(var(--sl-nav-pad-x), env(safe-area-inset-left));
--sl-safe-nav-pad-right: max(var(--sl-nav-pad-x), env(safe-area-inset-right));
--sl-safe-nav-pad-top: max(var(--sl-nav-pad-y), env(safe-area-inset-top));
--sl-safe-sidebar-pad-left: max(var(--sl-sidebar-pad-x), env(safe-area-inset-left));
--sl-safe-sidebar-pad-right: max(var(--sl-sidebar-pad-x), env(safe-area-inset-right));
--sl-safe-sidebar-pad-bottom: max(var(--sl-sidebar-pad-bottom), env(safe-area-inset-bottom));
--sl-safe-content-pad-left: max(var(--sl-content-pad-x), env(safe-area-inset-left));
--sl-safe-content-pad-right: max(var(--sl-content-pad-x), env(safe-area-inset-right));
--sl-safe-content-pad-bottom: max(var(--sl-content-pad-y), env(safe-area-inset-bottom));
--sl-safe-mobile-toc-pad-left: max(var(--sl-mobile-toc-pad-x), env(safe-area-inset-left));
--sl-safe-mobile-toc-pad-right: max(var(--sl-mobile-toc-pad-x), env(safe-area-inset-right));
--sl-safe-mobile-toc-list-pad-left: max(
var(--sl-mobile-toc-list-pad-x),
env(safe-area-inset-left)
);
--sl-safe-mobile-toc-list-pad-right: max(
var(--sl-mobile-toc-list-pad-x),
env(safe-area-inset-right)
);
}

@media (min-width: 50rem) {
:root[data-has-sidebar] {
--sl-safe-sidebar-pad-right: var(--sl-sidebar-pad-x);
--sl-safe-content-pad-left: var(--sl-content-pad-x);
--sl-safe-mobile-toc-pad-left: var(--sl-mobile-toc-pad-x);
}
:root[dir='rtl'][data-has-sidebar] {
--sl-safe-sidebar-pad-left: var(--sl-sidebar-pad-x);
--sl-safe-content-pad-right: var(--sl-content-pad-x);
--sl-safe-mobile-toc-pad-right: var(--sl-mobile-toc-pad-x);
}
}
}