zag

zag

跨框架可访问性组件的状态机库

Zag.js是一个构建可访问性JavaScript组件的状态机库。它提供框架无关的组件交互模型,支持React、Vue等主流框架,注重可访问性,采用无头设计,基于先进状态图概念。该库使用状态机方法实现常见组件模式,提供一次编写多处使用的优势。它不仅关注可访问性,还处理键盘交互、焦点管理和ARIA属性等细节。Zag.js帮助开发者快速创建复杂、可重用的UI组件,同时保证良好的可访问性和用户体验,成为构建复杂UI组件的有力工具。

Zag.js状态机组件开发无头UI可访问性Github开源项目
<a href="https://zagjs.com/" > <img alt="Zag.js 主图" src="https://repository-images.githubusercontent.com/383777434/87c5d462-1c65-45d7-9561-3f3f64d814f4"></img> </a>

Zag

用于可访问JavaScript组件的有限状态机

  • 一次编写,随处使用 🦄:组件交互以框架无关的方式建模。我们为React、Solid或Vue等JS框架提供适配器。
  • 注重无障碍访问 ♿️:Zag在设计时考虑了无障碍性。我们处理了许多与键盘交互、焦点管理、aria角色和属性相关的细节。
  • 无头设计 ✨:机器API完全没有样式,让您可以自由使用任何您喜欢的样式解决方案。
  • 由状态机驱动 🌳:Zag基于状态图的最新理念构建。我们不遵循SCXML规范,但我们创建了一个API,我们认为它将帮助我们更快地构建更复杂的组件。

文档

要查看文档,请访问 zagjs.com/

发布

有关更新日志,请查看 CHANGELOG.md


问题

随着设计系统和组件驱动开发的兴起,在多个框架中不断重复实现常见的组件模式(标签页、菜单、模态框等)。

这些实现在本质上似乎非常相似,差异主要在于框架的响应性和效果系统(例如React.js中的useStateuseEffect)。特定框架的解决方案往往随时间增长而变得复杂,并且经常变得难以理解、调试、改进或测试。

解决方案

Zag是一个使用状态机方法实现常见组件模式的JavaScript API。

安装

npm i --save @zag-js/{component} # 或 yarn add @zag-js/{component}

{component}代表任何组件机器,如对话框(@zag-js/dialog)、工具提示(@zag-js/tooltip)等。

对于特定框架的解决方案,我们提供简单的包装器来帮助您使用组件状态机。

  • ⚛️ @zag-js/react - 用于在React应用中使用机器的React钩子
  • 💚 @zag-js/vue - 用于在Vue应用中使用机器的Vue组合
  • 🎷 @zag-js/solid - 用于在Solid.js应用中使用机器的Solid.js实用工具

使用

import { normalizeProps, useMachine } from "@zag-js/react" import * as toggle from "@zag-js/toggle-group" import { useId } from "react" export function ToggleGroup() { const [state, send] = useMachine(toggle.machine({ id: useId() })) const api = toggle.connect(state, send, normalizeProps) return ( <div {...api.getRootProps()}> <button {...api.getItemProps({ value: "bold" })}>B</button> <button {...api.getItemProps({ value: "italic" })}>I</button> <button {...api.getItemProps({ value: "underline" })}>U</button> </div> ) }

指导原则

  • 所有组件机器和测试都按照WAI-ARIA创作实践进行建模
  • 根据WAI-ARIA规范为每个组件编写端到端测试。无论使用什么框架,用户都期望组件模式以相同的方式工作!
  • 所有机器应该轻量、简单且易于理解。避免使用复杂的机器概念,如生成、嵌套状态等。

有趣的事实

Zag意味着_急剧改变方向_。这清楚地描述了我们使用状态机为UI组件提供动力的方法。

预告

  • 当你看到有人使用经典的react、vue或solid来构建Zag中已存在的交互式UI组件时,告诉他们**"使用zag吧!"** ⚡️

  • 任何使用Zag的人都将被称为**"zagger"** 💥

  • 使用Zag时你会感受到的感觉将被称为**"zagadat!"** 🚀

  • Zag社区将被称为**"zag nation"** 🔥


命令

构建命令

我们的构建使用esbuild和turborepo管理,以在包之间提供快速、并发的构建。

  • build : 构建CJS、ESM和DTS文件。这是我们在CI中运行的实际生产构建。

示例

