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

编辑推荐精选

扣子-AI办公

扣子-AI办公

职场AI,就用扣子

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

堆友

堆友

多风格AI绘画神器

堆友平台由阿里巴巴设计团队创建,作为一款AI驱动的设计工具,专为设计师提供一站式增长服务。功能覆盖海量3D素材、AI绘画、实时渲染以及专业抠图,显著提升设计品质和效率。平台不仅提供工具,还是一个促进创意交流和个人发展的空间,界面友好,适合所有级别的设计师和创意工作者。

图像生成AI工具AI反应堆AI工具箱AI绘画GOAI艺术字堆友相机AI图像热门
码上飞

码上飞

零代码AI应用开发平台

零代码AI应用开发平台,用户只需一句话简单描述需求,AI能自动生成小程序、APP或H5网页应用,无需编写代码。

Vora

Vora

免费创建高清无水印Sora视频

Vora是一个免费创建高清无水印Sora视频的AI工具

Refly.AI

Refly.AI

最适合小白的AI自动化工作流平台

无需编码,轻松生成可复用、可变现的AI自动化工作流

酷表ChatExcel

酷表ChatExcel

大模型驱动的Excel数据处理工具

基于大模型交互的表格处理系统,允许用户通过对话方式完成数据整理和可视化分析。系统采用机器学习算法解析用户指令,自动执行排序、公式计算和数据透视等操作,支持多种文件格式导入导出。数据处理响应速度保持在0.8秒以内,支持超过100万行数据的即时分析。

AI工具酷表ChatExcelAI智能客服AI营销产品使用教程
TRAE编程

TRAE编程

AI辅助编程,代码自动修复

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
AIWritePaper论文写作

AIWritePaper论文写作

AI论文写作指导平台

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

AI辅助写作AI工具AI论文工具论文写作智能生成大纲数据安全AI助手热门
博思AIPPT

博思AIPPT

AI一键生成PPT,就用博思AIPPT!

博思AIPPT,新一代的AI生成PPT平台,支持智能生成PPT、AI美化PPT、文本&链接生成PPT、导入Word/PDF/Markdown文档生成PPT等,内置海量精美PPT模板,涵盖商务、教育、科技等不同风格,同时针对每个页面提供多种版式,一键自适应切换,完美适配各种办公场景。

AI办公办公工具AI工具博思AIPPTAI生成PPT智能排版海量精品模板AI创作热门
潮际好麦

潮际好麦

AI赋能电商视觉革命,一站式智能商拍平台

潮际好麦深耕服装行业,是国内AI试衣效果最好的软件。使用先进AIGC能力为电商卖家批量提供优质的、低成本的商拍图。合作品牌有Shein、Lazada、安踏、百丽等65个国内外头部品牌,以及国内10万+淘宝、天猫、京东等主流平台的品牌商家,为卖家节省将近85%的出图成本,提升约3倍出图效率,让品牌能够快速上架。

下拉加载更多