docs: split admin widget zone to pages (#10719)

2024-12-24 12:29:41 +02:00
parent fd1afa8bc9
commit 041baafd38
57 changed files with 2992 additions and 2357 deletions
@@ -0,0 +1,93 @@
+import { Table } from "docs-ui"
+
+<Table>
+  <Table.Header>
+    <Table.Row>
+      <Table.HeaderCell className="w-1/3">Injection Zone Name</Table.HeaderCell>
+      <Table.HeaderCell className="w-1/3">Description</Table.HeaderCell>
+      <Table.HeaderCell className="w-1/3">Additional Props</Table.HeaderCell>
+    </Table.Row>
+  </Table.Header>
+  <Table.Body>
+    <Table.Row>
+      <Table.Cell>
+
+        `region.list.before`
+
+      </Table.Cell>
+      <Table.Cell>
+
+        Added at the top of the regions list page.
+
+      </Table.Cell>
+      <Table.Cell>
+
+        \-
+
+      </Table.Cell>
+    </Table.Row>
+    <Table.Row>
+      <Table.Cell>
+
+        `region.list.after`
+
+      </Table.Cell>
+      <Table.Cell>
+
+        Added at the bottom of the regions list page.
+
+      </Table.Cell>
+      <Table.Cell>
+
+        \-
+
+      </Table.Cell>
+    </Table.Row>
+    <Table.Row>
+      <Table.Cell>
+
+        `region.details.before`
+
+      </Table.Cell>
+      <Table.Cell>
+
+        Added at the top of a region's details page.
+
+      </Table.Cell>
+      <Table.Cell>
+      
+        Type `DetailWidgetProps<AdminRegion>` imported from `@medusajs/framework/types`
+
+        ```ts blockStyle="inline"
+        {
+          data, // AdminRegion object
+        }
+        ```
+
+      </Table.Cell>
+    </Table.Row>
+    <Table.Row>
+      <Table.Cell>
+
+        `region.details.after`
+
+      </Table.Cell>
+      <Table.Cell>
+
+        Added at the bottom of a region's details page.
+
+      </Table.Cell>
+      <Table.Cell>
+      
+        Type `DetailWidgetProps<AdminRegion>` imported from `@medusajs/framework/types`
+
+        ```ts blockStyle="inline"
+        {
+          data, // AdminRegion object
+        }
+        ```
+
+      </Table.Cell>
+    </Table.Row>
+  </Table.Body>
+</Table>
@@ -0,0 +1,13 @@
+import RegionContent from "./_content.mdx"
+
+export const metadata = {
+  title: `Region Module's Admin Widget Injection Zones`,
+}
+
+# {metadata.title}
+
+This reference shows all the injection zones in the Medusa Admin related to the Region Module.
+
+## Region Pages
+
+<RegionContent />