@fayz-ai/plugin-menu

中文文档
0.14.8发布于 2026/11/11MITTypeScriptES Module近 30 天下载 7809

Fayz SDK — plugin-menu plugin

原始使用文档
文档目录5 节
  1. What's inside
  2. Install
  3. Usage
  4. Part of the Fayz SDK
  5. Roadmap & contributing

@fayz-ai/plugin-menu

The menu engine behind every food vertical — items, categories, modifiers, 86'd in one tap.

npm license

Status: beta — pre-1.0. Core surface is stable; some backend facets (see PLUGIN_PATTERNS.md) are still landing. APIs may change before 1.0.

A menu is the product catalog of a food business — and it changes by the hour. plugin-menu is the management surface for that: items, categories, allergens, and modifiers, with sold-out toggles that take effect instantly. It's the foundation the orders flow reads from, so the two compose into a working restaurant.

It's provider-first by design. Ship a demo on the bundled mock provider, then drop in createFayzMenuProvider (or your own MenuDataProvider) for real data. Modifiers and delivery pricing are opt-in modules, labels and currency are configurable, and the host AI can list items and flip availability by name. The intent: menu management shouldn't be a bespoke build — it's a plugin you snap into a defineSaas app to compose a real food SaaS.

What's inside

  • Navigation + page — a /menu surface with a menu manager (MenuManagerView) for items and categories
  • Pluggable data — inject a MenuDataProvider, use createFayzMenuProvider, or fall back to the bundled mock provider
  • Opt-in modules — modifiers (on by default) and deliveryPricing (off by default)
  • AI tools — listMenuItems (filter by category/status) and toggleMenuItemAvailability (mark available or sold out by name)
  • Settings + i18n — a settings panel for categories, allergens, and modifiers, plus bundled locales
  • Public domain types — exported so any host can implement its own MenuDataProvider

Install

npm install @fayz-ai/plugin-menu

Peer deps: @fayz-ai/core, @fayz-ai/ui, @fayz-ai/admin, @fayz-ai/sdk (+ react, react-dom).

Usage

import { defineSaas } from '@fayz-ai/admin'
import { createMenuPlugin, createFayzMenuProvider } from '@fayz-ai/plugin-menu'

export const app = defineSaas({
  // ...
  plugins: [
    createMenuPlugin({
      modules: { modifiers: true, deliveryPricing: false },
      currency: { code: 'BRL', locale: 'pt-BR', symbol: 'R$' },
      dataProvider: createFayzMenuProvider({ /* ... */ }),
    }),
  ],
})

Options: modules, labels, currency, navPosition, navSection, scope, verticalId, dataProvider, menuItemLookup.

Part of the Fayz SDK

A composable plugin for the Fayz SDK. The catalog @fayz-ai/plugin-orders reads from — pair both with @fayz-ai/plugin-inventory to tie menu items back to stock.

Roadmap & contributing

Built and evolving in the open. See the Fayz SDK roadmap for current gaps, missing features, and good first issues.

版本与发布记录

@fayz-ai/plugin-menu 共发布 87 个版本,首次发布于 2026/06/20;过去 12 个月发布了 87 个版本。

版本发布日期距今
0.14.8latest2026/11/112 天前
0.14.72026/11/113 天前
0.14.62026/11/113 天前
0.14.52026/11/067 天前
0.14.42026/11/068 天前
0.14.32026/11/068 天前

其他发布通道:next → 0.9.0-next.1,canary → 0.14.0-canary.20261028153856。

关于 @fayz-ai/plugin-menu 的常见问题

@fayz-ai/plugin-menu 是什么?

Fayz SDK — plugin-menu plugin

如何安装 @fayz-ai/plugin-menu?

在项目目录运行 npm install @fayz-ai/plugin-menu,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18.0.0 || ^19.0.0)、sonner(^2.0.7)、zustand(^4.5.0 || ^5.0.0)、react-dom(^18.0.0 || ^19.0.0)、lucide-react(>=0.400.0 <1.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@fayz-ai/plugin-menu 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@fayz-ai/plugin-menu 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@fayz-ai/plugin-menu 可以商用吗?

@fayz-ai/plugin-menu 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@fayz-ai/plugin-menu 的下载量有多少?

根据 npm 官方下载统计,@fayz-ai/plugin-menu 在 2026/10/15 – 2026/11/13 这 30 天内被下载 7,809 次,日均约 260 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@fayz-ai/plugin-menu 还在维护吗?

最新版本 0.14.8 发布于 2026/11/11(2 天前);至今共发布 87 个版本,其中过去 12 个月发布了 87 个;首次发布于 2026/06/20。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。