@primer/doctocat-nextjs 0.5.3 → 0.5.4-rc.3b1107b

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @primer/doctocat-nextjs
 
+## 0.5.4
+
+### Patch Changes
+
+- [#48](https://github.com/primer/doctocat-nextjs/pull/48) [`ce73c24`](https://github.com/primer/doctocat-nextjs/commit/ce73c24b2e4e924667bf7446a504bd88d8f2ccf0) Thanks [@rezrah](https://github.com/rezrah)! - - Fix inline code font-size in markdown headings. Now inherits size used in the heading.
+
+  - Increased spacing below React code blocks, which was previously too small.
+
+- [#50](https://github.com/primer/doctocat-nextjs/pull/50) [`5d67989`](https://github.com/primer/doctocat-nextjs/commit/5d679895408c1a58342419692db4234dfddefd80) Thanks [@rezrah](https://github.com/rezrah)! - Add `menu-position` frontmatter support for custom sidebar navigation ordering
+
 ## 0.5.3
 
 ### Patch Changes

package/components/layout/code-block/ReactCodeBlock.module.css

@@ -1,4 +1,5 @@
 .CodeBlock {
+  --spacing: var(--base-size-40);
   margin-block: var(--base-size-24);
   background-color: var(--brand-color-canvas-default);
   border: var(--brand-borderWidth-thin) solid var(--brand-color-border-default);

package/components/layout/code-block/ReactCodeBlock.tsx

@@ -1,5 +1,5 @@
 'use client'
-import React, {PropsWithChildren, useCallback, useState} from 'react'
+import React, {type PropsWithChildren, useCallback, useState, useRef, useEffect} from 'react'
 import clsx from 'clsx'
 import {LiveProvider, LiveEditor, LiveError, LivePreview} from 'react-live'
 import {useColorMode} from '../../context/color-modes/useColorMode'
@@ -18,12 +18,23 @@ type ReactCodeBlockProps = {
   jsxScope: Record<string, unknown>
 } & PropsWithChildren<HTMLElement>
 
+const getFocusableElements = () => {
+  const focusableElementsQuery = 'button, [href], input, select, textarea, [tabindex]:not([tabindex="-1"])'
+
+  return Array.from(document.querySelectorAll<HTMLElement>(focusableElementsQuery)).filter(el => {
+    const style = window.getComputedStyle(el)
+    return style.display !== 'none' && style.visibility !== 'hidden' && !el.hasAttribute('disabled')
+  })
+}
+
 export function ReactCodeBlock(props: ReactCodeBlockProps) {
   const {colorMode, setColorMode} = useColorMode()
   const {basePath} = useConfig()
   const initialCode = getCodeFromChildren(props.children)
   const [code, setCode] = useState(initialCode)
   const shouldShowPreview = ['tsx', 'jsx'].includes(props['data-language'])
+  const editorRef = useRef<HTMLDivElement>(null)
+  const resetButtonRef = useRef<HTMLButtonElement>(null)
 
   /**
    * Transforms code to prepend basePath to img src attributes
@@ -43,6 +54,41 @@ export function ReactCodeBlock(props: ReactCodeBlockProps) {
 
   const noInline = props['data-filename'] === 'noinline' || false
 
+  useEffect(() => {
+    const editor = editorRef.current
+
+    if (!editor) return
+
+    const onKeyDown = (e: KeyboardEvent) => {
+      if (e.key !== 'Tab') {
+        return
+      }
+
+      if (e.shiftKey) {
+        e.preventDefault()
+        // We know that the previous focusable element is always the reset button
+        resetButtonRef.current?.focus()
+        return
+      }
+
+      const focusableElements = getFocusableElements()
+
+      const currentIndex = focusableElements.findIndex(el => el === resetButtonRef.current)
+
+      if (currentIndex !== -1) {
+        e.preventDefault()
+        const nextIndex = currentIndex + 1
+        focusableElements[nextIndex]?.focus()
+      }
+    }
+
+    editor.addEventListener('keydown', onKeyDown)
+
+    return () => {
+      editor.removeEventListener('keydown', onKeyDown)
+    }
+  }, [])
+
   return (
     <>
       <LiveProvider transformCode={transformCodeWithBasePath} code={code} scope={props.jsxScope} noInline={noInline}>
@@ -76,11 +122,11 @@ export function ReactCodeBlock(props: ReactCodeBlockProps) {
             <Button size="small" leadingVisual={CopyIcon} onClick={handleCopy}>
               Copy
             </Button>
-            <Button size="small" leadingVisual={UndoIcon} onClick={handleReset}>
+            <Button size="small" leadingVisual={UndoIcon} onClick={handleReset} ref={resetButtonRef}>
               Reset
             </Button>
           </div>
-          <div className={styles.Editor}>
+          <div className={styles.Editor} ref={editorRef}>
             <LiveEditor theme={colorMode === 'light' ? lightTheme : darkTheme} onChange={setCode} />
           </div>
           {shouldShowPreview && (

package/components/layout/sidebar/Sidebar.tsx

@@ -82,7 +82,29 @@ export function Sidebar({pageMap}: SidebarProps) {
                 <NextLink href={item.route}>{subNavName}</NextLink>
               </NavList.GroupHeading>
               {item.children
-                .sort((a, b) => ((a as MdxFile).name === 'index' ? -1 : (b as MdxFile).name === 'index' ? 1 : 0)) // puts index page first
+                .sort((a, b) => {
+                  // make sure index page is first
+                  if ((a as MdxFile).name === 'index') return -1
+                  if ((b as MdxFile).name === 'index') return 1
+
+                  // Check for menu-position property in frontmatter
+                  const aPos = (a as MdxFile).frontMatter?.['menu-position']
+                  const bPos = (b as MdxFile).frontMatter?.['menu-position']
+
+                  // If both have menu-position, sort by menu-position
+                  if (typeof aPos === 'number' && typeof bPos === 'number') {
+                    return aPos - bPos
+                  }
+
+                  // If only one has menu-position, it comes first
+                  if (typeof aPos === 'number') return -1
+                  if (typeof bPos === 'number') return 1
+
+                  // Neither has menu-position, sort alphabetically by title or name
+                  const aTitle = (a as MdxFile).frontMatter?.title || (a as MdxFile).name
+                  const bTitle = (b as MdxFile).frontMatter?.title || (b as MdxFile).name
+                  return aTitle.localeCompare(bTitle)
+                })
                 // only show index page if it has show-tabs
                 .filter(child => (child as MdxFile).name !== 'index' || hasShowTabs(child as ExtendedPageItem))
                 .map(child => {

package/css/prose.module.css

@@ -211,6 +211,11 @@
   background-color: var(--base-color-scale-indigo-0);
 }
 
+/* Inline code inside headings should inherit font-size */
+.Prose :is(h1, h2, h3, h4, h5, h6):has(code) code:not(:global(.custom-component) code) {
+  font-size: inherit;
+}
+
 [data-color-mode='dark'] .Prose code:not(:global(.custom-component) code) {
   background-color: var(--base-color-scale-indigo-9);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@primer/doctocat-nextjs",
-  "version": "0.5.3",
+  "version": "0.5.4-rc.3b1107b",
   "description": "A Next.js theme for building Primer documentation sites",
   "main": "index.js",
   "type": "module",

package/types.ts

@@ -31,6 +31,7 @@ export type FrontMatter = {
   description?: string
   filePath?: string
   keywords?: string[]
+  menu_position?: number
   related?: {
     title: string
     href: string