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

fix(page_sidebar): Improve page sidebar and mobile flow behavior #908

Merged
merged 18 commits into from
Nov 17, 2023
Merged

fix(page_sidebar): Improve page sidebar and mobile flow behavior #908

Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
5419f5f
feat(page_sidebar): Sidebar is always full height, even on mobile
gadenbuie Nov 16, 2023
d737f0e
refactor(sidebar): Use css vars for toggle position
gadenbuie Nov 16, 2023
933af8e
test: update page snapshots
gadenbuie Nov 16, 2023
1ddf49c
Resave distributed files (GitHub Action)
gadenbuie Nov 16, 2023
f630f71
Resave data (GitHub Action)
gadenbuie Nov 16, 2023
608df81
feat(flow-utils): Rename `.bslib-flow-mobile` and add `.bslib-flow-{s…
gadenbuie Nov 16, 2023
c9aee06
tests: update snaps again
gadenbuie Nov 16, 2023
e9c9c5b
refactor: simplify flow rules for readability
gadenbuie Nov 16, 2023
f504940
feat(page_navbar): Support same behavior on page navbar
gadenbuie Nov 16, 2023
6821a1c
chore: remove unused code
gadenbuie Nov 16, 2023
13c45ac
chore: ensure expanded sidebar leaves one icon of space in main conta…
gadenbuie Nov 16, 2023
4a1af8b
Merge "origin/main" into fix/page-sidebar-height-mobile
gadenbuie Nov 16, 2023
7457bae
Resave distributed files (GitHub Action)
gadenbuie Nov 16, 2023
768efb6
Resave data (GitHub Action)
gadenbuie Nov 16, 2023
719f276
fix: typo
gadenbuie Nov 16, 2023
6207a1b
chore: Remove flow breakpoint classes
gadenbuie Nov 16, 2023
0ef9edc
Resave distributed files (GitHub Action)
gadenbuie Nov 16, 2023
a1ed5fc
Merge "origin/main" into fix/page-sidebar-height-mobile
gadenbuie Nov 17, 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: 3 additions & 2 deletions R/page.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,10 +178,10 @@ page_fillable <- function(
theme = theme,
lang = lang,
class = "bslib-page-fill bslib-gap-spacing",
class = if (!fillable_mobile) "bslib-flow-mobile",
style = css(
padding = validateCssPadding(padding),
gap = validateCssUnit(gap),
"--bslib-page-fill-mobile-height" = if (fillable_mobile) "100%" else "auto"
gap = validateCssUnit(gap)
),
...,
tags$head(tags$style("html { height: 100%; }")),
Expand Down Expand Up @@ -393,6 +393,7 @@ page_navbar <- function(
theme = theme,
lang = lang,
class = "bslib-page-navbar",
class = if (!is.null(sidebar)) "has-page-sidebar",
navs_bar_(
..., title = title, id = id, selected = selected,
sidebar = sidebar, fillable = fillable,
Expand Down
Binary file modified R/sysdata.rda
View file
Open in desktop
Binary file not shown.
2 changes: 1 addition & 1 deletion inst/components/dist/components.css
View file
Open in desktop

Large diffs are not rendered by default.

60 changes: 58 additions & 2 deletions inst/components/scss/page_fillable.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,63 @@
}

@include media-breakpoint-down(sm) {
.bslib-page-fill {
height: var(--bslib-page-fill-mobile-height, auto);
.bslib-flow-mobile {
> .html-fill-item {
flex: 0 0 auto;
}

&.bslib-page-sidebar,
&.bslib-page-navbar.has-page-sidebar {
// Keep filling behavior of outer container
> .html-fill-item {
flex: 1 1 auto;
}
}

&.bslib-page-sidebar,
&.bslib-page-navbar.has-page-sidebar > .html-fill-container {
> .bslib-sidebar-layout {
// Switch to flow layout in main area of the sidebar container
> .main > .html-fill-item {
flex: 0 0 auto;
}

&:not(.sidebar-right) {
> .main {
padding-left: var(--_padding-icon);
padding-top: var(--_padding);
}
> .collapse-toggle {
left: calc(var(--_icon-size) / 2);
}
}
&.sidebar-right {
> .main {
padding-right: var(--_padding-icon);
}
> .collapse-toggle {
right: calc(var(--_icon-size) / 2);
}
}
}
}
}
}

@include media-breakpoint-down(sm) {
.bslib-flow-sm > .html-fill-item {
flex: 0 0 auto;
}
}

@include media-breakpoint-down(md) {
.bslib-flow-md > .html-fill-item {
flex: 0 0 auto;
}
}

@include media-breakpoint-down(lg) {
.bslib-flow-lg > .html-fill-item {
flex: 0 0 auto;
gadenbuie marked this conversation as resolved.
Show resolved Hide resolved
}
}
16 changes: 6 additions & 10 deletions inst/components/scss/sidebar.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ $bslib-sidebar-bg: rgba(var(--bs-emphasis-color-rgb, 0,0,0), 0.05) !default;
$bslib-sidebar-fg: var(--bs-emphasis-color, black) !default;
$bslib-sidebar-toggle-bg: rgba(var(--bs-emphasis-color-rgb, 0,0,0), 0.1) !default;
$bslib-sidebar-border: var(--bs-card-border-width, #{$card-border-width}) solid var(--bs-card-border-color, #{$card-border-color}) !default;
$bslib-sidebar-column-sidebar: Min(calc(100% - var(--_icon-size)), var(--_sidebar-width));
$bslib-sidebar-column-sidebar: Min(calc(100% - var(--_padding-icon)), var(--_sidebar-width));
Copy link
Member Author

Choose a reason for hiding this comment

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

In desktop mode, if the sidebar is too wide for the container, this ensures that the sidebar doesn't expand too far, leaving one collapse icon's worth of space in the main area. Which is useful if there are nested sidebars. (Slightly tangential to this PR but I didn't want to forget to fix this.)



.bslib-sidebar-layout {
Expand All @@ -27,6 +27,8 @@ $bslib-sidebar-column-sidebar: Min(calc(100% - var(--_icon-size)), var(--_sideba
--_toggle-transform: var(--bslib-collapse-toggle-transform, 0deg);
--_toggle-transition-easing: var(--bslib-sidebar-toggle-transition-easing, cubic-bezier(1, 0, 0, 1));
--_toggle-right-transform: var(--bslib-collapse-toggle-right-transform, 180deg);
--_toggle-position-y: calc(var(--_js-toggle-count-this-side, 0) * calc(var(--_icon-size) + var(--_padding)) + var(--_icon-size, 1rem) / 2);
--_toggle-position-x: calc(-2.5 * var(--_icon-size) - var(--bs-card-border-width, 1px));
--_max-height-mobile: var(--bslib-sidebar-max-height-mobile);
--_column-main: minmax(0, 1fr);
// Calculate the height of all toggle buttons in nested sidebar layouts
Expand Down Expand Up @@ -72,8 +74,6 @@ $bslib-sidebar-column-sidebar: Min(calc(100% - var(--_icon-size)), var(--_sideba

> .sidebar {
grid-column: 1 / 2;
width: 100%;
height: 100%;
border-right: var(--_vert-border);
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think we should bring back the width: 100%

Copy link
Member Author

Choose a reason for hiding this comment

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

I checked all of our rules and .sidebar always has both grid-column and grid-row properties, which drive the height and width of the sidebar container. I'm comfortable with both being redundant, but happy to leave width for now if you want.

border-top-right-radius: 0;
border-bottom-right-radius: 0;
Expand Down Expand Up @@ -257,16 +257,12 @@ $bslib-sidebar-column-sidebar: Min(calc(100% - var(--_icon-size)), var(--_sideba
> .collapse-toggle {
color: var(--_main-fg);
// The CSS variable (set via JS) is here to help avoid overlapping toggles
top: calc(
var(--_js-toggle-count-this-side, 0) *
calc(var(--_icon-size) +
var(--_padding)
) + var(--_icon-size, 1rem) / 2);
right: calc(-2.5 * var(--_icon-size) - var(--bs-card-border-width, 1px));
top: var(--_toggle-position-y);
right: var(--_toggle-position-x);
}

&.sidebar-right > .collapse-toggle {
left: calc(-2.5 * var(--_icon-size) - var(--bs-card-border-width, 1px));
left: var(--_toggle-position-x);
right: unset;
}
}
Expand Down
4 changes: 2 additions & 2 deletions tests/testthat/_snaps/page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
renderTags(page_sidebar("main", title = "Title", sidebar = sidebar(open = "always")))$
html
Output
<body class="bslib-page-fill bslib-gap-spacing bslib-page-sidebar html-fill-container" style="padding:0px;gap:0px;--bslib-page-fill-mobile-height:auto;">
<body class="bslib-page-fill bslib-gap-spacing bslib-flow-mobile bslib-page-sidebar html-fill-container" style="padding:0px;gap:0px;">
<h1 class="bslib-page-title">Title</h1>
<div class="bslib-sidebar-layout bslib-mb-spacing html-fill-item" data-bslib-sidebar-border="false" data-bslib-sidebar-border-radius="false" data-bslib-sidebar-init="TRUE" data-bslib-sidebar-open="always" data-require-bs-caller="layout_sidebar()" data-require-bs-version="5" style="--_sidebar-width:250px;--_max-height-mobile:250px;">
<div class="main bslib-gap-spacing html-fill-container">main</div>
Expand All @@ -52,7 +52,7 @@
Code
renderTags(page_sidebar("main", title = "Title", sidebar = "side"))$html
Output
<body class="bslib-page-fill bslib-gap-spacing bslib-page-sidebar html-fill-container" style="padding:0px;gap:0px;--bslib-page-fill-mobile-height:auto;">
<body class="bslib-page-fill bslib-gap-spacing bslib-flow-mobile bslib-page-sidebar html-fill-container" style="padding:0px;gap:0px;">
<h1 class="bslib-page-title">Title</h1>
<div class="bslib-sidebar-layout bslib-mb-spacing html-fill-item" data-bslib-sidebar-border="false" data-bslib-sidebar-border-radius="false" data-bslib-sidebar-init="TRUE" data-bslib-sidebar-open="desktop" data-require-bs-caller="layout_sidebar()" data-require-bs-version="5" style="--_sidebar-width:250px;--_max-height-mobile:250px;">
<div class="main bslib-gap-spacing html-fill-container">main</div>
Expand Down
Loading