druxt-menu 0.15.0 → 0.16.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.
@@ -5,11 +5,30 @@ import DruxtModule from 'druxt/dist/components/DruxtModule.vue'
5
5
  import { mapActions, mapGetters, mapState } from 'vuex'
6
6
 
7
7
  /**
8
- * Renders a Drupal menu using either the default Drupal content menus, or the
9
- * full menu via the JSON:API Menu Items module.
8
+ * The DruxtMenu component renders a Drupal menu using either the default
9
+ * Drupal content menus, or the full menu via the JSON:API Menu Items module.
10
10
  *
11
11
  * @example @lang vue
12
12
  * <DruxtMenu name="main" />
13
+ *
14
+ * @example <caption>DruxtMenu Wrapper component boilerplate</caption> @lang vue
15
+ * <template>
16
+ * <DruxtDebug :json="items" />
17
+ * </template>
18
+ *
19
+ * <script>
20
+ * import { DruxtMenuMixin } from 'druxt-menu'
21
+ * export default {
22
+ * mixins: [DruxtMenuMixin]
23
+ * }
24
+ *
25
+ * @example <caption>DruxtMenu with template injection</caption> @lang vue
26
+ * <DruxtMenu>
27
+ * <template #default="{ items }">
28
+ * <!-- Do whatever you want here -->
29
+ * <DruxtDebug :json="items" />
30
+ * </template>
31
+ * </DruxtMenu>
13
32
  */
