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

编辑推荐精选

TRAE编程

TRAE编程

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

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

AI工具TraeAI IDE协作生产力转型热门
商汤小浣熊

商汤小浣熊

最强AI数据分析助手

小浣熊家族Raccoon,您的AI智能助手,致力于通过先进的人工智能技术,为用户提供高效、便捷的智能服务。无论是日常咨询还是专业问题解答,小浣熊都能以快速、准确的响应满足您的需求,让您的生活更加智能便捷。

imini AI

imini AI

像人一样思考的AI智能体

imini 是一款超级AI智能体,能根据人类指令,自主思考、自主完成、并且交付结果的AI智能体。

Keevx

Keevx

AI数字人视频创作平台

Keevx 一款开箱即用的AI数字人视频创作平台,广泛适用于电商广告、企业培训与社媒宣传,让全球企业与个人创作者无需拍摄剪辑,就能快速生成多语言、高质量的专业视频。

即梦AI

即梦AI

一站式AI创作平台

提供 AI 驱动的图片、视频生成及数字人等功能,助力创意创作

扣子-AI办公

扣子-AI办公

AI办公助手,复杂任务高效处理

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

蛙蛙写作

蛙蛙写作

AI小说写作助手,一站式润色、改写、扩写

蛙蛙写作—国内先进的AI写作平台,涵盖小说、学术、社交媒体等多场景。提供续写、改写、润色等功能,助力创作者高效优化写作流程。界面简洁,功能全面,适合各类写作者提升内容品质和工作效率。

AI辅助写作AI工具蛙蛙写作AI写作工具学术助手办公助手营销助手AI助手
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
下拉加载更多