commit 0b2c8db694dd5541d47c033108d8bd975e699e38 · kitten.sh/urql

packages/site/package.json

···

       32
       32
        
         "dependencies": {

     

       33
       33
        
           "@mdx-js/react": "^1.6.22",

     

       34
       34
        
           "formidable-oss-badges": "0.3.5",

     

       35
       35
       +
           "fuse.js": "^6.4.6",

     

       35
       36
        
           "history": "^4.7.2",

     

       36
       37
        
           "path": "^0.12.7",

     

       37
       38
        
           "preact": "^10.5.7",

+4 -3

packages/site/src/components/navigation.js

···

       10
       10
        
         right: 0;

     

       11
       11
        
         bottom: 0;

     

       12
       12
        
         min-height: 100%;

     

       13
       13
       +
         width: ${p => p.theme.layout.sidebar};

     

       13
       14
        
       

     

       14
       15
        
         @media ${({ theme }) => theme.media.sm} {

     

       15
       16
        
           display: block;

     

       16
       17
        
           position: relative;

     

       17
       17
       -
           width: ${p => p.theme.layout.sidebar};

     

       18
       18
        
           margin-left: calc(2 * ${p => p.theme.layout.stripes});

     

       19
       19
        
         }

     

       20
       20
        
       `;

     
···

       49
       49
        
         background-color: ${p => p.theme.colors.bg};

     

       50
       50
        
         border-right: 1px solid ${p => p.theme.colors.border};

     

       51
       51
        
         border-top: 1px solid ${p => p.theme.colors.border};

     

       52
       52
       +
         width: ${p => p.theme.layout.sidebar};

     

       52
       53
        
       

     

       53
       54
        
         @media ${({ theme }) => theme.media.sm} {

     

       54
       55
        
           border: none;

     

       55
       56
        
           background: none;

     

       56
       57
        
           padding-top: ${p => p.theme.spacing.md};

     

       57
       57
       -
           width: ${p => p.theme.layout.sidebar};

     

       58
       58
        
         }

     

       59
       59
        
       `;

     

       60
       60
        
       

     
···

       107
       107
        
         color: ${p => p.theme.colors.passive};

     

       108
       108
        
         font-weight: ${p => p.theme.fontWeights.body};

     

       109
       109
        
         text-decoration: none;

     

       110
       110
       -
         margin-top: ${p => p.theme.spacing.xs};

     

       110
       110
       +
         margin: ${p =>

     

       111
       111
       +
           `${p.theme.spacing.xs} 0 0 ${p.nested ? p.theme.spacing.sm : 0}`};

     

       111
       112
        
       

     

       112
       113
        
         &:first-child {

     

       113
       114
        
           margin-top: 0;

+40

packages/site/src/components/sidebar-search-input.js

···

       1
       1
       +
       import React from 'react';

     

       2
       2
       +
       import PropTypes from 'prop-types';

     

       3
       3
       +
       import styled from 'styled-components';

     

       4
       4
       +
       

     

       5
       5
       +
       const StyledInput = styled.input`

     

       6
       6
       +
         background-color: rgba(255, 255, 255, 0.8);

     

       7
       7
       +
         border: none;

     

       8
       8
       +
         border-radius: 0.5rem;

     

       9
       9
       +
         color: ${p => p.theme.colors.text};

     

       10
       10
       +
         font-family: ${p => p.theme.fonts.body};

     

       11
       11
       +
         font-size: 1.6rem;

     

       12
       12
       +
         line-height: 2.3rem;

     

       13
       13
       +
         letter-spacing: -0.6px;

     

       14
       14
       +
         margin: ${p =>

     

       15
       15
       +
           `${p.theme.spacing.sm} 0 ${p.theme.spacing.sm} calc(${p.theme.spacing.xs} * -1.5)`};

     

       16
       16
       +
         padding: ${p =>

     

       17
       17
       +
           `${p.theme.spacing.xs} calc(${p.theme.spacing.xs} * 1.5) ${p.theme.spacing.xs}`};

     

       18
       18
       +
         width: calc(100% + 1.8rem);

     

       19
       19
       +
         background-color: ${p => p.theme.colors.passiveBg};

     

       20
       20
       +
       

     

       21
       21
       +
         @media ${p => p.theme.media.sm} {

     

       22
       22
       +
           background-color: ${p => p.theme.colors.bg};

     

       23
       23
       +
         }

     

       24
       24
       +
       `;

     

       25
       25
       +
       

     

       26
       26
       +
       const SidebarSearchInput = ({ value, onHandleInputChange }) => (

     

       27
       27
       +
         <StyledInput

     

       28
       28
       +
           onChange={onHandleInputChange}

     

       29
       29
       +
           placeholder="Filter..."

     

       30
       30
       +
           type="search"

     

       31
       31
       +
           value={value}

     

       32
       32
       +
         />

     

       33
       33
       +
       );

     

       34
       34
       +
       

     

       35
       35
       +
       SidebarSearchInput.propTypes = {

     

       36
       36
       +
         value: PropTypes.string,

     

       37
       37
       +
         onHandleInputChange: PropTypes.func,

     

       38
       38
       +
       };

     

       39
       39
       +
       

     

       40
       40
       +
       export default SidebarSearchInput;

+172 -27

packages/site/src/components/sidebar.js

···

       1
       1
        
       /* eslint-disable react-hooks/rules-of-hooks */

     

       2
       2
        
       

     

       3
       3
       -
       import React, { Fragment, useMemo } from 'react';

     

       3
       3
       +
       import React, { Fragment, useMemo, useState } from 'react';

     

       4
       4
        
       import styled from 'styled-components';

     

       5
       5
       +
       import Fuse from 'fuse.js';

     

       5
       6
        
       import { useBasepath } from 'react-static';

     

       6
       7
        
       import { Link, useLocation } from 'react-router-dom';

     

       7
       8
        
       import * as path from 'path';

     

       8
       9
        
       

     

       9
       9
       -
       import { useMarkdownTree, useMarkdownPage } from 'react-static-plugin-md-pages';

     

       10
       10
       +
       import { useMarkdownPage, useMarkdownTree } from 'react-static-plugin-md-pages';

     

       10
       11
        
       

     

       11
       12
        
       import {

     

       12
       13
        
         SidebarNavItem,

     
···

       17
       18
        
         SideBarStripes,

     

       18
       19
        
         ChevronItem,

     

       19
       20
        
       } from './navigation';

     

       21
       21
       +
       import SidebarSearchInput from './sidebar-search-input';

     

       20
       22
        
       

     

       21
       23
        
       import logoSidebar from '../assets/sidebar-badge.svg';

     

       22
       24
        
       

     

       23
       25
        
       const HeroLogoLink = styled(Link)`

     

       24
       24
       -
         display: flex;

     

       26
       26
       +
         display: none;

     

       25
       27
        
         flex-direction: row;

     

       26
       28
        
         justify-content: center;

     

       27
       29
        
         margin-bottom: ${p => p.theme.spacing.sm};

     

       28
       30
        
         align-self: center;

     

       31
       31
       +
       

     

       32
       32
       +
         @media ${p => p.theme.media.sm} {

     

       33
       33
       +
           display: flex;

     

       34
       34
       +
         }

     

       29
       35
        
       `;

     

       30
       36
        
       

     

       31
       37
        
       const HeroLogo = styled.img.attrs(() => ({

     

       32
       38
        
         src: logoSidebar,

     

       33
       39
        
         alt: 'urql',

     

       34
       40
        
       }))`

     

       35
       35
       -
         display: none;

     

       36
       41
        
         width: ${p => p.theme.layout.logo};

     

       37
       42
        
         height: ${p => p.theme.layout.logo};

     

       38
       38
       -
       

     

       39
       39
       -
         @media ${p => p.theme.media.sm} {

     

       40
       40
       -
           display: block;

     

       41
       41
       -
         }

     

       42
       43
        
       `;

     

       43
       44
        
       

     

       44
       45
        
       const ContentWrapper = styled.div`

     

       45
       46
        
         display: flex;

     

       46
       47
        
         flex-direction: column;

     

       47
       47
       -
         padding-top: ${p => p.theme.spacing.xs};

     

       48
       48
        
         padding-bottom: ${p => p.theme.spacing.lg};

     

       49
       49
        
       `;

     

       50
       50
        
       

     
···

       60
       60
        
         return { pathname };

     

       61
       61
        
       };

     

       62
       62
        
       

     

       63
       63
       -
       export const SidebarStyling = ({ children, sidebarOpen, closeSidebar }) => {

     

       63
       63
       +
       export const SidebarStyling = ({ children, sidebarOpen }) => {

     

       64
       64
        
         const basepath = useBasepath() || '';

     

       65
       65
        
         const homepage = basepath ? `/${basepath}/` : '/';

     

       66
       66
        
       

     

       67
       67
        
         return (

     

       68
       68
        
           <>

     

       69
       69
        
             <SideBarStripes />

     

       70
       70
       -
             <SidebarContainer hidden={!sidebarOpen} onClick={closeSidebar}>

     

       70
       70
       +
             <SidebarContainer hidden={!sidebarOpen}>

     

       71
       71
        
               <SidebarWrapper>

     

       72
       72
        
                 <HeroLogoLink to={homepage}>

     

       73
       73
        
                   <HeroLogo />

     
···

       79
       79
        
         );

     

       80
       80
        
       };

     

       81
       81
        
       

     

       82
       82
       -
       const Sidebar = props => {

     

       82
       82
       +
       const getMatchTree = (() => {

     

       83
       83
       +
         const sortByRefIndex = (a, b) => a.refIndex - b.refIndex;

     

       84
       84
       +
       

     

       85
       85
       +
         const options = {

     

       86
       86
       +
           distance: 100,

     

       87
       87
       +
           findAllMatches: true,

     

       88
       88
       +
           includeMatches: true,

     

       89
       89
       +
           keys: [

     

       90
       90
       +
             'frontmatter.title',

     

       91
       91
       +
             `children.frontmatter.title`,

     

       92
       92
       +
             'children.headings.value',

     

       93
       93
       +
           ],

     

       94
       94
       +
           threshold: 0.2,

     

       95
       95
       +
         };

     

       96
       96
       +
       

     

       97
       97
       +
         return (children, pattern) => {

     

       98
       98
       +
           // Filter any nested heading with a depth greater than 2

     

       99
       99
       +
           const childrenMaxH3 = children.map(child => ({

     

       100
       100
       +
             ...child,

     

       101
       101
       +
             children:

     

       102
       102
       +
               child.children &&

     

       103
       103
       +
               child.children.map(child => ({

     

       104
       104
       +
                 ...child,

     

       105
       105
       +
                 headings: child.headings.filter(heading => heading.depth == 2),

     

       106
       106
       +
               })),

     

       107
       107
       +
           }));

     

       108
       108
       +
       

     

       109
       109
       +
           const fuse = new Fuse(childrenMaxH3, options);

     

       110
       110
       +
           let matches = fuse.search(pattern);

     

       111
       111
       +
       

     

       112
       112
       +
           // For every matching section, include only matching headers

     

       113
       113
       +
           return matches

     

       114
       114
       +
             .reduce((matches, match) => {

     

       115
       115
       +
               const matchesMap = new Map();

     

       116
       116
       +
               match.matches.forEach(individualMatch => {

     

       117
       117
       +
                 matchesMap.set(individualMatch.value, {

     

       118
       118
       +
                   indices: individualMatch.indices,

     

       119
       119
       +
                 });

     

       120
       120
       +
               });

     

       121
       121
       +
       

     

       122
       122
       +
               // Add the top level heading but don't add subheadings unless they match

     

       123
       123
       +
               const currentItem = {

     

       124
       124
       +
                 ...match.item,

     

       125
       125
       +
                 matchedIndices: match.indices,

     

       126
       126
       +
                 refIndex: match.refIndex,

     

       127
       127
       +
               };

     

       128
       128
       +
       

     

       129
       129
       +
               // For every child of the currently matched section, add all appplicable

     

       130
       130
       +
               // H2 and H3 headers plus their indices

     

       131
       131
       +
               if (currentItem.children) {

     

       132
       132
       +
                 currentItem.children = currentItem.children.reduce(

     

       133
       133
       +
                   (children, child) => {

     

       134
       134
       +
                     const newChild = { ...child };

     

       135
       135
       +
                     newChild.headings = newChild.headings.reduce(

     

       136
       136
       +
                       (headings, header) => {

     

       137
       137
       +
                         const match = matchesMap.get(header.value);

     

       138
       138
       +
                         if (match) {

     

       139
       139
       +
                           headings.push({

     

       140
       140
       +
                             ...header,

     

       141
       141
       +
                             matchedIndices: match.indices,

     

       142
       142
       +
                           });

     

       143
       143
       +
                         }

     

       144
       144
       +
                         return headings;

     

       145
       145
       +
                       },

     

       146
       146
       +
                       []

     

       147
       147
       +
                     );

     

       148
       148
       +
       

     

       149
       149
       +
                     const match = matchesMap.get(newChild.frontmatter.title);

     

       150
       150
       +
                     if (match) {

     

       151
       151
       +
                       newChild.matchedIndices = match.indices;

     

       152
       152
       +
                     }

     

       153
       153
       +
       

     

       154
       154
       +
                     if (match || newChild.headings.length > 0) {

     

       155
       155
       +
                       children.push(newChild);

     

       156
       156
       +
                     }

     

       157
       157
       +
                     return children;

     

       158
       158
       +
                   },

     

       159
       159
       +
                   []

     

       160
       160
       +
                 );

     

       161
       161
       +
               }

     

       162
       162
       +
       

     

       163
       163
       +
               return [...matches, currentItem];

     

       164
       164
       +
             }, [])

     

       165
       165
       +
             .sort(sortByRefIndex);

     

       166
       166
       +
         };

     

       167
       167
       +
       })();

     

       168
       168
       +
       

     

       169
       169
       +
       // Wrap matching substrings in <strong>

     

       170
       170
       +
       const highlightText = (text, indices) => (

     

       171
       171
       +
         <>

     

       172
       172
       +
           {indices.map(([startIndex, endIndex], i) => {

     

       173
       173
       +
             const isLastIndex = !indices[i + 1];

     

       174
       174
       +
             const prevEndIndex = indices[i - 1] ? indices[i - 1][1] : -1;

     

       175
       175
       +
       

     

       176
       176
       +
             return (

     

       177
       177
       +
               <>

     

       178
       178
       +
                 {startIndex != 0 ? text.slice(prevEndIndex + 1, startIndex) : ''}

     

       179
       179
       +
                 <strong>{text.slice(startIndex, endIndex + 1)}</strong>

     

       180
       180
       +
                 {isLastIndex && endIndex < text.length

     

       181
       181
       +
                   ? text.slice(endIndex + 1, text.length)

     

       182
       182
       +
                   : ''}

     

       183
       183
       +
               </>

     

       184
       184
       +
             );

     

       185
       185
       +
           })}

     

       186
       186
       +
         </>

     

       187
       187
       +
       );

     

       188
       188
       +
       

     

       189
       189
       +
       const Sidebar = ({ closeSidebar, ...props }) => {

     

       190
       190
       +
         const [filterTerm, setFilterTerm] = useState('');

     

       83
       191
        
         const location = useLocation();

     

       84
       192
        
         const tree = useMarkdownTree();

     

       193
       193
       +
         const page = useMarkdownPage();

     

       85
       194
        
       

     

       86
       195
        
         const sidebarItems = useMemo(() => {

     

       87
       196
        
           let pathname = location.pathname.match(/docs\/?(.+)?/);

     
···

       97
       206
        
             children = [{ ...tree, children: undefined }, ...children];

     

       98
       207
        
           }

     

       99
       208
        
       

     

       209
       209
       +
           if (filterTerm) {

     

       210
       210
       +
             children = getMatchTree(children, filterTerm);

     

       211
       211
       +
           }

     

       212
       212
       +
       

     

       100
       213
        
           return children.map(page => {

     

       101
       214
        
             const pageChildren = page.children || [];

     

       102
       215
        
       

     
···

       104
       217
        
               ? trimmedPathname.startsWith(page.path)

     

       105
       218
        
               : !!page.path.match(new RegExp(`${trimmedPathname}$`, 'g'));

     

       106
       219
        
       

     

       220
       220
       +
             const showSubItems = !!filterTerm || (pageChildren.length && isActive);

     

       221
       221
       +
       

     

       107
       222
        
             return (

     

       108
       223
        
               <Fragment key={page.key}>

     

       109
       224
        
                 <SidebarNavItem

     

       110
       225
        
                   to={relative(pathname, page.path)}

     

       226
       226
       +
                   // If there is an active filter term in place, expand all headings

     

       111
       227
        
                   isActive={() => isActive}

     

       228
       228
       +
                   onClick={closeSidebar}

     

       112
       229
        
                 >

     

       113
       113
       -
                   {page.frontmatter.title}

     

       230
       230
       +
                   {page.matchedIndices

     

       231
       231
       +
                     ? highlightText(page.frontmatter.title, page.matchedIndices)

     

       232
       232
       +
                     : page.frontmatter.title}

     

       114
       233
        
                   {pageChildren.length ? <ChevronItem /> : null}

     

       115
       234
        
                 </SidebarNavItem>

     

       116
       235
        
       

     

       117
       117
       -
                 {pageChildren.length && isActive ? (

     

       236
       236
       +
                 {showSubItems ? (

     

       118
       237
        
                   <SidebarNavSubItemWrapper>

     

       119
       238
        
                     {pageChildren.map(childPage => (

     

       120
       120
       -
                       <SidebarNavSubItem

     

       121
       121
       -
                         isActive={() =>

     

       122
       122
       -
                           !!childPage.path.match(

     

       123
       123
       -
                             new RegExp(`${trimmedPathname}$`, 'g')

     

       124
       124
       -
                           )

     

       125
       125
       -
                         }

     

       126
       126
       -
                         to={relative(pathname, childPage.path)}

     

       127
       127
       -
                         key={childPage.key}

     

       128
       128
       -
                       >

     

       129
       129
       -
                         {childPage.frontmatter.title}

     

       130
       130
       -
                       </SidebarNavSubItem>

     

       239
       239
       +
                       <Fragment key={childPage.key}>

     

       240
       240
       +
                         <SidebarNavSubItem

     

       241
       241
       +
                           isActive={() =>

     

       242
       242
       +
                             !!childPage.path.match(

     

       243
       243
       +
                               new RegExp(`${trimmedPathname}$`, 'g')

     

       244
       244
       +
                             )

     

       245
       245
       +
                           }

     

       246
       246
       +
                           to={relative(pathname, childPage.path)}

     

       247
       247
       +
                         >

     

       248
       248
       +
                           {childPage.matchedIndices

     

       249
       249
       +
                             ? highlightText(

     

       250
       250
       +
                                 childPage.frontmatter.title,

     

       251
       251
       +
                                 childPage.matchedIndices

     

       252
       252
       +
                               )

     

       253
       253
       +
                             : childPage.frontmatter.title}

     

       254
       254
       +
                         </SidebarNavSubItem>

     

       255
       255
       +
                         {/* Only Show H3 items if there is a search applied */}

     

       256
       256
       +
                         {filterTerm

     

       257
       257
       +
                           ? childPage.headings.map(heading => (

     

       258
       258
       +
                               <SidebarNavSubItem

     

       259
       259
       +
                                 to={relative(pathname, childPage.path)}

     

       260
       260
       +
                                 key={heading.value}

     

       261
       261
       +
                                 nested={true}

     

       262
       262
       +
                               >

     

       263
       263
       +
                                 {highlightText(heading.value, heading.matchedIndices)}

     

       264
       264
       +
                               </SidebarNavSubItem>

     

       265
       265
       +
                             ))

     

       266
       266
       +
                           : null}

     

       267
       267
       +
                       </Fragment>

     

       131
       268
        
                     ))}

     

       132
       269
        
                   </SidebarNavSubItemWrapper>

     

       133
       270
        
                 ) : null}

     

       134
       271
        
               </Fragment>

     

       135
       272
        
             );

     

       136
       273
        
           });

     

       137
       137
       -
         }, [location, tree]);

     

       274
       274
       +
         }, [location, tree, filterTerm, closeSidebar]);

     

       138
       275
        
       

     

       139
       139
       -
         return <SidebarStyling {...props}>{sidebarItems}</SidebarStyling>;

     

       276
       276
       +
         return (

     

       277
       277
       +
           <SidebarStyling {...props}>

     

       278
       278
       +
             <SidebarSearchInput

     

       279
       279
       +
               onHandleInputChange={e => setFilterTerm(e.target.value)}

     

       280
       280
       +
               value={filterTerm}

     

       281
       281
       +
             />

     

       282
       282
       +
             {sidebarItems}

     

       283
       283
       +
           </SidebarStyling>

     

       284
       284
       +
         );

     

       140
       285
        
       };

     

       141
       286
        
       

     

       142
       287
        
       export default Sidebar;

+1 -1

packages/site/src/styles/theme.js

···

       30
       30
        
         page: '144rem',

     

       31
       31
        
         header: '4.8rem',

     

       32
       32
        
         stripes: '0.7rem',

     

       33
       33
       -
         sidebar: '26rem',

     

       33
       33
       +
         sidebar: '28rem',

     

       34
       34
        
         legend: '22rem',

     

       35
       35
        
         logo: '12rem',

     

       36
       36
        
       };

yarn.lock

···

       7702
       7702
        
         resolved "https://registry.yarnpkg.com/fuse.js/-/fuse.js-3.6.1.tgz#7de85fdd6e1b3377c23ce010892656385fd9b10c"

     

       7703
       7703
        
         integrity sha512-hT9yh/tiinkmirKrlv4KWOjztdoZo1mx9Qh4KvWqC7isoXwdUY3PNWUxceF4/qO9R6riA2C29jdTOeQOIROjgw==

     

       7704
       7704
        
       

     

       7705
       7705
       +
       fuse.js@^6.4.6:

     

       7706
       7706
       +
         version "6.4.6"

     

       7707
       7707
       +
         resolved "https://registry.yarnpkg.com/fuse.js/-/fuse.js-6.4.6.tgz#62f216c110e5aa22486aff20be7896d19a059b79"

     

       7708
       7708
       +
         integrity sha512-/gYxR/0VpXmWSfZOIPS3rWwU8SHgsRTwWuXhyb2O6s7aRuVtHtxCkR33bNYu3wyLyNx/Wpv0vU7FZy8Vj53VNw==

     

       7709
       7709
       +
       

     

       7705
       7710
        
       gauge@~2.7.3:

     

       7706
       7711
        
         version "2.7.4"

     

       7707
       7712
        
         resolved "https://registry.yarnpkg.com/gauge/-/gauge-2.7.4.tgz#2c03405c7538c39d7eb37b317022e325fb018bf7"