* testing out a rest operations sidebar * cleanup * renamed 5 files * renamed 5 files * set redirect_from on 5 files * renamed 1 files * renamed 1 files * renamed 3 files * renamed 1 files * renamed 1 files * renamed 3 files * renamed 1 files * renamed 2 files * renamed 1 files * renamed 4 files * renamed 15 files * renamed 2 files * renamed 6 files * renamed 1 files * renamed 4 files * renamed 7 files * renamed 1 files * renamed 3 files * renamed 3 files * renamed 1 files * renamed 5 files * renamed 1 files * renamed 1 files * renamed 3 files * renamed 4 files * renamed 1 files * renamed 1 files * renamed 2 files * renamed 4 files * renamed 1 files * renamed 1 files * renamed 1 files * renamed 6 files * renamed 6 files * renamed 4 files * move files * adding more * updating to add restcontext and start of removing data/reusables/rest-reference * removed data/reusables * add a RestMiniTocItem and updating the filtering to add a subcategory so all manually added H3s are in mini tocs in addition to operations * remove console log * [WIP]: REST New Proposal Sidebar (#26471) * saving * update sidebar * remove console log * update guides and overview * import Category for category level rest pages * update undefined restOperations * update restOperationData category and subcategory levels" * minor updates * update get mini toc items function * updating REST context for sidebar * updating rest data * remove console logs * WIP: mini-toc-ing the sidebar Co-authored-by: Robert Sese <rsese@github.com> * A little cleanup * Fix first subcategory link and add some comments * updating anchor links in sidebar * adding updates * remove standalone * update product and maptopic pages using article context * add conditional link wrapper * fix sidebar toggle and versions for enterprise admin * update versions per subcategory * Highlight sidebar link for current page * Update miniToc hash links and hash change tracking * fix unique key in CollapsibleSection * Fix list markup * remove title * update permissions * Hide minitocs on landing (#26594) * hide minitocs on landing page * simplify page components and remove minitoc from sidebar for guides/overview * fix carats and category fix * remove id Co-authored-by: Grace Park <gracepark@github.com> * updating content based on versions script check with the OpenAPI * update script and content files * update script and content/rest files * update to add TocLanding * update script * update index files * add codespaces repository-secrets * remove openapi schema check script * remove minitocs at the top * add h2 about the {title} api * fix tests/unit/openapi-schema.js * Fix linting tests * fix search/topics test * fix tests/unit/pages test * update rest/reference links in components * run prettier * Update components/rest/RestReferencePage.tsx Co-authored-by: Rachael Sewell <rachmari@github.com> * Update components/rest/RestReferencePage.tsx Co-authored-by: Rachael Sewell <rachmari@github.com> * Update pages/[versionId]/rest/[category]/[subcategory].tsx Co-authored-by: Rachael Sewell <rachmari@github.com> * Update pages/[versionId]/rest/[category]/[subcategory].tsx Co-authored-by: Rachael Sewell <rachmari@github.com> * Update pages/[versionId]/rest/[category]/[subcategory].tsx Co-authored-by: Rachael Sewell <rachmari@github.com> * Update pages/[versionId]/rest/[category]/[subcategory].tsx Co-authored-by: Rachael Sewell <rachmari@github.com> * Update tests/unit/openapi-schema.js Co-authored-by: Rachael Sewell <rachmari@github.com> * updating comment location * remove dependabot override * remove path-utils current product update for rest * run linter * remove dependabot.md and remove h2 heading on restreference * update the correct product to rest for rest pages * adding comments for updates to path-utils * remove console log * REST sidebar: handle legacy v3 redirects (#26686) * Add script to handle legacy v3 REST redirects * Run the script * Handle a redirect to a redirect * Update REST test URLs * 'await' and test runs subcategory of checks * Update REST URLs for routing/developer-site-redirects tests * Update developer-redirects fixture with new REST URLs * Resolve merge conflicts * Update rest-redirects fixture with new REST URLs * Fix broken links with REST pages re-org * redirectTo could be undefined * Fix script for posterity, can't redirect paths with hashes * Remove invalid hash redirects * Typically don't need to save one-off scripts * Undo redirect changes (not necessary for handling v3 redirects) * Remove script-added redirects * Update old v3 redirects with new REST URLs * No more GHES search indexing page * 'org' not 'organization' * Update fixture data for new REST URLs * revert any content directory changes Co-authored-by: Grace Park <gracepark@github.com> Co-authored-by: Rachael Sewell <rachmari@github.com> * Adding test rest (#26750) * add test to check openapi schema versions and content rest frontmatter versions * update lib/redirects * fix test and add error messages * adding repository secrets * adding repository-secrets.md * Revert "update lib/redirects" This reverts commit 3aafe28265764d5bc09c0c478c8e0ca099c8fbcf. * remove lib/redirects changes and console logs * Update lib/rest/index.js Co-authored-by: Rachael Sewell <rachmari@github.com> * update unique key * Rest client side redirects (#26754) * adding tags subcategory for the rest content repos category * run prettier * bug fix for anchor scrolls" (#26892) * updating width size for rest reference page * Rest sidebar consolidation (#26862) * refactor sidebar * fix articlecontext provider issue on rest product landing page for all versions * fix a bug, create new component * revert change to create new component and fix bug Co-authored-by: Rachael Sewell <rachmari@github.com> * Set currentAnchor with a hashchange handler (#26923) * Rest sidebar design tweaks (#26807) * Rest sidebar design tweaks * tweak color to subtle * use muted color and margin for line * update to design feedback Co-authored-by: Grace Park <gracepark@github.com> * Remove cheerio from rest-collapsible (#26948) * remove cheerio from rest-collapsible * update type * adding endswith instead * use productId instead * one off edge case for secret-scanning * Reorganize subcategory and category, Update pre -> div, Add RestContext (#26950) * reorganize subcategory and category * add RestContext * update comment * update for endpoints page * add comment * move object to restcontext * remove effectiveDate in restcontext * remove width calculation for rest reference page * fix adding manual writer's minitocs to sidebar * update with feedback * update comment * update isRestReferencePage * remove page component and fix bug * adding back rest/index.tsx Co-authored-by: Rachael Sewell <rachmari@github.com> * update content/rest" * add back design tweak * update to div * update margins on rest api reference * remove page component * adding tests * separate product from rest sidebar (#27065) * separate product from rest sidebar * Use ProductCollapsibleSections for product pages * fix tests Co-authored-by: Robert Sese <rsese@github.com> Co-authored-by: Grace Park <gracepark@github.com> * Rest sidebar translations (#27052) * update translations * remove general test Co-authored-by: Robert Sese <rsese@github.com> Co-authored-by: Rachael Sewell <rachmari@github.com>
207 lines
7.1 KiB
TypeScript
207 lines
7.1 KiB
TypeScript
import { useRouter } from 'next/router'
|
|
import cx from 'classnames'
|
|
import { useState, useEffect, SyntheticEvent, ReactElement } from 'react'
|
|
import { ChevronDownIcon } from '@primer/octicons-react'
|
|
import { ActionList } from '@primer/react'
|
|
|
|
import { Link } from 'components/Link'
|
|
import { ProductTreeNode } from 'components/context/MainContext'
|
|
import { EventType, sendEvent } from 'components/lib/events'
|
|
import { MiniTocItem, useRestContext } from 'components/context/RestContext'
|
|
import styles from './SidebarProduct.module.scss'
|
|
|
|
type SectionProps = {
|
|
routePath: string
|
|
page: ProductTreeNode
|
|
title: string
|
|
defaultOpen: boolean
|
|
isStandaloneCategory: boolean
|
|
}
|
|
|
|
type ConditionalLinkTypes = {
|
|
condition: boolean
|
|
wrapper: Function
|
|
children: ReactElement
|
|
}
|
|
|
|
export const RestCollapsibleSection = (props: SectionProps) => {
|
|
const router = useRouter()
|
|
const { routePath, defaultOpen, title, page, isStandaloneCategory } = props
|
|
const [isOpen, setIsOpen] = useState(defaultOpen)
|
|
const [currentAnchor, setCurrentAnchor] = useState('')
|
|
const onToggle = (e: SyntheticEvent) => {
|
|
const newIsOpen = (e.target as HTMLDetailsElement).open
|
|
setIsOpen(newIsOpen)
|
|
sendEvent({
|
|
type: EventType.navigate,
|
|
navigate_label: `details ${newIsOpen ? 'open' : 'close'}: ${title}`,
|
|
})
|
|
}
|
|
|
|
useEffect(() => {
|
|
if (!currentAnchor) {
|
|
setCurrentAnchor(window.location.hash)
|
|
}
|
|
|
|
const hashChangeHandler = () => {
|
|
setCurrentAnchor(window.location.hash)
|
|
}
|
|
|
|
window.addEventListener('hashchange', hashChangeHandler)
|
|
|
|
return () => {
|
|
window.removeEventListener('hashchange', hashChangeHandler)
|
|
}
|
|
}, [])
|
|
|
|
const miniTocItems =
|
|
router.query.productId === 'rest' ||
|
|
// These pages need the Article Page mini tocs instead of the Rest Pages
|
|
router.asPath.includes('/rest/guides') ||
|
|
router.asPath.includes('/rest/overview')
|
|
? []
|
|
: useRestContext().miniTocItems
|
|
|
|
// This wrapper solves the issue of having standalone categories not
|
|
// link to the new page. We want standalone categories to have links
|
|
// just like maptopics/subcategories.
|
|
const ConditionalLinkWrapper = ({ condition, wrapper, children }: ConditionalLinkTypes) =>
|
|
condition ? wrapper(children) : children
|
|
|
|
const renderRestAnchorLink = (miniTocItem: MiniTocItem) => {
|
|
const miniTocAnchor = miniTocItem.contents.href
|
|
const title = miniTocItem.contents.title
|
|
const isCurrent = currentAnchor === miniTocAnchor
|
|
|
|
return {
|
|
text: title,
|
|
renderItem: () => (
|
|
<ActionList.Item
|
|
data-is-current-page={isCurrent}
|
|
as="li"
|
|
className={cx(
|
|
'position-relative',
|
|
styles.sidebarArticle,
|
|
isCurrent && ['text-bold', styles.sidebarArticleActive]
|
|
)}
|
|
sx={{
|
|
padding: '2px 0',
|
|
':hover': {
|
|
borderRadius: 0,
|
|
},
|
|
}}
|
|
>
|
|
<a
|
|
className={cx(
|
|
'd-block pl-6 pr-5 py-1 no-underline width-full',
|
|
isCurrent ? 'color-fg-accent' : 'color-fg-default'
|
|
)}
|
|
href={miniTocAnchor}
|
|
>
|
|
{title}
|
|
</a>
|
|
</ActionList.Item>
|
|
),
|
|
}
|
|
}
|
|
|
|
return (
|
|
<details open={defaultOpen} onToggle={onToggle} className="details-reset">
|
|
<summary className="outline-none">
|
|
<ConditionalLinkWrapper
|
|
condition={isStandaloneCategory}
|
|
wrapper={(children: ReactElement) => (
|
|
<Link href={page.href} className="color-fg-default no-underline text-bold">
|
|
{children}
|
|
</Link>
|
|
)}
|
|
>
|
|
<div className="d-flex flex-justify-between">
|
|
<div className="pl-4 pr-1 py-2 f5 d-block flex-auto mr-3 color-fg-default no-underline text-bold">
|
|
{title}
|
|
</div>
|
|
<span style={{ marginTop: 7 }} className="flex-shrink-0 pr-3">
|
|
<ChevronDownIcon className={cx('opacity-60', isOpen && 'rotate-180')} />
|
|
</span>
|
|
</div>
|
|
</ConditionalLinkWrapper>
|
|
</summary>
|
|
|
|
{
|
|
<>
|
|
{/* <!-- Render the maptopic level subcategory operation links e.g. --> */}
|
|
<ul className="list-style-none position-relative">
|
|
{page.childPages.length <= 0 ? (
|
|
<div data-testid="sidebar-article-group" className="pb-0">
|
|
{miniTocItems.length > 0 && (
|
|
<ActionList
|
|
{...{ as: 'ul' }}
|
|
items={miniTocItems.map((item) => {
|
|
return renderRestAnchorLink(item)
|
|
})}
|
|
></ActionList>
|
|
)}
|
|
</div>
|
|
) : (
|
|
page.childPages.map((childPage, i) => {
|
|
const childTitle = childPage.renderedShortTitle || childPage.renderedFullTitle
|
|
const isActive = routePath.includes(childPage.href)
|
|
const isCurrent = routePath === childPage.href
|
|
|
|
// At this point we have the mini-toc data for the current page
|
|
// so we render this list of operation links.
|
|
if (routePath === childPage.href) {
|
|
return (
|
|
<li key={childPage.href + i} data-is-current-page={isCurrent}>
|
|
<details
|
|
open={isActive}
|
|
onToggle={(e) => e.stopPropagation()}
|
|
className="details-reset"
|
|
>
|
|
<summary>
|
|
<div
|
|
data-testid="sidebar-rest-subcategory"
|
|
className={cx('pl-4 pr-5 py-2 no-underline')}
|
|
>
|
|
{childTitle}
|
|
</div>
|
|
</summary>
|
|
<div className="pb-0">
|
|
{miniTocItems.length > 0 && (
|
|
<ActionList
|
|
{...{ as: 'ul' }}
|
|
items={miniTocItems.map((item) => {
|
|
return renderRestAnchorLink(item)
|
|
})}
|
|
></ActionList>
|
|
)}
|
|
</div>
|
|
</details>
|
|
</li>
|
|
)
|
|
} else {
|
|
// We're not on the current page so don't have any minitoc
|
|
// data so just render a link to the category page.
|
|
return (
|
|
<li key={childTitle} data-testid="sidebar-article-group" className="pb-0">
|
|
<Link
|
|
href={childPage.href}
|
|
className={cx(
|
|
'd-block pl-4 pr-5 py-1 no-underline width-full',
|
|
isCurrent ? 'color-fg-accent' : 'color-fg-default'
|
|
)}
|
|
>
|
|
{childTitle}
|
|
</Link>
|
|
</li>
|
|
)
|
|
}
|
|
})
|
|
)}
|
|
</ul>
|
|
</>
|
|
}
|
|
</details>
|
|
)
|
|
}
|