由于zag是框架无关的,我们需要一种方法在框架内测试它。examples/目录包含我们支持的框架的启动项目。

  • start-react : 启动Next.js TypeScript项目
  • start-vue : 启动Vue 3 TypeScript项目
  • start-solid : 启动Solid TypeScript项目

端到端测试

我们为我们构建的每个机器设置了端到端测试。我们使用Playwright进行测试,并确保组件在不同框架中以相同的方式工作。

  • e2e-react : 启动React项目的E2E测试
  • e2e-vue : 启动Vue项目的E2E测试
  • e2e-solid : 启动Solid项目的E2E测试

贡献新机器/功能

  • generate-machine : 在packages/目录中生成一个新的机器包。它为新机器设置所需的文件和结构。
  • generate-util : 在packages/utilities目录中生成一个新的实用工具包。

其他命令

  • test : 运行所有包的测试
  • lint : 对所有包进行lint检查

网站

  • start-website: 启动网站

灵感来源


贡献

想要贡献?寻找带有Good First Issue标签的问题。

🐛 错误

请为错误、缺失的文档或意外行为提交问题。

💡 功能请求

请提交问题以建议新功能。通过添加👍来对功能请求进行投票。这有助于维护者确定优先处理的内容。


许可证

MIT © Segun Adebayo

编辑推荐精选

GPT Plus|Pro充值

GPT Plus|Pro充值

GPT充值

支持 ChatGPT Plus / Pro 充值服务,支付便捷,自动发货,售后可查。

GPT Image 2中文站

GPT Image 2中文站

AI 图片生成平台

GPT Image 2 是面向用户的 AI 图片生成平台,支持文生图、图生图及多模型创意工作流。

Vecbase

Vecbase

你的AI Agent团队

Vecbase 是专为 AI 团队打造的智能工作空间,将数据管理、模型协作与知识沉淀整合于一处。算法、产品与业务在同一平台无缝协同,让从数据到 AI 应用的落地更快一步。

音述AI

音述AI

全球首个AI音乐社区

音述AI是全球首个AI音乐社区,致力让每个人都能用音乐表达自我。音述AI提供零门槛AI创作工具,独创GETI法则帮助用户精准定义音乐风格,AI润色功能支持自动优化作品质感。音述AI支持交流讨论、二次创作与价值变现。针对中文用户的语言习惯与文化背景进行专门优化,支持国风融合、C-pop等本土音乐标签,让技术更好地承载人文表达。

QoderWork

QoderWork

阿里Qoder团队推出的桌面端AI智能体

QoderWork 是阿里推出的本地优先桌面 AI 智能体,适配 macOS14+/Windows10+,以自然语言交互实现文件管理、数据分析、AI 视觉生成、浏览器自动化等办公任务,自主拆解执行复杂工作流,数据本地运行零上传,技能市场可无限扩展,是高效的 Agentic 生产力办公助手。

lynote.ai

lynote.ai

一站式搞定所有学习需求

不再被海量信息淹没,开始真正理解知识。Lynote 可摘要 YouTube 视频、PDF、文章等内容。即时创建笔记,检测 AI 内容并下载资料,将您的学习效率提升 10 倍。

AniShort

AniShort

为AI短剧协作而生

专为AI短剧协作而生的AniShort正式发布,深度重构AI短剧全流程生产模式,整合创意策划、制作执行、实时协作、在线审片、资产复用等全链路功能,独创无限画布、双轨并行工业化工作流与Ani智能体助手,集成多款主流AI大模型,破解素材零散、版本混乱、沟通低效等行业痛点,助力3人团队效率提升800%,打造标准化、可追溯的AI短剧量产体系,是AI短剧团队协同创作、提升制作效率的核心工具。

seedancetwo2.0

seedancetwo2.0

能听懂你表达的视频模型

Seedance two是基于seedance2.0的中国大模型,支持图像、视频、音频、文本四种模态输入,表达方式更丰富,生成也更可控。

nano-banana纳米香蕉中文站

nano-banana纳米香蕉中文站

国内直接访问,限时3折

输入简单文字,生成想要的图片,纳米香蕉中文站基于 Google 模型的 AI 图片生成网站,支持文字生图、图生图。官网价格限时3折活动

扣子-AI办公

扣子-AI办公

职场AI,就用扣子

AI办公助手,复杂任务高效处理。办公效率低?扣子空间AI助手支持播客生成、PPT制作、网页开发及报告写作,覆盖科研、商业、舆情等领域的专家Agent 7x24小时响应,生活工作无缝切换,提升50%效率!

下拉加载更多