docs: added note in API reference clarifying what schemas are (#11116)

* docs: added note in API reference clarifying what schemas are

* add yarn lock
This commit is contained in:
Shahed Nasser
2025-01-23 17:02:25 +02:00
committed by GitHub
parent 4eecda5466
commit c4eb36b837
5 changed files with 79 additions and 63 deletions
+8 -2
View File
@@ -1,12 +1,13 @@
"use client"
import type { Area } from "@/types/openapi"
import { usePrevious, useSearch } from "docs-ui"
import { createContext, useContext, useEffect, useState } from "react"
import { capitalize, usePrevious, useSearch } from "docs-ui"
import { createContext, useContext, useEffect, useMemo, useState } from "react"
type AreaContextType = {
area: Area
prevArea: Area | undefined
displayedArea: string
setArea: (value: Area) => void
}
@@ -22,6 +23,10 @@ const AreaProvider = ({ area: passedArea, children }: AreaProviderProps) => {
const prevArea = usePrevious(area)
const { defaultFilters, setDefaultFilters } = useSearch()
const displayedArea = useMemo(() => {
return capitalize(area)
}, [area])
useEffect(() => {
if (!defaultFilters.includes(`${area}-v2`)) {
setDefaultFilters([`${area}-v2`])
@@ -34,6 +39,7 @@ const AreaProvider = ({ area: passedArea, children }: AreaProviderProps) => {
area,
prevArea,
setArea,
displayedArea,
}}
>
{children}
@@ -1,7 +1,7 @@
"use client"
import { createContext, useEffect } from "react"
import { capitalize, useSidebar } from "docs-ui"
import { useSidebar } from "docs-ui"
import { useArea } from "./area"
import { SidebarItemLink } from "types"
@@ -13,10 +13,10 @@ type PageTitleProviderProps = {
const PageTitleProvider = ({ children }: PageTitleProviderProps) => {
const { activePath, activeItem } = useSidebar()
const { area } = useArea()
const { displayedArea } = useArea()
useEffect(() => {
const titleSuffix = `Medusa ${capitalize(area)} API Reference`
const titleSuffix = `Medusa ${displayedArea} API Reference`
if (!activePath?.length) {
document.title = titleSuffix
@@ -33,7 +33,7 @@ const PageTitleProvider = ({ children }: PageTitleProviderProps) => {
}
}
}
}, [activePath, area, activeItem])
}, [activePath, displayedArea, activeItem])
return (
<PageTitleContext.Provider value={null}>