Files
medusa-store/www/apps/ui/src/config/docs.tsx
github-actions[bot] 869dc751a0 chore(docs): Updated UI Reference (#6347)
* chore(docs): Generated UI Reference

* fixed props typing + added new alert page

* updated ui dependencies

---------

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2024-02-12 19:46:51 +01:00

343 lines
8.1 KiB
TypeScript

import { ArrowUpRightOnBox } from "@medusajs/icons"
import { NavbarLinkProps, SidebarSectionItemsType } from "docs-ui"
type DocsConfig = {
mainNav: NavbarLinkProps[]
sidebar: SidebarSectionItemsType
}
export const docsConfig: DocsConfig = {
mainNav: [
{
label: "Docs",
target: "_blank",
rel: "noreferrer",
href: `${process.env.NEXT_PUBLIC_DOCS_URL}`,
},
{
label: "User Guide",
target: "_blank",
rel: "noreferrer",
href: `${process.env.NEXT_PUBLIC_DOCS_URL}/user-guide`,
},
{
label: "Store API",
target: "_blank",
rel: "noreferrer",
href: `${process.env.NEXT_PUBLIC_DOCS_URL}/api/store`,
},
{
label: "Admin API",
target: "_blank",
rel: "noreferrer",
href: `${process.env.NEXT_PUBLIC_DOCS_URL}/api/admin`,
},
{
label: "UI",
target: "_blank",
rel: "noreferrer",
href: `${process.env.NEXT_PUBLIC_DOCS_URL}/ui`,
activeValuePattern: new RegExp("/ui"),
},
],
sidebar: {
top: [
{
title: "Getting Started",
children: [
{
title: "Introduction",
path: "/",
loaded: true,
isPathHref: true,
},
],
},
{
title: "Installation",
children: [
{
title: "Medusa Admin Extension",
path: "/installation/medusa-admin-extension",
isPathHref: true,
},
{
title: "Standalone Project",
path: "/installation/standalone-project",
isPathHref: true,
},
{
title: "Upgrade Guides",
path: `${process.env.NEXT_PUBLIC_DOCS_URL}/upgrade-guides/medusa-ui`,
isPathHref: true,
additionalElms: <ArrowUpRightOnBox />,
linkProps: {
target: "_blank",
rel: "noreferrer",
},
},
],
},
],
bottom: [
{
title: "Colors",
children: [
{
title: "Overview",
path: "/colors/overview",
isPathHref: true,
},
],
},
{
title: "Icons",
children: [
{
title: "Overview",
path: "/icons/overview",
isPathHref: true,
},
],
},
{
title: "Components",
children: [
{
title: "Alert",
path: "/components/alert",
isPathHref: true,
},
{
title: "Avatar",
path: "/components/avatar",
isPathHref: true,
},
{
title: "Badge",
path: "/components/badge",
isPathHref: true,
},
{
title: "Button",
path: "/components/button",
isPathHref: true,
},
{
title: "Calendar",
path: "/components/calendar",
isPathHref: true,
},
{
title: "Checkbox",
path: "/components/checkbox",
isPathHref: true,
},
{
title: "Code Block",
path: "/components/code-block",
isPathHref: true,
},
{
title: "Command",
path: "/components/command",
isPathHref: true,
},
{
title: "Command Bar",
path: "/components/command-bar",
isPathHref: true,
},
{
title: "Container",
path: "/components/container",
isPathHref: true,
},
{
title: "Copy",
path: "/components/copy",
isPathHref: true,
},
{
title: "Currency Input",
path: "/components/currency-input",
isPathHref: true,
},
{
title: "Date Picker",
path: "/components/date-picker",
isPathHref: true,
},
{
title: "Drawer",
path: "/components/drawer",
isPathHref: true,
},
{
title: "Dropdown Menu",
path: "/components/dropdown-menu",
isPathHref: true,
},
{
title: "Focus Modal",
path: "/components/focus-modal",
isPathHref: true,
},
{
title: "Heading",
path: "/components/heading",
isPathHref: true,
},
{
title: "Icon Badge",
path: "/components/icon-badge",
isPathHref: true,
},
{
title: "Icon Button",
path: "/components/icon-button",
isPathHref: true,
},
{
title: "Input",
path: "/components/input",
isPathHref: true,
},
{
title: "Kbd",
path: "/components/kbd",
isPathHref: true,
},
{
title: "Label",
path: "/components/label",
isPathHref: true,
},
{
title: "Progress Accordion",
path: "/components/progress-accordion",
isPathHref: true,
},
{
title: "Progress Tabs",
path: "/components/progress-tabs",
isPathHref: true,
},
{
title: "Prompt",
path: "/components/prompt",
isPathHref: true,
},
{
title: "Radio Group",
path: "/components/radio-group",
isPathHref: true,
},
{
title: "Select",
path: "/components/select",
isPathHref: true,
},
{
title: "Status Badge",
path: "/components/status-badge",
isPathHref: true,
},
{
title: "Switch",
path: "/components/switch",
isPathHref: true,
},
{
title: "Table",
path: "/components/table",
isPathHref: true,
},
{
title: "Tabs",
path: "/components/tabs",
isPathHref: true,
},
{
title: "Text",
path: "/components/text",
isPathHref: true,
},
{
title: "Textarea",
path: "/components/textarea",
isPathHref: true,
},
{
title: "Toast",
path: "/components/toast",
isPathHref: true,
},
{
title: "Tooltip",
path: "/components/tooltip",
isPathHref: true,
},
],
},
{
title: "Hooks",
children: [
{
title: "usePrompt",
path: "/hooks/use-prompt",
isPathHref: true,
},
{
title: "useToast",
path: "/hooks/use-toast",
isPathHref: true,
},
{
title: "useToggleState",
path: "/hooks/use-toggle-state",
isPathHref: true,
},
],
},
{
title: "Utils",
children: [
{
title: "clx",
path: "/utils/clx",
isPathHref: true,
},
],
},
],
mobile: [
{
title: "Docs",
path: `${process.env.NEXT_PUBLIC_DOCS_URL}`,
isPathHref: true,
},
{
title: "User Guide",
path: `${process.env.NEXT_PUBLIC_DOCS_URL}/user-guide`,
isPathHref: true,
},
{
title: "Store API",
path: `${process.env.NEXT_PUBLIC_DOCS_URL}/api/store`,
isPathHref: true,
},
{
title: "Admin API",
path: `${process.env.NEXT_PUBLIC_DOCS_URL}/api/admin`,
isPathHref: true,
},
{
title: "UI",
path: `${process.env.NEXT_PUBLIC_DOCS_URL}/ui`,
isPathHref: true,
},
],
},
}