@fayz-ai/plugin-tasks

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

Fayz SDK — plugin-tasks plugin

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

@fayz-ai/plugin-tasks

A task list that lives in your topbar, in every app you compose.

npm license

Status: beta — capability-complete (Supabase/mock data provider, bundled migration, end-to-end tests). Pre-1.0: APIs may change before 1.0.

Work happens between the records. A salon owner needs to "call the supplier," a clinic admin needs to "follow up on lab results" — small things that never fit neatly into a booking or an invoice. plugin-tasks gives every Fayz app a lightweight, always-available task list: a topbar button that opens a drawer for quick-add, statuses, priorities, due dates, labels, and assignees.

It's deliberately small and zero-config. Drop it in and it owns its own tables (via a bundled migration), picks Supabase or an in-memory mock automatically, and exposes its summary to the AI assistant — so "what's overdue?" just works. No page to wire, no nav slot to claim; tasks ride along with whatever vertical you compose.

What's inside

  • Topbar task drawer — a widget mounted at shell.topbar.end for quick-add and review, available on every page.
  • Task model — title, description, status (todo / in progress / done / cancelled), priority (low / medium / high / urgent), due date, labels, assignee, and subtasks (parent/child).
  • AI tool — getTasksSummary reports totals, overdue, due-today, and breakdowns by status and priority.
  • Bundled migration — creates tsk_tasks and tsk_labels with tenant-scoped RLS, so it's self-installing.
  • Settings tab + i18n, with a Supabase-or-mock data provider chosen automatically.
  • Configurable labels and a default priority for new tasks.

Install

npm install @fayz-ai/plugin-tasks

Peer deps: react, react-dom. Runtime deps include @fayz-ai/core, @fayz-ai/ui, and @fayz-ai/admin.

Usage

import { defineSaas } from '@fayz-ai/admin'
import { createTasksPlugin } from '@fayz-ai/plugin-tasks'

export const app = defineSaas({
  // ...
  plugins: [
    createTasksPlugin({
      defaultPriority: 'medium',
      labels: { drawerTitle: 'To-dos', quickAddPlaceholder: 'Add a to-do...' },
    }),
  ],
})

Part of the Fayz SDK

plugin-tasks is the lightweight companion plugin: no navigation of its own, it simply adds a task surface to any app built with @fayz-ai/admin. It complements heavier plugins like @fayz-ai/plugin-agenda and @fayz-ai/plugin-financial by capturing the loose work around them.

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-tasks 共发布 89 个版本,首次发布于 2026/06/18;过去 12 个月发布了 89 个版本。

版本发布日期距今
0.11.34latest2026/11/112 天前
0.11.332026/11/113 天前
0.11.322026/11/113 天前
0.11.312026/11/067 天前
0.11.302026/11/068 天前
0.11.292026/11/068 天前

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

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

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

Fayz SDK — plugin-tasks plugin

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

在项目目录运行 npm install @fayz-ai/plugin-tasks,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18.0.0 || ^19.0.0)、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-tasks 支持 TypeScript 吗?

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

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

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

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

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

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

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

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

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