14
33
  export default {
15
34
  name: 'DruxtMenu',
@@ -24,7 +43,7 @@ export default {
24
43
  * @example @lang vue
25
44
  * <DruxtMenu :depth="1" />
26
45
  *
27
- * @type {integer}
46
+ * @type {number}
28
47
  * @default 0
29
48
  */
30
49
  depth: {
@@ -59,7 +78,7 @@ export default {
59
78
  * @example @lang vue
60
79
  * <DruxtMenu :max-depth="4" />
61
80
  *
62
- * @type {integer}
81
+ * @type {number}
63
82
  */
64
83
  maxDepth: {
65
84
  type: Number,
@@ -72,7 +91,7 @@ export default {
72
91
  * @example @lang vue
73
92
  * <DruxtMenu :min-depth="2" />
74
93
  *
75
- * @type {Integer}
94
+ * @type {number}
76
95
  * @default 0
77
96
  */
78
97
  minDepth: {
@@ -206,7 +225,7 @@ export default {
206
225
  * Recursively gets required menu items from the Vuex store.
207
226
  *
208
227
  * @param {object} [entity] - Current menu item entity.
209
- * @param {integer} [position] - Current position in the menu tree,
228
+ * @param {number} [position] - Current position in the menu tree,
210
229
  */
211
230
  getMenuItems(entity = null, position = 0) {
212
231
  const items = []
@@ -8,19 +8,23 @@ async function DruxtMenuStorybook({ stories }) {
8
8
  const druxt = new DruxtClient(options.druxt.baseUrl, { ...options.druxt, proxy: { api: false } });
9
9
  const resourceType = "menu--menu";
10
10
  const query = new DrupalJsonApiParams().addFilter("status", 1).addFields(resourceType, ["description", "drupal_internal__id", "label"]);
11
- const collections = await druxt.getCollectionAll(resourceType, query);
12
- for (const collection of collections) {
13
- for (const menu of collection.data) {
14
- const name = menu.attributes.drupal_internal__id;
15
- const { description, label } = menu.attributes;
16
- const title = titleFn(["Druxt", "Menu", label]);
17
- addTemplate({
18
- src: resolve(__dirname, "../templates/druxt-menu.stories.js"),
19
- fileName: `stories/druxt-menu.${name}.stories.js`,
20
- options: { description, label, name, title }
21
- });
22
- }
23
- }
11
+ const menus = (await druxt.getCollectionAll(resourceType, query)).map((collection) => collection.data).flat();
12
+ addTemplate({
13
+ src: resolve(__dirname, `../templates/druxt-menu.stories.js`),
14
+ fileName: `stories/druxt-menu.stories.js`,
15
+ options: { menus }
16
+ });
17
+ stories.push(resolve(options.buildDir, "./stories/druxt-menu.stories.js"));
18
+ menus.forEach((menu) => {
19
+ const name = menu.attributes.drupal_internal__id;
20
+ const { description, label } = menu.attributes;
21
+ const title = titleFn(["Druxt", "Menu", label]);
22
+ addTemplate({
23
+ src: resolve(__dirname, "../templates/druxt-menu.instance.stories.js"),
24
+ fileName: `stories/druxt-menu.${name}.stories.js`,
25
+ options: { description, label, name, title }
26
+ });
27
+ });
24
28
  stories.push(resolve(options.buildDir, "./stories/druxt-menu.*.stories.js"));
25
29
  }
26
30
 
@@ -49,7 +53,6 @@ const DruxtMenuNuxtModule = function(moduleOptions = {}) {
49
53
  options
50
54
  });
51
55
  this.nuxt.hook("storybook:config", async ({ stories }) => {
52
- stories.push("druxt-menu/dist/components/*.stories.mjs");
53
56
  await DruxtMenuStorybook.call(this, { stories });
54
57
  });
55
58
  };
@@ -12,19 +12,23 @@ async function DruxtMenuStorybook({ stories }) {
12
12
  const druxt$1 = new druxt.DruxtClient(options.druxt.baseUrl, { ...options.druxt, proxy: { api: false } });
13
13
  const resourceType = "menu--menu";
14
14
  const query = new drupalJsonapiParams.DrupalJsonApiParams().addFilter("status", 1).addFields(resourceType, ["description", "drupal_internal__id", "label"]);
15
- const collections = await druxt$1.getCollectionAll(resourceType, query);
16
- for (const collection of collections) {
17
- for (const menu of collection.data) {
18
- const name = menu.attributes.drupal_internal__id;
19
- const { description, label } = menu.attributes;
20
- const title = titleFn(["Druxt", "Menu", label]);
21
- addTemplate({
22
- src: path.resolve(__dirname, "../templates/druxt-menu.stories.js"),
23
- fileName: `stories/druxt-menu.${name}.stories.js`,
24
- options: { description, label, name, title }
25
- });
26
- }
27
- }
15
+ const menus = (await druxt$1.getCollectionAll(resourceType, query)).map((collection) => collection.data).flat();
16
+ addTemplate({
17
+ src: path.resolve(__dirname, `../templates/druxt-menu.stories.js`),
18
+ fileName: `stories/druxt-menu.stories.js`,
19
+ options: { menus }
20
+ });
21
+ stories.push(path.resolve(options.buildDir, "./stories/druxt-menu.stories.js"));
22
+ menus.forEach((menu) => {
23
+ const name = menu.attributes.drupal_internal__id;
24
+ const { description, label } = menu.attributes;
25
+ const title = titleFn(["Druxt", "Menu", label]);
26
+ addTemplate({
27
+ src: path.resolve(__dirname, "../templates/druxt-menu.instance.stories.js"),
28
+ fileName: `stories/druxt-menu.${name}.stories.js`,
29
+ options: { description, label, name, title }
30
+ });
31
+ });
28
32
  stories.push(path.resolve(options.buildDir, "./stories/druxt-menu.*.stories.js"));
29
33
  }
30
34
 
@@ -53,7 +57,6 @@ const DruxtMenuNuxtModule = function(moduleOptions = {}) {
53
57
  options
54
58
  });
55
59
  this.nuxt.hook("storybook:config", async ({ stories }) => {
56
- stories.push("druxt-menu/dist/components/*.stories.mjs");
57
60
  await DruxtMenuStorybook.call(this, { stories });
58
61
  });
59
62
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "druxt-menu",
3
- "version": "0.15.0",
3
+ "version": "0.16.0",
4
4
  "description": "Drupal Menu and Menu item Druxt components, with support for the JSON:API Menu Items module.",
5
5
  "keywords": [
6
6
  "cms",
@@ -44,8 +44,8 @@
44
44
  "dependencies": {
45
45
  "deepmerge": "^4.2.2",
46
46
  "drupal-jsonapi-params": "^1.1.12",
47
- "druxt": "^0.13.0",
48
- "druxt-blocks": "^0.14.0"
47
+ "druxt": "^0.17.0",
48
+ "druxt-blocks": "^0.15.0"
49
49
  },
50
50
  "optionalDependencies": {
51
51
  "vue": "^2.6.14",
@@ -0,0 +1,34 @@
1
+ import DruxtMenu from 'druxt-menu/dist/components/DruxtMenu.vue'
2
+
3
+ export default {
4
+ title: '<%= options.title %>',
5
+ component: DruxtMenu,
6
+ argTypes: {
7
+ name: { table: { disable: true } },
8
+ },
9
+ parameters: {
10
+ docs: {
11
+ description: {
12
+ component: '<%= options.description || " " %>'
13
+ }
14
+ }
15
+ }
16
+ }
17
+
18
+ export const Default = (args, { argTypes }) => {
19
+ return {
20
+ props: Object.keys(args),
21
+ template: '<DruxtMenu v-bind="$props" v-on="$props" />',
22
+ }
23
+ }
24
+ Default.storyName = '<%= options.label %>'
25
+ Default.args = {
26
+ name: '<%= options.name %>',
27
+ }
28
+ Default.parameters = {
29
+ docs: {
30
+ source: {
31
+ code: '<DruxtMenu name="<%= options.name %>" />'
32
+ }
33
+ }
34
+ }
@@ -1,41 +1,72 @@
1
1
  import DruxtMenu from 'druxt-menu/dist/components/DruxtMenu.vue'
2
2
 
3
3
  export default {
4
- title: '<%= options.title %>',
4
+ title: 'Druxt/Menu/DruxtMenu',
5
5
  component: DruxtMenu,
6
6
  argTypes: {
7
- name: { control: null },
8
- depth: {
7
+ name: {
8
+ options: [<%= (options.menus || []).map((menu) => `'${menu.attributes.drupal_internal__id}'`).join(', ') %>],
9
9
  control: {
10
- type: 'number',
11
- min: 0
10
+ type: 'select',
11
+ labels: Object.fromEntries([<%= (options.menus || []).map((o) => `['${o.attributes.drupal_internal__id}', "${o.attributes.label}"]`).join(', ') %>])
12
12
  }
13
- }
14
- },
15
- parameters: {
16
- docs: {
17
- description: {
18
- component: '<%= options.description || " " %>'
19
- }
20
- }
13
+ },
21
14
  }
22
15
  }
23
16
 
24
- const Template = (args, { argTypes }) => {
25
- return {
26
- props: Object.keys(args),
27
- template: '<DruxtMenu v-bind="$props" v-on="$props" />',
17
+ export const Default = (args, { argTypes }) => ({
18
+ components: { DruxtMenu },
19
+ props: Object.keys(argTypes),
20
+ template: `<DruxtMenu v-bind="$props" />`
21
+ })
22
+
23
+ let code
24
+
25
+ // Wrapper story.
26
+ code = `<template>
27
+ <DruxtDebug :json="items" />
28
+ </template>
29
+
30
+ <script>
31
+ import { DruxtMenuMixin } from 'druxt-menu'
32
+ export default {
33
+ mixins: [DruxtMenuMixin]
34
+ }
35
+ </script>`
36
+ export const Wrapper = (args, { argTypes }) => ({
37
+ components: { DruxtMenu },
38
+ props: Object.keys(argTypes),
39
+ template: `<DruxtMenu v-bind="$props" ref="module">
40
+ <template #default>
41
+ Component options:
42
+ <ul>
43
+ <li v-for="option of $refs.module.getModuleComponents()" :key="option.name">{{ option.name }}</li>
44
+ </ul>
45
+ </template>
46
+ </DruxtMenu>`
47
+ })
48
+ Wrapper.parameters = {
49
+ docs: {
50
+ storyDescription: 'The DruxtMenu component can be themed by using a Druxt Wrapper component.\n\nCreate an appropriately named component, using the relevant component option, with the following boilerplate:\n\n```jsx\n' + code + '\n```',
51
+ source: { code }
28
52
  }
29
53
  }
30
54
 
31
- export const Default = Template.bind({})
32
- Default.args = {
33
- name: '<%= options.name %>',
34
- }
35
- Default.parameters = {
55
+ // Template injection story.
56
+ code = `<DruxtMenu name="">
57
+ <template #default="{ items }">
58
+ <!-- Do whatever you want here -->
59
+ <DruxtDebug :json="items" open />
60
+ </template>
61
+ </DruxtMenu>`
62
+ export const TemplateInjection = (args, { argTypes }) => ({
63
+ components: { DruxtMenu },
64
+ props: Object.keys(argTypes),
65
+ template: code.replace('name=""', 'v-bind="$props"')
66
+ })
67
+ TemplateInjection.parameters = {
36
68
  docs: {
37
- source: {
38
- code: '<DruxtMenu name="<%= options.name %>" />'
39
- }
69
+ storyDescription: 'The DruxtMenu component can be themed by injecting the default template into the compomnent.\n\n```jsx\n' + code + '\n```',
70
+ source: { code }
40
71
  }
41
72
  }
package/CHANGELOG.md DELETED
@@ -1,185 +0,0 @@
1
- # druxt-menu
2
-
3
- ## 0.15.0
4
-
5
- ### Minor Changes
6
-
7
- - e7b1533: Refactored DruxtModule fetch hooks
8
-
9
- ### Patch Changes
10
-
11
- - Updated dependencies [77ab204]
12
- - druxt-blocks@0.14.0
13
- - druxt@0.13.0
14
-
15
- ## 0.14.3
16
-
17
- ### Patch Changes
18
-
19
- - 631598d: Removed debug code
20
-
21
- ## 0.14.1
22
-
23
- ### Patch Changes
24
-
25
- - ee15810: Fixed bug when menu endpoint fails
26
- - Updated dependencies [4504a2f]
27
- - druxt@0.12.0
28
- - druxt-blocks@0.13.1
29
-
30
- ## 0.14.0
31
-
32
- ### Minor Changes
33
-
34
- - dae345e: Added module level options
35
- - 8d28c18: Updated storybook integration
36
-
37
- ### Patch Changes
38
-
39
- - Updated dependencies [dae345e]
40
- - druxt-blocks@0.13.0
41
- - druxt@0.11.0
42
-
43
- ## 0.13.0
44
-
45
- ### Minor Changes
46
-
47
- - 715e5ef: Updated component registration method to use the Nuxt `components:dirs` hook
48
-
49
- ### Patch Changes
50
-
51
- - 49454cb: Fixed path to components in Storybook
52
- - Updated dependencies [715e5ef]
53
- - druxt-blocks@0.12.0
54
- - druxt@0.10.0
55
-
56
- ## 0.12.1
57
-
58
- ### Patch Changes
59
-
60
- - c4616df: Fixed dependencies
61
- - Updated dependencies [c4616df]
62
- - druxt-blocks@0.11.1
63
-
64
- ## 0.12.0
65
-
66
- ### Minor Changes
67
-
68
- - 21170fb: Moved Vue components out of bundle
69
-
70
- ⚠ Potential breaking change
71
-
72
- _**Note:** This only effects custom Druxt modules and implementations._
73
-
74
- ```diff
75
- -import { DruxtMenu } from 'druxt-menu'
76
- +import DruxtMenu from 'druxt-menu/dist/components/DruxtMenu.vue'
77
- ```
78
-
79
- ### Patch Changes
80
-
81
- - Updated dependencies [21170fb]
82
- - druxt-blocks@0.11.0
83
- - druxt@0.9.0
84
-
85
- ## 0.11.0
86
-
87
- ### Minor Changes
88
-
89
- - Added support for default template injection
90
-
91
- - For details, see the [Druxt 0.8.0 release notes](/api/packages/druxt/CHANGELOG#080)
92
-
93
- - Added support for v-model
94
- - Updated dependencies
95
-
96
- ## 0.10.3
97
-
98
- ### Patch Changes
99
-
100
- - Added fetchKey to fix hydration issue
101
-
102
- ## 0.10.2
103
-
104
- ### Patch Changes
105
-
106
- - Fixed hydration issue
107
-
108
- ## 0.10.1
109
-
110
- ### Patch Changes
111
-
112
- - Added parentId prop
113
- - Fixed issue with missing \$attrs / propsData
114
-
115
- ## 0.10.0
116
-
117
- ### Minor Changes
118
-
119
- - Refactored DruxtMenu component for DruxtModule
120
- - Added ability to filter JSON:API fields
121
-
122
- ## 0.9.0
123
-
124
- ### Minor Changes
125
-
126
- - Added Storybook integration
127
- - Fixed bug with parent template
128
-
129
- ## 0.8.0
130
-
131
- ### Minor Changes
132
-
133
- - Added support for DruxtClient and DruxtStore
134
-
135
- ## 0.7.0
136
-
137
- ### Minor Changes
138
-
139
- - Added [DruxtMenuMixin](/api/packages/menu/mixins/menu)
140
-
141
- ## 0.6.2
142
-
143
- ### Patch Changes
144
-
145
- - Updated dependencies
146
-
147
- ## 0.6.1
148
-
149
- ### Patch Changes
150
-
151
- - Updated dependencies
152
-
153
- ## 0.6.0
154
-
155
- ### Minor Changes
156
-
157
- - Updated DruxtMenu for Druxt component system
158
- - Added \$attrs passthrough
159
-
160
- ## 0.5.0
161
-
162
- ### Minor Changes
163
-
164
- - Improved support for JSON:API Menu Item subtrees
165
- - Updated dependencies
166
-
167
- ## 0.4.0
168
-
169
- ### Minor Changes
170
-
171
- ## 0.3.0
172
-
173
- ### Minor Changes
174
-
175
- ## 0.2.0
176
-
177
- ### Minor Changes
178
-
179
- ## 0.1.1
180
-
181
- ### Patch Changes
182
-
183
- ## 0.1.0
184
-
185
- ### Initial release
@@ -1,15 +0,0 @@
1
- import DruxtMenu from './DruxtMenu.vue'
2
-
3
- export default {
4
- title: 'Druxt/Menu/DruxtMenu',
5
- component: DruxtMenu
6
- }
7
-
8
- const Template = (args, { argTypes }) => ({
9
- components: { DruxtMenu },
10
- props: Object.keys(argTypes),
11
- template: `<DruxtMenu v-bind="$props" />`
12
- })
13
-
14
- export const Default = Template.bind({})
15
- Default.storyName = 'DruxtMenu'