Documentation layout fixes (#39)

Refactor documentation layout for better scrolling and viewing on smaller screens

Author: jhardy

CHANGELOG.md

@@ -8,7 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## UNRELEASED
 
 ### Changed
-
+- Improvements to documentation layout and scrolling behavior
 - SVG for `ApplicationSelect`,`ArrowChange`,`Beaker`,`BrowseTable`,`ChangeHistory`,`DimensionFill`,`Explore`,`LogoRings`,`NoteOutline`,`Notes`,`Reports`,`SqlRunner`,`User`,`UserAttributes`,`Users`,`ViewGrid`,`VisArea`,`VisBar`,`VisColumn`,`VisLine`,`VisMap`,`VisPie`,`VisScatter`,`VisSingleValue`,`VisTable` icons resized redrawn to fit on the correct icon grid.
 - Implement a vertical layout for the Code Sandbox toolbar to prevent unintentional obfuscation of code samples
 

packages/www/src/Layout/Documentation.tsx

@@ -29,7 +29,14 @@ import { graphql } from 'gatsby'
 import React, { FC } from 'react'
 import Helmet from 'react-helmet'
 import styled from 'styled-components'
-import { Heading, Divider, ListItem, Link, List } from '@looker/components'
+import {
+  Heading,
+  Divider,
+  Flex,
+  ListItem,
+  Link,
+  List,
+} from '@looker/components'
 import { ComponentResources, ComponentStatus, Props } from '../Shared'
 import Layout, { LayoutMain } from './Layout'
 
@@ -88,7 +95,7 @@ const DocumentationLayout = (props: DocQuery) => {
 
   return (
     <Layout>
-      <Grid>
+      <Flex>
         <LayoutMain>
           <Helmet title={`${title} - ${site.siteMetadata.title}`} />
           <Heading as="h1" fontSize="xxxxlarge" fontWeight="light">
@@ -106,27 +113,26 @@ const DocumentationLayout = (props: DocQuery) => {
           />
           <TableOfContents toc={mdx.tableOfContents} />
         </Meta>
-      </Grid>
+      </Flex>
     </Layout>
   )
 }
 
 export default DocumentationLayout
 
 const Meta = styled.div`
-  padding: ${props => props.theme.space.large};
-  height: 100%;
   background: ${props => props.theme.colors.palette.charcoal000};
-`
-
-const Grid = styled.div`
-  display: grid;
-  grid-template-columns: 1fr 18rem;
-  grid-template-rows: 1fr;
-
   height: 100vh;
-`
+  overflow-y: auto;
+  padding: ${props => props.theme.space.large};
+  position: sticky;
+  top: 0;
+  width: 17rem;
 
+  @media screen and (max-width: ${props => props.theme.breakpoints[3]}) {
+    display: none;
+  }
+`
 export const pageQuery = graphql`
   query Doc($id: String) {
     site {

packages/www/src/Layout/Layout.tsx

@@ -3,17 +3,17 @@
  MIT License
 
  Copyright (c) 2019 Looker Data Sciences, Inc.
- 
+
  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:
- 
+
  The above copyright notice and this permission notice shall be included in all
  copies or substantial portions of the Software.
- 
+
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -67,13 +67,16 @@ export const PageLayout = styled.div<SidebarStyleProps>`
   display: grid;
   grid-template-rows: 1fr;
   grid-template-columns: ${({ open }) =>
-    open ? '18.75rem 0 1fr' : '1.5rem 0 1fr'};
+    open ? '17.5rem 0 1fr' : '1.5rem 0 1fr'};
   grid-template-areas: 'sidebar divider main';
 `
 
-const LayoutSidebar = styled.nav`
+const LayoutSidebar = styled.aside`
   grid-area: sidebar;
-  overflow-y: auto;
+  height: 100vh;
+  position: fixed;
+  top: 0;
+  width: 17.5rem;
 `
 
 const ContentArea = styled.div`
@@ -85,7 +88,7 @@ export const LayoutMain = styled.main`
   overflow: auto;
   margin: 0 auto;
   padding: ${({ theme: { space } }) =>
-    `${space.xxlarge} ${space.xxlarge} ${space.xxxxlarge}`};
+    `${space.xxlarge} ${space.xxxlarge} ${space.xxxxlarge}`};
 `
 
 const SidebarDivider = styled.div<SidebarStyleProps>`

packages/www/src/Layout/Navigation/Navigation.tsx

@@ -42,7 +42,7 @@ interface NavigationProps {
 const Navigation: FC<NavigationProps> = ({ sitemap, headerHeight }) => (
   <StyledSidebar>
     <Header height={headerHeight} />
-    <Box>
+    <SidebarNavWrapper height={`calc(100% - ${headerHeight})`}>
       <Location>
         {({ location }) => (
           <LocationContext.Provider value={location.pathname}>
@@ -52,10 +52,14 @@ const Navigation: FC<NavigationProps> = ({ sitemap, headerHeight }) => (
           </LocationContext.Provider>
         )}
       </Location>
-    </Box>
+    </SidebarNavWrapper>
   </StyledSidebar>
 )
 
+const SidebarNavWrapper = styled(Box)`
+  overflow-y: auto;
+`
+
 const StyledSidebar = styled(Sidebar)<SidebarProps>`
   background: ${props => lighten(0.6, props.theme.colors.palette.purple000)};
   height: 100%;

packages/www/src/Layout/SidebarToggle/SidebarToggle.tsx

@@ -66,6 +66,7 @@ const SidebarToggleWrapper = styled.div<WrapperProps>`
   ${IconButton} {
     background: #fff;
     transform: translateX(-50%) translateY(-50%);
+    position: fixed;
   }
 `