docs: prep for v2 documentation (#6710)
This PR includes documentation that preps for v2 docs (but doesn't introduce new docs). _Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._ ## Changes - Change Medusa version in base OAS used for v2. - Fix to docblock generator related to not catching all path parameters. - Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules. - Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used. - Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment. - Upgraded docusaurus to v3.0.1 - Added new Vale rules to ensure correct spelling of Medusa Admin and module names. - Added new components to the `docs-ui` package that will be used in future documentation changes.
This commit is contained in:
29
www/packages/docs-ui/src/components/Toggle/index.tsx
Normal file
29
www/packages/docs-ui/src/components/Toggle/index.tsx
Normal file
@@ -0,0 +1,29 @@
|
||||
import { Switch } from "@medusajs/ui"
|
||||
import clsx from "clsx"
|
||||
import React from "react"
|
||||
import { Key } from "types"
|
||||
|
||||
export const Toggle = ({
|
||||
className,
|
||||
...props
|
||||
}: React.ComponentProps<typeof Switch> & Key) => {
|
||||
return (
|
||||
<Switch
|
||||
{...props}
|
||||
className={clsx(
|
||||
className,
|
||||
"bg-ui-bg-switch-off hover:bg-ui-bg-switch-off-hover data-[state=unchecked]:hover:after:bg-switch-off-hover-gradient",
|
||||
"before:shadow-details-switch-background focus-visible:shadow-details-switch-background-focus data-[state=checked]:bg-ui-bg-interactive",
|
||||
"disabled:!bg-ui-bg-disabled group relative inline-flex items-center rounded-full outline-none transition-all before:absolute",
|
||||
"before:inset-0 before:rounded-full before:content-[''] after:absolute after:inset-0 after:rounded-full after:content-['']",
|
||||
"disabled:cursor-not-allowed",
|
||||
// eslint-disable-next-line react/prop-types
|
||||
props.size !== "small" &&
|
||||
"h-[18px] w-[32px] [&_span]:h-[14px] [&_span]:w-[14px]",
|
||||
"[&_span]:bg-medusa-fg-on-color [&_span]:shadow-details-switch-handle [&_span]:group-disabled:bg-ui-fg-disabled [&_span]:pointer-events-none",
|
||||
"[&_span]:rounded-full [&_span]:group-disabled:shadow-none [&_span]:transition-transform",
|
||||
"[&_span]:data-[state=checked]:translate-x-docs_1 [&_span]:data-[state=unchecked]:translate-x-docs_0.125"
|
||||
)}
|
||||
/>
|
||||
)
|
||||
}
|
||||
Reference in New Issue
Block a user