docs: fix sidebar items not showing if they have same title in API reference (#11122)

This commit is contained in:
Shahed Nasser
2025-01-24 18:54:21 +02:00
committed by GitHub
parent dc3a4b5c40
commit 8038a917ee
5 changed files with 19 additions and 20 deletions

View File

@@ -37,6 +37,7 @@ const TagPaths = ({ tag, className, paths }: TagPathsProps) => {
addItems(pathItems, {
section: SidebarItemSections.DEFAULT,
parent: {
type: "category",
title: tag.name,
path: "",
changeLoaded: true,

View File

@@ -73,8 +73,9 @@ const TagSectionSchema = ({ schema, tagName }: TagSectionSchemaProps) => {
{
section: SidebarItemSections.DEFAULT,
parent: {
type: "category",
title: tagName,
path: tagSlugName,
path: "",
changeLoaded: true,
},
indexPosition: 0,

View File

@@ -1,19 +1,12 @@
"use client"
import { ExpandedDocument, SecuritySchemeObject } from "@/types/openapi"
import {
ReactNode,
createContext,
useCallback,
useContext,
useEffect,
useMemo,
} from "react"
import { ReactNode, createContext, useContext, useEffect, useMemo } from "react"
import { SidebarItem, SidebarItemSections } from "types"
import getSectionId from "../utils/get-section-id"
import getTagChildSidebarItems from "../utils/get-tag-child-sidebar-items"
import { usePathname, useRouter } from "next/navigation"
import { usePrevious, useSidebar } from "docs-ui"
import { useRouter } from "next/navigation"
import { useSidebar } from "docs-ui"
type BaseSpecsContextType = {
baseSpecs: ExpandedDocument | undefined
@@ -29,10 +22,7 @@ type BaseSpecsProviderProps = {
const BaseSpecsProvider = ({ children, baseSpecs }: BaseSpecsProviderProps) => {
const router = useRouter()
const { items, activePath, addItems, setActivePath, resetItems } =
useSidebar()
const pathname = usePathname()
const prevPathName = usePrevious(pathname)
const { activePath, addItems, setActivePath, resetItems } = useSidebar()
const getSecuritySchema = (
securityName: string

View File

@@ -21,6 +21,7 @@ import {
InteractiveSidebarItem,
SidebarItemCategory,
SidebarItemLinkWithParent,
SidebarItemTypes,
} from "types"
import { useIsBrowser } from "../BrowserProvider"
@@ -70,6 +71,7 @@ export const SidebarContext = createContext<SidebarContextType | null>(null)
export type ActionOptionsType = {
section?: SidebarItemSections
parent?: {
type: SidebarItemTypes
path: string
title: string
changeLoaded?: boolean
@@ -106,17 +108,20 @@ export const isSidebarItemLink = (
}
const areItemsEqual = (itemA: SidebarItem, itemB: SidebarItem): boolean => {
if (itemA.type === "separator" || itemB.type === "separator") {
if (
itemA.type === "separator" ||
itemB.type === "separator" ||
itemA.type !== itemB.type
) {
return false
}
const hasSameTitle = itemA.title === itemB.title
const hasSamePath =
isSidebarItemLink(itemA) &&
isSidebarItemLink(itemB) &&
itemA.type === itemB.type &&
!isSidebarItemLink(itemA) ||
!isSidebarItemLink(itemB) ||
itemA.path === itemB.path
return hasSameTitle || hasSamePath
return hasSameTitle && hasSamePath
}
const findItem = (

View File

@@ -17,6 +17,8 @@ export type SidebarItemCommon = {
description?: string
}
export type SidebarItemTypes = "category" | "sub-category" | "link" | "ref"
export type SidebarItemLink = SidebarItemCommon & {
type: "link" | "ref"
path: string