muffin-admin 3.9.0 → 3.10.0

package/dist/types.d.ts

@@ -93,5 +93,6 @@ export type AdminOpts = {
     };
     dashboard: AdminDashboardBlock[] | AdminDashboardBlock;
     resources: AdminResourceProps[];
+    help?: string;
     version: string;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "muffin-admin",
-  "version": "3.9.0",
+  "version": "3.10.0",
   "description": "NPM package for https://github.com/klen/muffin-admin",
   "files": [
     "src",

package/src/MuffinDashboard.tsx

@@ -1,21 +1,34 @@
 import Card from "@mui/material/Card"
 import CardContent from "@mui/material/CardContent"
 import Grid from "@mui/material/Grid"
+import Stack from "@mui/material/Stack"
 import Table from "@mui/material/Table"
 import TableBody from "@mui/material/TableBody"
 import TableCell from "@mui/material/TableCell"
 import TableRow from "@mui/material/TableRow"
 import Typography from "@mui/material/Typography"
+import { useTranslate } from "react-admin"
+import { HelpLink } from "./common/HelpLink"
 import { useMuffinAdminOpts } from "./hooks"
 import { AdminDashboardBlock } from "./types"
 import { setupAdmin } from "./utils"
 
 export function MuffinDashboard() {
-  const { dashboard } = useMuffinAdminOpts()
+  const { dashboard, help } = useMuffinAdminOpts()
+  const translate = useTranslate()
   return (
-    <Grid container spacing={1}>
-      <AdminCards src={dashboard} />
-    </Grid>
+    <Stack gap={2}>
+      {help && (
+        <Card>
+          <CardContent>
+            <HelpLink size="large" href={help} label={translate("muffin.how_to_use_admin")} />
+          </CardContent>
+        </Card>
+      )}
+      <Grid container spacing={1}>
+        <AdminCards src={dashboard} />
+      </Grid>
+    </Stack>
   )
 }
 

package/src/i18n/en.ts

@@ -1,6 +1,7 @@
 const muffinEnglishMessages = {
   muffin: {
     instructions: "Instructions",
+    how_to_use_admin: "How to use Admin?",
   },
 }
 

package/src/i18n/ru.ts

@@ -1,6 +1,7 @@
 const muffinRussianMessages = {
   muffin: {
     instructions: "Инструкции",
+    how_to_use_admin: "Как использовать админку?",
   },
 }
 

package/src/types.ts

@@ -15,7 +15,7 @@ export type AdminAction = {
 }
 
 export type AdminField = [string, { source: string }]
-export type AdminInput = [string, { required: boolean; source: string; [key: string]: any }]
+export type AdminInput = [string, { required: boolean; source: string;[key: string]: any }]
 
 export type AdminShowLink = {
   label: string
@@ -46,11 +46,11 @@ export type AdminResourceProps = {
   actions: AdminAction[]
   create: AdminInput[] | false
   edit:
-    | {
-        inputs: AdminInput[]
-        remove?: boolean
-      }
-    | false
+  | {
+    inputs: AdminInput[]
+    remove?: boolean
+  }
+  | false
   list: {
     limit: number
     limitMax: number
@@ -95,5 +95,6 @@ export type AdminOpts = {
   }
   dashboard: AdminDashboardBlock[] | AdminDashboardBlock
   resources: AdminResourceProps[]
+  help?: string
   version: string
 }