@webx-ui/module-menu 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 webx-ui
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,43 @@
+# @webx-ui/module-menu
+
+Menus as a section of the [WebX UI](https://github.com/webx-ui/webx-ui) admin panel: the named
+menus of a site, the tree of items in each one, and what every item points at.
+
+The other half is `webx-ui/module-menu` on the server, which holds the menus and renders them.
+Neither is useful alone.
+
+## Install
+
+```bash
+pnpm add @webx-ui/module-menu
+```
+
+```ts
+import { createAdmin } from '@webx-ui/module-admin'
+import { menu } from '@webx-ui/module-menu'
+import '@webx-ui/module-menu/style.css'
+
+createAdmin({
+  modules: [menu()],
+})
+```
+
+The section appears among the content sections once the Composer half is installed and migrated.
+Permissions: `menu.view`, `menu.manage`.
+
+## What it brings
+
+- `/menus` — the menus on the left, the items of the open one on the right. Which menu is open
+  travels in the address, so a link to the footer is a link somebody can send.
+- **Dragging** changes both the order and the parent: every level is its own list, and where a
+  row ends up is where it is.
+- **An item points at three things** — an entity chosen from the picker, an address of your own,
+  or nothing at all, which is what a heading is. The picker is `WxLinkPicker` from
+  `@webx-ui/module-admin`, the same one every link field in the panel uses.
+- **The cache** is marked under each menu — "built today at 08:10", "not built", "off" — with a
+  reset beside it and one for every menu in the head of the section. It is what somebody presses
+  to test the guess that they are looking at something stale.
+
+## Licence
+
+MIT

package/dist/MenuBranch.d.ts

@@ -0,0 +1,22 @@
+import { MenuItemRow } from './types';
+type __VLS_Props = {
+    items: MenuItemRow[];
+    /** Null for the top level. It travels back out with the new order. */
+    parentId?: number | null;
+    disabled?: boolean;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    edit: (item: MenuItemRow) => any;
+    duplicate: (item: MenuItemRow) => any;
+    reorder: (parentId: number | null, items: MenuItemRow[]) => any;
+    remove: (item: MenuItemRow) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onEdit?: ((item: MenuItemRow) => any) | undefined;
+    onDuplicate?: ((item: MenuItemRow) => any) | undefined;
+    onReorder?: ((parentId: number | null, items: MenuItemRow[]) => any) | undefined;
+    onRemove?: ((item: MenuItemRow) => any) | undefined;
+}>, {
+    disabled: boolean;
+    parentId: number | null;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/MenuCreateDialog.d.ts

@@ -0,0 +1,10 @@
+import { MenuRow } from './types';
+type __VLS_Props = {
+    menu?: MenuRow | null;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    menu: MenuRow | null;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
+    field: HTMLDivElement;
+}, any>;
+export default _default;

package/dist/MenuItemDialog.d.ts

@@ -0,0 +1,10 @@
+import { MenuItemRow, MenuRow } from './types';
+type __VLS_Props = {
+    menu: MenuRow;
+    /** The item being edited, or null for a new one. */
+    item?: MenuItemRow | null;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    item: MenuItemRow | null;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/MenuTreePane.d.ts

@@ -0,0 +1,19 @@
+import { MenuRow } from './types';
+type __VLS_Props = {
+    menu: MenuRow;
+    /** False in the drawer a narrow screen opens this in. */
+    inline?: boolean;
+    back?: () => void;
+};
+declare function load(): Promise<void>;
+declare const _default: import('vue').DefineComponent<__VLS_Props, {
+    reload: typeof load;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    changed: () => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onChanged?: (() => any) | undefined;
+}>, {
+    back: () => void;
+    inline: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/MenusPage.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, HTMLDivElement>;
+export default _default;

package/dist/api.d.ts

@@ -0,0 +1,25 @@
+import { AdminContext } from '@webx-ui/module-admin';
+import { MenuInput, MenuItemInput, MenuItemRow, MenuRow } from './types';
+export interface MenusApi {
+    /** Every menu: the ones a template asks for and the ones somebody made. */
+    list(): Promise<MenuRow[]>;
+    create(input: MenuInput): Promise<MenuRow>;
+    /** The name, and for a menu of somebody's own the key as well. */
+    update(key: string, input: Partial<MenuInput>): Promise<MenuRow>;
+    /** Only a menu of somebody's own, and its items go with it. */
+    remove(key: string): Promise<void>;
+    /** The whole tree, nested. Menus are small enough that a level at a time would only cost. */
+    items(key: string): Promise<MenuItemRow[]>;
+    addItem(key: string, input: MenuItemInput): Promise<MenuItemRow>;
+    saveItem(key: string, id: number, input: MenuItemInput): Promise<MenuItemRow>;
+    /** Under this parent, at this position among its children. */
+    moveItem(key: string, id: number, parentId: number | null, index: number): Promise<void>;
+    /** With the subtree under it. Answers how many went. */
+    removeItem(key: string, id: number): Promise<number>;
+    /** Forget one menu's cache, in every language. */
+    flush(key: string): Promise<void>;
+    /** The same for every menu at once. */
+    flushAll(): Promise<void>;
+}
+/** Everything under `/menus`, below the panel's API path. */
+export declare function createMenusApi(admin: AdminContext): MenusApi;

package/dist/i18n.d.ts

@@ -0,0 +1,2 @@
+/** Puts this package's English under the panel's dictionary, once per panel. */
+export declare function useMenuMessages(): void;

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+export { menu, type MenuOptions } from './module';
+export { createMenusApi, type MenusApi } from './api';
+export { menuMessages } from './messages';
+export { countBranch, findItem, movedId } from './tree';
+export { default as WxMenusPage } from './MenusPage';
+export { default as WxMenuTreePane } from './MenuTreePane';
+export { default as WxMenuBranch } from './MenuBranch';
+export { default as WxMenuItemDialog } from './MenuItemDialog';
+export { default as WxMenuCreateDialog } from './MenuCreateDialog';
+export type { LocalizedText, MenuCacheState, MenuInput, MenuItemInput, MenuItemRow, MenuRow, } from './types';