Skip to content

USWDS - Documentation page: Improve backwards compatibility with sidenav order #5809

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
thisisdano merged 6 commits into from
Mar 11, 2024
Merged

USWDS - Documentation page: Improve backwards compatibility with sidenav order #5809

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
990bf78
Add sidenav setting to allow reordering single sidenav with a11y warning
Mar 8, 2024
57298a4
Fix HTML output by setting default desktop sidenav classes
Mar 8, 2024
17600ba
Run prettier
Mar 8, 2024
32e8a78
Set default content in storybook
Mar 8, 2024
aee4d17
Run prettier
Mar 8, 2024
ba608d1
Update template comments
Mar 8, 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
29 changes: 24 additions & 5 deletions packages/templates/usa-documentation/includes/_usa-docs-inner.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,31 @@
]
}%}

{% set desktop_sidenav_classes = "display-none desktop:display-block desktop:grid-col-3" %}

{# If true, revert to the old single sidenav behavior. #}
{% if sidenav_reorder %}
{% set desktop_sidenav_classes = "" %}
{% endif %}

<div class="usa-section">
<div class="grid-container">
<div class="grid-row grid-gap">
<div class="usa-layout-docs__sidenav display-none desktop:display-block desktop:grid-col-3">
{% include "@components/usa-sidenav/src/usa-sidenav.twig" with sidenav_settings %}
<div class="usa-layout-docs__sidenav {{ desktop_sidenav_classes }}">
{% include "@components/usa-sidenav/src/usa-sidenav.twig" with sidenav_settings %}
</div>

<main class="desktop:grid-col-9 usa-prose" id="main-content">
{% if sidenav_reorder %}
<style>
.usa-layout-docs__sidenav {
outline: 1px dashed orange;
}
</style>

Ensure <code>$theme-sidenav-reorder: true</code> in theme settings & in StorybookJS. The sidenav will be placed <em>after</em> main content and a compile warning should display.
{% endif %}

Comment on lines +58 to +67
Copy link
Contributor Author

@mejiaj mejiaj Mar 11, 2024

Choose a reason for hiding this comment

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

This doesn't display in final HTML build because it's controlled by the StorybookJS control in usa-docs.stories.js.

uswds/packages/templates/usa-documentation/usa-docs.stories.js

Lines 14 to 20 in ba608d1

TestDocumentationReorder.argTypes = {
sidenav_reorder: {
control: { type: "boolean" },
defaultValue: false,
name: "Reorder with CSS",
},
};

<h1>Page heading (h1)</h1>
<p class="usa-intro">The page heading communicates the main focus of the page. Make your page heading descriptive and keep it succinct.</p>
<h2 id="section-heading-h2">Section heading (h2)</h2>
Expand All @@ -60,10 +77,12 @@
<p>Read the full documentation on our side navigation on the component page.</p>
</main>
</div>


{# Hide additional sidenav if we're using pre-3.8.0 behavior. #}
{% if not sidenav_reorder %}
<div class="usa-layout-docs__sidenav desktop:display-none">
{% include "@components/usa-sidenav/src/usa-sidenav.twig" with sidenav_settings %}
{% include "@components/usa-sidenav/src/usa-sidenav.twig" with sidenav_settings %}
</div>
{% endif %}
</div>
</div>

11 changes: 10 additions & 1 deletion packages/templates/usa-documentation/usa-docs.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,18 @@ import Component from "./usa-docs.twig";

export default {
title: "Pages/Documentation Page",
args: DefaultContent,
};

const Template = (args) => Component(args);

export const DocumentationPage = Template.bind({});
DocumentationPage.args = DefaultContent;

export const TestDocumentationReorder = Template.bind({});
TestDocumentationReorder.argTypes = {
sidenav_reorder: {
control: { type: "boolean" },
defaultValue: false,
name: "Reorder with CSS",
},
};
17 changes: 17 additions & 0 deletions packages/usa-layout-docs/src/styles/_usa-layout-docs.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,26 @@
@use "uswds-core" as *;

$sidenav-reorder-warning: "$theme-sidenav-reorder is enabled and has accessibility concerns. This behavior has a negative impact on users of assistive technologies.";

.usa-layout-docs__sidenav {
padding-top: units(4);

@include at-media("desktop") {
padding-top: 0;
}

// Revert to >3.8.0 behavior and give a warning.
@if $theme-sidenav-reorder {
@warn $sidenav-reorder-warning;

&:first-of-type {
@include grid-col(12);
order: 2;

@include at-media("desktop") {
@include grid-col(3);
order: 0;
}
}
}
}
1 change: 1 addition & 0 deletions packages/uswds-core/src/styles/settings/_settings-components.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,7 @@ $theme-search-min-width: 27ch !default;
// Sidenav
$theme-sidenav-current-border-width: 0.5 !default;
$theme-sidenav-font-family: "ui" !default;
$theme-sidenav-reorder: false !default;

// Site Alert
$theme-site-alert-max-width: "desktop" !default;
Expand Down