docs: create docs workspace (#5174)

* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
2023-09-21 20:57:15 +03:00
parent 19c5d5ba36
commit fa7c94b4cc
3209 changed files with 32188 additions and 31018 deletions
@@ -0,0 +1,94 @@
+import { InformationCircleSolid } from "@medusajs/icons"
+import { Table, Tooltip } from "@medusajs/ui"
+
+import { HookData, HookDataMap } from "@/types/hooks"
+import { EnumType, FunctionType, ObjectType } from "@/types/props"
+
+const HookTable = ({ props }: { props: HookDataMap }) => {
+  return (
+    <Table>
+      <Table.Header className="border-t-0">
+        <Table.Row>
+          <Table.HeaderCell>Value</Table.HeaderCell>
+          <Table.HeaderCell>Type</Table.HeaderCell>
+          <Table.HeaderCell>Description</Table.HeaderCell>
+        </Table.Row>
+      </Table.Header>
+      <Table.Body className="border-b-0 [&_tr:last-child]:border-b-0">
+        {/* eslint-disable-next-line react/prop-types */}
+        {props.map((propData, index) => (
+          <Row key={index} {...propData} />
+        ))}
+      </Table.Body>
+    </Table>
+  )
+}
+
+const Row = ({ value, type, description }: HookData) => {
+  const isEnum = (t: unknown): t is EnumType => {
+    return (t as EnumType).type !== undefined && (t as EnumType).type === "enum"
+  }
+
+  const isObject = (t: unknown): t is ObjectType => {
+    return (
+      (t as ObjectType).type !== undefined &&
+      (t as ObjectType).type === "object"
+    )
+  }
+
+  const isFunction = (t: unknown): t is FunctionType => {
+    return (
+      (t as FunctionType).type !== undefined &&
+      (t as FunctionType).type === "function"
+    )
+  }
+
+  const isComplexType = isEnum(type) || isObject(type) || isFunction(type)
+
+  return (
+    <Table.Row className="code-body">
+      <Table.Cell>{value}</Table.Cell>
+      <Table.Cell>
+        {!isComplexType && type.toString()}
+        {isEnum(type) && (
+          <Tooltip
+            content={type.values.map((v) => `"${v}"`).join(" | ")}
+            className="font-mono"
+          >
+            <div className="flex items-center gap-x-1">
+              <span>enum</span>
+              <InformationCircleSolid className="text-medusa-fg-subtle dark:text-medusa-fg-subtle-dark" />
+            </div>
+          </Tooltip>
+        )}
+        {isObject(type) && (
+          <Tooltip
+            content={<pre>{type.shape}</pre>}
+            className="font-mono"
+            maxWidth={500}
+          >
+            <div className="flex items-center gap-x-1">
+              <span>{type.name}</span>
+              <InformationCircleSolid className="text-medusa-fg-subtle dark:text-medusa-fg-subtle-dark" />
+            </div>
+          </Tooltip>
+        )}
+        {isFunction(type) && (
+          <Tooltip
+            content={<pre>{type.signature}</pre>}
+            className="font-mono"
+            maxWidth={500}
+          >
+            <div className="flex items-center gap-x-1">
+              <span>function</span>
+              <InformationCircleSolid className="text-medusa-fg-subtle dark:text-medusa-fg-subtle-dark" />
+            </div>
+          </Tooltip>
+        )}
+      </Table.Cell>
+      <Table.Cell>{description}</Table.Cell>
+    </Table.Row>
+  )
+}
+
+export { HookTable }