@foundrykit/menu-plugin 0.4.2 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +87 -2
- package/dist/collections/Menus.d.ts +3 -2
- package/dist/collections/Menus.js +10 -1
- package/dist/collections/Menus.js.map +1 -1
- package/dist/components/MegaEntryRowLabel.d.ts +1 -0
- package/dist/components/MegaEntryRowLabel.js +12 -0
- package/dist/components/MegaEntryRowLabel.js.map +1 -0
- package/dist/exports/client.d.ts +1 -1
- package/dist/exports/client.js +1 -1
- package/dist/exports/client.js.map +1 -1
- package/dist/fields/MenuItem.d.ts +2 -0
- package/dist/fields/MenuItem.js +276 -220
- package/dist/fields/MenuItem.js.map +1 -1
- package/dist/hooks/resolveDynamicMenu.d.ts +13 -0
- package/dist/hooks/resolveDynamicMenu.js +221 -0
- package/dist/hooks/resolveDynamicMenu.js.map +1 -0
- package/dist/index.d.ts +7 -0
- package/dist/index.js +3 -0
- package/dist/index.js.map +1 -1
- package/dist/migrations/megaColumnsToEntries.d.ts +19 -0
- package/dist/migrations/megaColumnsToEntries.js +142 -0
- package/dist/migrations/megaColumnsToEntries.js.map +1 -0
- package/dist/types.d.ts +34 -0
- package/dist/types.js +6 -0
- package/dist/types.js.map +1 -0
- package/package.json +25 -32
package/dist/types.d.ts
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import type { CollectionSlug } from 'payload';
|
|
2
|
+
/**
|
|
3
|
+
* Configuration describing how a mega menu entry can auto-populate its children
|
|
4
|
+
* (and optional featured content) from a related collection.
|
|
5
|
+
*/
|
|
6
|
+
export type DynamicSource = {
|
|
7
|
+
/** collection queried for children */
|
|
8
|
+
collection: CollectionSlug;
|
|
9
|
+
/** optional featured resolution from a child (or parent) doc */
|
|
10
|
+
featured?: {
|
|
11
|
+
ctaHrefBuilder?: (doc: Record<string, unknown>) => string;
|
|
12
|
+
ctaLabel?: string;
|
|
13
|
+
descriptionField?: string;
|
|
14
|
+
headingField?: string;
|
|
15
|
+
/** dot-path to an upload/media field */
|
|
16
|
+
imageField?: string;
|
|
17
|
+
};
|
|
18
|
+
/** build a child's href from its doc */
|
|
19
|
+
hrefBuilder: (doc: Record<string, unknown>) => string;
|
|
20
|
+
/** label shown in the admin select */
|
|
21
|
+
label: string;
|
|
22
|
+
/** field on a child doc used as its label */
|
|
23
|
+
labelField: string;
|
|
24
|
+
/** optional limit on children */
|
|
25
|
+
limit?: number;
|
|
26
|
+
/** stable id, stored in the `dynamicSource` field */
|
|
27
|
+
name: string;
|
|
28
|
+
/** collection the editor picks a parent from */
|
|
29
|
+
parentCollection: CollectionSlug;
|
|
30
|
+
/** field on `collection` relating each child to its parent */
|
|
31
|
+
parentField: string;
|
|
32
|
+
/** sort applied to the children query (Payload sort string) */
|
|
33
|
+
sort?: string;
|
|
34
|
+
};
|
package/dist/types.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/types.ts"],"sourcesContent":["import type { CollectionSlug } from 'payload'\n\n/**\n * Configuration describing how a mega menu entry can auto-populate its children\n * (and optional featured content) from a related collection.\n */\nexport type DynamicSource = {\n /** collection queried for children */\n collection: CollectionSlug\n /** optional featured resolution from a child (or parent) doc */\n featured?: {\n ctaHrefBuilder?: (doc: Record<string, unknown>) => string\n ctaLabel?: string\n descriptionField?: string\n headingField?: string\n /** dot-path to an upload/media field */\n imageField?: string\n }\n /** build a child's href from its doc */\n hrefBuilder: (doc: Record<string, unknown>) => string\n /** label shown in the admin select */\n label: string\n /** field on a child doc used as its label */\n labelField: string\n /** optional limit on children */\n limit?: number\n /** stable id, stored in the `dynamicSource` field */\n name: string\n /** collection the editor picks a parent from */\n parentCollection: CollectionSlug\n /** field on `collection` relating each child to its parent */\n parentField: string\n /** sort applied to the children query (Payload sort string) */\n sort?: string\n}\n"],"names":[],"mappings":"AAEA;;;CAGC,GACD,WA4BC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@foundrykit/menu-plugin",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.6.0",
|
|
4
4
|
"description": "A plugin for Payload CMS that provides a flexible and customisable menu system.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -37,28 +37,6 @@
|
|
|
37
37
|
"files": [
|
|
38
38
|
"dist"
|
|
39
39
|
],
|
|
40
|
-
"scripts": {
|
|
41
|
-
"build": "pnpm copyfiles && pnpm build:types && pnpm build:swc",
|
|
42
|
-
"build:swc": "swc ./src -d ./dist --config-file .swcrc --strip-leading-paths",
|
|
43
|
-
"build:types": "tsc --outDir dist --rootDir ./src",
|
|
44
|
-
"clean": "rimraf {dist,*.tsbuildinfo}",
|
|
45
|
-
"copyfiles": "copyfiles -u 1 \"src/**/*.{html,css,scss,ttf,woff,woff2,eot,svg,jpg,png,json}\" dist/",
|
|
46
|
-
"dev": "next dev dev --turbo",
|
|
47
|
-
"dev:db:up": "docker-compose -f dev/docker-compose.yml up -d",
|
|
48
|
-
"dev:db:down": "docker-compose -f dev/docker-compose.yml down",
|
|
49
|
-
"dev:with-db": "docker-compose -f dev/docker-compose.yml up -d && pnpm dev && docker-compose -f dev/docker-compose.yml down",
|
|
50
|
-
"dev:generate-importmap": "pnpm dev:payload generate:importmap",
|
|
51
|
-
"dev:generate-types": "pnpm dev:payload generate:types",
|
|
52
|
-
"dev:payload": "cross-env PAYLOAD_CONFIG_PATH=./dev/payload.config.ts payload",
|
|
53
|
-
"generate:importmap": "pnpm dev:generate-importmap",
|
|
54
|
-
"generate:types": "pnpm dev:generate-types",
|
|
55
|
-
"lint": "eslint",
|
|
56
|
-
"lint:fix": "eslint ./src --fix",
|
|
57
|
-
"test": "pnpm test:int && pnpm test:e2e",
|
|
58
|
-
"test:e2e": "playwright test",
|
|
59
|
-
"test:int": "vitest",
|
|
60
|
-
"release": "release-it"
|
|
61
|
-
},
|
|
62
40
|
"devDependencies": {
|
|
63
41
|
"@eslint/eslintrc": "^3.2.0",
|
|
64
42
|
"@payloadcms/db-mongodb": "3.37.0",
|
|
@@ -106,13 +84,6 @@
|
|
|
106
84
|
"publishConfig": {
|
|
107
85
|
"access": "public"
|
|
108
86
|
},
|
|
109
|
-
"pnpm": {
|
|
110
|
-
"onlyBuiltDependencies": [
|
|
111
|
-
"sharp",
|
|
112
|
-
"esbuild",
|
|
113
|
-
"unrs-resolver"
|
|
114
|
-
]
|
|
115
|
-
},
|
|
116
87
|
"repository": {
|
|
117
88
|
"type": "git",
|
|
118
89
|
"url": "https://github.com/umi-labs/menu-plugin"
|
|
@@ -120,5 +91,27 @@
|
|
|
120
91
|
"bugs": {
|
|
121
92
|
"url": "https://github.com/umi-labs/menu-plugin/issues"
|
|
122
93
|
},
|
|
123
|
-
"homepage": "https://github.com/umi-labs/menu-plugin#readme"
|
|
124
|
-
|
|
94
|
+
"homepage": "https://github.com/umi-labs/menu-plugin#readme",
|
|
95
|
+
"scripts": {
|
|
96
|
+
"build": "pnpm copyfiles && pnpm build:types && pnpm build:swc",
|
|
97
|
+
"build:swc": "swc ./src -d ./dist --config-file .swcrc --strip-leading-paths",
|
|
98
|
+
"build:types": "tsc --outDir dist --rootDir ./src",
|
|
99
|
+
"clean": "rimraf {dist,*.tsbuildinfo}",
|
|
100
|
+
"copyfiles": "copyfiles -u 1 \"src/**/*.{html,css,scss,ttf,woff,woff2,eot,svg,jpg,png,json}\" dist/",
|
|
101
|
+
"dev": "next dev dev --turbo",
|
|
102
|
+
"dev:db:up": "docker-compose -f dev/docker-compose.yml up -d",
|
|
103
|
+
"dev:db:down": "docker-compose -f dev/docker-compose.yml down",
|
|
104
|
+
"dev:with-db": "docker-compose -f dev/docker-compose.yml up -d && pnpm dev && docker-compose -f dev/docker-compose.yml down",
|
|
105
|
+
"dev:generate-importmap": "pnpm dev:payload generate:importmap",
|
|
106
|
+
"dev:generate-types": "pnpm dev:payload generate:types",
|
|
107
|
+
"dev:payload": "cross-env PAYLOAD_CONFIG_PATH=./dev/payload.config.ts payload",
|
|
108
|
+
"generate:importmap": "pnpm dev:generate-importmap",
|
|
109
|
+
"generate:types": "pnpm dev:generate-types",
|
|
110
|
+
"lint": "eslint",
|
|
111
|
+
"lint:fix": "eslint ./src --fix",
|
|
112
|
+
"test": "pnpm test:int && pnpm test:e2e",
|
|
113
|
+
"test:e2e": "playwright test",
|
|
114
|
+
"test:int": "vitest",
|
|
115
|
+
"release": "release-it"
|
|
116
|
+
}
|
|
117
|
+
}
|