@@ -2,7 +2,7 @@ import React from "react"
|
||||
import { Badge, Link, Tooltip } from "@/components"
|
||||
|
||||
export type ExpandableNoticeProps = {
|
||||
type: "request" | "method"
|
||||
type: "request" | "method" | "workflow"
|
||||
link: string
|
||||
badgeContent?: React.ReactNode
|
||||
badgeClassName?: string
|
||||
@@ -19,8 +19,8 @@ export const ExpandableNotice = ({
|
||||
tooltipChildren={
|
||||
<>
|
||||
If this {type} accepts an <code>expand</code>{" "}
|
||||
{type === "request" ? "parameter" : "property or option"},
|
||||
<br /> this field can be <Link href={link}>expanded</Link> into an
|
||||
{type === "request" ? "parameter" : "parameter or property"},
|
||||
<br /> this relation can be <Link href={link}>expanded</Link> into an
|
||||
object.
|
||||
</>
|
||||
}
|
||||
|
||||
@@ -25,6 +25,7 @@ import { useIsBrowser, useSiteConfig } from "../../.."
|
||||
|
||||
type CommonProps = ParentCommonProps & {
|
||||
level?: number
|
||||
referenceType?: "method" | "workflow"
|
||||
}
|
||||
|
||||
type TypeListItemProps = {
|
||||
@@ -39,6 +40,7 @@ const TypeListItem = ({
|
||||
expandUrl,
|
||||
elementKey,
|
||||
sectionTitle,
|
||||
referenceType = "method",
|
||||
}: TypeListItemProps) => {
|
||||
const isBrowser = useIsBrowser()
|
||||
const pathname = usePathname()
|
||||
@@ -227,9 +229,9 @@ const TypeListItem = ({
|
||||
)}
|
||||
{item.expandable && (
|
||||
<ExpandableNotice
|
||||
type="method"
|
||||
type={referenceType}
|
||||
link={expandUrl || "#"}
|
||||
badgeClassName="!p-0 leading-none"
|
||||
badgeClassName="!p-docs_0.25 block leading-none"
|
||||
badgeContent={<ArrowsPointingOutMini />}
|
||||
/>
|
||||
)}
|
||||
|
||||
@@ -3,10 +3,6 @@ import { FormattingOptionsType } from "types"
|
||||
const medusaOptions: FormattingOptionsType = {
|
||||
"^medusa/": {
|
||||
maxLevel: 2,
|
||||
parameterComponentExtraProps: {
|
||||
expandUrl:
|
||||
"https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records",
|
||||
},
|
||||
},
|
||||
"^medusa/classes/medusa\\.(Store*|Admin*)": {
|
||||
reflectionGroups: {
|
||||
|
||||
@@ -50,6 +50,10 @@ const mergerOptions: Partial<TypeDocOptions> = {
|
||||
parameterStyle: "component",
|
||||
parameterComponent: "TypeList",
|
||||
mdxImports: [`import { TypeList } from "docs-ui"`],
|
||||
parameterComponentExtraProps: {
|
||||
expandUrl:
|
||||
"https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation",
|
||||
},
|
||||
},
|
||||
internal: {
|
||||
maxLevel: 1,
|
||||
|
||||
Reference in New Issue
Block a user