api-ref: custom API reference (#4770)

* initialized next.js project

* finished markdown sections

* added operation schema component

* change page metadata

* eslint fixes

* fixes related to deployment

* added response schema

* resolve max stack issue

* support for different property types

* added support for property types

* added loading for components

* added more loading

* type fixes

* added oneOf type

* removed console

* fix replace with push

* refactored everything

* use static content for description

* fixes and improvements

* added code examples section

* fix path name

* optimizations

* fixed tag navigation

* add support for admin and store references

* general enhancements

* optimizations and fixes

* fixes and enhancements

* added search bar

* loading enhancements

* added loading

* added code blocks

* added margin top

* add empty response text

* fixed oneOf parameters

* added path and query parameters

* general fixes

* added base path env variable

* small fix for arrays

* enhancements

* design enhancements

* general enhancements

* fix isRequired

* added enum values

* enhancements

* general fixes

* general fixes

* changed oas generation script

* additions to the introduction section

* added copy button for code + other enhancements

* fix response code block

* fix metadata

* formatted store introduction

* move sidebar logic to Tags component

* added test env variables

* fix code block bug

* added loading animation

* added expand param + loading

* enhance operation loading

* made responsive + improvements

* added loading provider

* fixed loading

* adjustments for small devices

* added sidebar label for endpoints

* added feedback component

* fixed analytics

* general fixes

* listen to scroll for other headings

* added sample env file

* update api ref files + support new fields

* fix for external docs link

* added new sections

* fix last item in sidebar not showing

* move docs content to www/docs

* change redirect url

* revert change

* resolve build errors

* configure rewrites

* changed to environment variable url

* revert changing environment variable name

* add environment variable for API path

* fix links

* fix tailwind settings

* remove vercel file

* reconfigured api route

* move api page under api

* fix page metadata

* fix external link in navigation bar

* update api spec

* updated api specs

* fixed google lint error

* add max-height on request samples

* add padding before loading

* fix for one of name

* fix undefined types

* general fixes

* remove response schema example

* redesigned navigation bar

* redesigned sidebar

* fixed up paddings

* added feedback component + report issue

* fixed up typography, padding, and general styling

* redesigned code blocks

* optimization

* added error timeout

* fixes

* added indexing with algolia + fixes

* fix errors with algolia script

* redesign operation sections

* fix heading scroll

* design fixes

* fix padding

* fix padding + scroll issues

* fix scroll issues

* improve scroll performance

* fixes for safari

* optimization and fixes

* fixes to docs + details animation

* padding fixes for code block

* added tab animation

* fixed incorrect link

* added selection styling

* fix lint errors

* redesigned details component

* added detailed feedback form

* api reference fixes

* fix tabs

* upgrade + fixes

* updated documentation links

* optimizations to sidebar items

* fix spacing in sidebar item

* optimizations and fixes

* fix endpoint path styling

* remove margin

* final fixes

* change margin on small devices

* generated OAS

* fixes for mobile

* added feedback modal

* optimize dark mode button

* fixed color mode useeffect

* minimize dom size

* use new style system

* radius and spacing design system

* design fixes

* fix eslint errors

* added meta files

* change cron schedule

* fix docusaurus configurations

* added operating system to feedback data

* change content directory name

* fixes to contribution guidelines

* revert renaming content

* added api-reference to documentation workflow

* fixes for search

* added dark mode + fixes

* oas fixes

* handle bugs

* added code examples for clients

* changed tooltip text

* change authentication to card

* change page title based on selected section

* redesigned mobile navbar

* fix icon colors

* fix key colors

* fix medusa-js installation command

* change external regex in algolia

* change changeset

* fix padding on mobile

* fix hydration error

* update depedencies
This commit is contained in:
Shahed Nasser
2023-08-15 18:07:54 +03:00
committed by GitHub
parent 16249ec280
commit 914d773d3a
3270 changed files with 22075 additions and 192064 deletions

View File

@@ -35,7 +35,7 @@ const NotificationContainer = () => {
onClose={() => handleClose(notification)}
className={clsx(
notification.className,
"!tw-relative !tw-top-0 !tw-bottom-0 !tw-right-0"
"!relative !top-0 !bottom-0 !right-0"
)}
/>
</CSSTransition>
@@ -48,11 +48,11 @@ const NotificationContainer = () => {
<>
{renderFilteredNotifications(
(notification) => notification.placement === "top",
"tw-flex tw-fixed tw-flex-col tw-gap-0.5 md:tw-right-1 tw-right-0 md:tw-top-1 tw-top-0 tw-z-[400] md:tw-w-auto tw-w-full"
"flex fixed flex-col gap-0.5 md:right-1 right-0 md:top-1 top-0 z-[400] md:w-auto w-full"
)}
{renderFilteredNotifications(
(notification) => notification.placement !== "top",
"tw-flex tw-flex-col tw-gap-0.5 tw-fixed md:tw-right-1 tw-right-0 md:tw-bottom-1 tw-bottom-0 tw-z-[400] md:tw-w-auto tw-w-full"
"flex flex-col gap-0.5 fixed md:right-1 right-0 md:bottom-1 bottom-0 z-[400] md:w-auto w-full"
)}
</>
)

View File

@@ -24,33 +24,32 @@ const NotificationItemLayoutDefault: React.FC<
}) => {
return (
<>
<div className={clsx("tw-flex tw-gap-1 tw-p-1")}>
<div className={clsx("flex gap-1 p-1")}>
{type !== "none" && (
<div
className={clsx(
type !== "custom" &&
"tw-w-2 tw-flex tw-justify-center tw-items-center"
type !== "custom" && "w-2 flex justify-center items-center"
)}
>
{type === "info" && (
<IconInformationCircleSolid iconColorClassName="tw-fill-medusa-support-info dark:tw-fill-medusa-support-info-dark" />
<IconInformationCircleSolid iconColorClassName="fill-medusa-fg-interactive-dark" />
)}
{type === "error" && (
<IconXCircleSolid iconColorClassName="tw-fill-medusa-tag-red-icon dark:tw-fill-medusa-tag-red-icon-dark" />
<IconXCircleSolid iconColorClassName="fill-medusa-tag-red-icon dark:fill-medusa-tag-red-icon-dark" />
)}
{type === "warning" && (
<IconExclamationCircleSolid iconColorClassName="tw-fill-medusa-tag-orange-icon dark:tw-fill-medusa-tag-orange-icon-dark" />
<IconExclamationCircleSolid iconColorClassName="fill-medusa-tag-orange-icon dark:fill-medusa-tag-orange-icon-dark" />
)}
{type === "success" && (
<IconCheckCircleSolid iconColorClassName="tw-fill-medusa-tag-green-icon dark:tw-fill-medusa-tag-green-icon-dark" />
<IconCheckCircleSolid iconColorClassName="fill-medusa-tag-green-icon dark:fill-medusa-tag-green-icon-dark" />
)}
{type === "custom" && CustomIcon}
</div>
)}
<span
className={clsx(
"tw-text-label-regular-plus",
"tw-text-medusa-text-base dark:tw-text-medusa-text-base-dark"
"text-compact-medium-plus",
"text-medusa-fg-base dark:text-medusa-fg-base-dark"
)}
>
{title}
@@ -59,16 +58,16 @@ const NotificationItemLayoutDefault: React.FC<
{(text || children) && (
<div
className={clsx(
"tw-flex tw-pt-0 tw-pr-1 tw-pb-1.5 tw-pl-1 tw-gap-1",
"tw-border-0 tw-border-b tw-border-solid tw-border-medusa-border-base dark:tw-border-medusa-border-base-dark"
"flex pt-0 pr-1 pb-1.5 pl-1 gap-1",
"border-0 border-b border-solid border-medusa-border-base dark:border-medusa-border-base-dark"
)}
>
<div className="tw-w-2 tw-flex-none"></div>
<div className={clsx("tw-flex tw-flex-col", children && "tw-gap-1")}>
<div className="w-2 flex-none"></div>
<div className={clsx("flex flex-col", children && "gap-1")}>
{text && (
<span
className={clsx(
"tw-text-body-regular tw-text-medusa-text-subtle dark:tw-text-medusa-text-subtle-dark"
"text-medium text-medusa-fg-subtle dark:text-medusa-fg-subtle-dark"
)}
>
{text}
@@ -79,7 +78,7 @@ const NotificationItemLayoutDefault: React.FC<
</div>
)}
{isClosable && (
<div className={clsx("tw-p-1 tw-flex tw-justify-end tw-items-center")}>
<div className={clsx("p-1 flex justify-end items-center")}>
<Button onClick={handleClose}>Close</Button>
</div>
)}

View File

@@ -1,5 +1,5 @@
import clsx from "clsx"
import React, { Children, ReactElement, useEffect, useRef } from "react"
import React, { Children, ReactElement } from "react"
import NotificationItemLayoutDefault from "./Layout/Default"
export type NotificationItemProps = {
@@ -35,13 +35,13 @@ const Notification = ({
return (
<div
className={clsx(
"md:tw-max-w-[320px] md:tw-w-[320px] tw-w-full tw-bg-medusa-bg-base dark:tw-bg-medusa-bg-base-dark tw-rounded",
"tw-shadow-flyout dark:tw-shadow-flyout-dark",
"tw-fixed md:tw-right-1 tw-left-0 tw-block tw-z-[400]",
placement === "bottom" && "md:tw-bottom-1 tw-bottom-0",
placement === "top" && "md:tw-top-1 tw-top-0",
"tw-opacity-100 tw-transition-opacity tw-duration-200 tw-ease-ease",
!show && "!tw-opacity-0",
"md:max-w-[320px] md:w-[320px] w-full bg-medusa-bg-base dark:bg-medusa-bg-base-dark rounded",
"shadow-flyout dark:shadow-flyout-dark",
"fixed md:right-1 left-0 block z-[400]",
placement === "bottom" && "md:bottom-1 bottom-0",
placement === "top" && "md:top-1 top-0",
"opacity-100 transition-opacity duration-200 ease-ease",
!show && "!opacity-0",
className
)}
>