asyavee/medusa-store
1
0 Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

docs: added documentation for admin components (#9491)

Browse Source 
- Documented common admin components with design that matches the admin.
- Updated existing admin customization snippets to match the admin's design.

Closes DOCS-964
This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-10-14 07:18:38 +00:00
1 parent e3dc9eaf0c
commit 74b286b701
22 files changed
+2385 -241
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/resources/generated/edit-dates.mjs
+10
View File
@@ -2218,6 +2218,16 @@ export const generatedEditDates = {
"references/user/interfaces/user.IModuleService/page.mdx": "2024-10-03T00:12:20.657Z",
"references/user/interfaces/user.MessageAggregatorFormat/page.mdx": "2024-10-03T00:12:20.662Z",
"app/troubleshooting/dist-imports/page.mdx": "2024-10-03T09:19:37.639Z",
"app/admin-components/components/action-menu/page.mdx": "2024-10-07T11:16:26.178Z",
"app/admin-components/components/container/page.mdx": "2024-10-07T11:15:58.824Z",
"app/admin-components/components/header/page.mdx": "2024-10-07T11:16:47.407Z",
"app/admin-components/components/json-view-section/page.mdx": "2024-10-07T11:15:58.833Z",
"app/admin-components/components/section-row/page.mdx": "2024-10-07T11:15:58.832Z",
"app/admin-components/components/table/page.mdx": "2024-10-07T11:15:58.833Z",
"app/admin-components/page.mdx": "2024-10-07T11:09:49.493Z",
"app/admin-components/layouts/single-column/page.mdx": "2024-10-07T11:16:06.435Z",
"app/admin-components/layouts/two-column/page.mdx": "2024-10-07T11:16:10.092Z",
"app/admin-components/components/forms/page.mdx": "2024-10-09T12:48:04.229Z",
"app/commerce-modules/auth/reset-password/page.mdx": "2024-10-08T07:34:08.488Z",
"app/storefront-development/customers/reset-password/page.mdx": "2024-09-25T10:21:46.647Z",
"app/commerce-modules/api-key/links-to-other-modules/page.mdx": "2024-10-08T08:05:36.596Z",
www/apps/resources/generated/files-map.mjs
+40
View File
@@ -1,4 +1,44 @@
export const filesMap = [
{
"filePath": "/www/apps/resources/app/admin-components/components/action-menu/page.mdx",
"pathname": "/admin-components/components/action-menu"
},
{
"filePath": "/www/apps/resources/app/admin-components/components/container/page.mdx",
"pathname": "/admin-components/components/container"
},
{
"filePath": "/www/apps/resources/app/admin-components/components/forms/page.mdx",
"pathname": "/admin-components/components/forms"
},
{
"filePath": "/www/apps/resources/app/admin-components/components/header/page.mdx",
"pathname": "/admin-components/components/header"
},
{
"filePath": "/www/apps/resources/app/admin-components/components/json-view-section/page.mdx",
"pathname": "/admin-components/components/json-view-section"
},
{
"filePath": "/www/apps/resources/app/admin-components/components/section-row/page.mdx",
"pathname": "/admin-components/components/section-row"
},
{
"filePath": "/www/apps/resources/app/admin-components/components/table/page.mdx",
"pathname": "/admin-components/components/table"
},
{
"filePath": "/www/apps/resources/app/admin-components/layouts/single-column/page.mdx",
"pathname": "/admin-components/layouts/single-column"
},
{
"filePath": "/www/apps/resources/app/admin-components/layouts/two-column/page.mdx",
"pathname": "/admin-components/layouts/two-column"
},
{
"filePath": "/www/apps/resources/app/admin-components/page.mdx",
"pathname": "/admin-components"
},
{
"filePath": "/www/apps/resources/app/admin-widget-injection-zones/page.mdx",
"pathname": "/admin-widget-injection-zones"
www/apps/resources/generated/sidebar.mjs
+249 -138
View File
@@ -7725,128 +7725,6 @@ export const generatedSidebar = [
}
]
},
{
"type": "separator"
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "SDKs and Tools",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/create-medusa-app",
"title": "create-medusa-app",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli",
"title": "Medusa CLI",
"isChildSidebar": true,
"childSidebarTitle": "Medusa CLI Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli",
"title": "Overview",
"children": []
},
{
"type": "separator"
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Commands",
"autogenerate_path": "medusa-cli/commands",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/new",
"title": "new",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/develop",
"title": "develop",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/start",
"title": "start",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/user",
"title": "user",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/db",
"title": "db",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/exec",
"title": "exec",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/start-cluster",
"title": "start-cluster",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/telemtry",
"title": "telemetry",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/nextjs-starter",
"title": "Next.js Starter",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
@@ -8089,6 +7967,128 @@ export const generatedSidebar = [
}
]
},
{
"type": "separator"
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "SDKs and Tools",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/create-medusa-app",
"title": "create-medusa-app",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli",
"title": "Medusa CLI",
"isChildSidebar": true,
"childSidebarTitle": "Medusa CLI Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli",
"title": "Overview",
"children": []
},
{
"type": "separator"
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Commands",
"autogenerate_path": "medusa-cli/commands",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/new",
"title": "new",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/develop",
"title": "develop",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/start",
"title": "start",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/user",
"title": "user",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/db",
"title": "db",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/exec",
"title": "exec",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/start-cluster",
"title": "start-cluster",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/telemtry",
"title": "telemetry",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/nextjs-starter",
"title": "Next.js Starter",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
@@ -8523,14 +8523,6 @@ export const generatedSidebar = [
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/medusa-config",
"title": "Medusa Configurations",
"children": []
},
{
"type": "separator"
},
@@ -8540,6 +8532,14 @@ export const generatedSidebar = [
"type": "category",
"title": "General",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/medusa-config",
"title": "Medusa Configurations",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -8758,6 +8758,125 @@ export const generatedSidebar = [
}
]
},
{
"type": "separator"
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Admin",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/admin-widget-injection-zones",
"title": "Admin Widget Injection Zones",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/admin-components",
"title": "Admin Components",
"isChildSidebar": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Layouts",
"autogenerate_path": "/admin-components/layouts",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/admin-components/layouts/single-column",
"title": "Single Column",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/admin-components/layouts/two-column",
"title": "Two Column",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Components",
"autogenerate_path": "/admin-components/components",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/admin-components/components/action-menu",
"title": "Action Menu",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/admin-components/components/container",
"title": "Container",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/admin-components/components/forms",
"title": "Forms",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/admin-components/components/header",
"title": "Header",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/admin-components/components/json-view-section",
"title": "JSON View",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/admin-components/components/section-row",
"title": "Section Row",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/admin-components/components/table",
"title": "Table",
"children": []
}
]
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
@@ -8779,14 +8898,6 @@ export const generatedSidebar = [
"path": "/events-reference",
"title": "Events List",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/admin-widget-injection-zones",
"title": "Admin Widget Injection Zones",
"children": []
}
]
},