{"id":27896347,"url":"https://github.com/ui-model/ui-model","last_synced_at":"2025-05-05T16:37:32.700Z","repository":{"id":15204149,"uuid":"77735358","full_name":"ui-model/ui-model","owner":"ui-model","description":"UI Model major repository","archived":false,"fork":false,"pushed_at":"2023-01-04T21:38:24.000Z","size":5213,"stargazers_count":146,"open_issues_count":24,"forks_count":23,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-04-14T07:59:58.079Z","etag":null,"topics":["angular","library","no-comonent","react","reuse","soc","ui-model"],"latest_commit_sha":null,"homepage":"http://ui-model.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ui-model.png","metadata":{"files":{"readme":"README-cn.md","changelog":null,"contributing":"CONTRIBUTING-cn.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-12-31T10:13:27.000Z","updated_at":"2024-04-01T04:45:12.000Z","dependencies_parsed_at":"2023-01-13T20:30:10.009Z","dependency_job_id":null,"html_url":"https://github.com/ui-model/ui-model","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ui-model%2Fui-model","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ui-model%2Fui-model/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ui-model%2Fui-model/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ui-model%2Fui-model/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ui-model","download_url":"https://codeload.github.com/ui-model/ui-model/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252534611,"owners_count":21763806,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","library","no-comonent","react","reuse","soc","ui-model"],"created_at":"2025-05-05T16:37:28.091Z","updated_at":"2025-05-05T16:37:32.694Z","avatar_url":"https://github.com/ui-model.png","language":"TypeScript","readme":"[![Build Status](https://travis-ci.org/ui-model/ui-model.svg?branch=master)](https://travis-ci.org/ui-model/ui-model)\n# ui-model\n\n## 什么是ui-model？\n\n一句话：ui-model就是最精简的前端交互逻辑。无论你使用什么框架，也无论这些交互控件的外观如何，它们背后的交互逻辑其实都可以抽象到很少的几个，而这些抽象的结果，就是ui-model。\n\n举个例子：\n\n下列控件的交互逻辑有什么共同点？\n\n![Select](README_images/select.png)\n\n![Radio Group](README_images/radio.png)\n\n事实上，它们的交互逻辑完全相同，那就是“N选1”。\n\n也许你早就意识到了这一点，但是我们还可以继续发挥想象力。再想想还有哪些交互控件的交互逻辑与这两个控件相同？种类之多可能会超出你的想象。请先自己尝试列举一下再往后看。\n\n好，揭晓答案：\n\nTabset（多个中只有一个能激活）\n\nMenu（多个中只有一个是高亮状态）\n\nAccordion（多个中只有一个能展开）\n\nButton Group（多个中只有一个能按下）\n\nPagination（多个中只有一个能激活）\n\n某些只能同时展开一项的树\n\n某些只能同时展开一项内嵌详情的Grid\n\n某些只允许同时按一列排序的表格\n\n事实上，在所有这些纷繁复杂的交互控件背后，都是一个最简单的“N选1”逻辑，而这个逻辑只要十来行代码就足够了，这就是高阶抽象的威力。\n\n**ui-model的深层含义**是指这种提取出纯交互逻辑的**思路**，本文的首要目标就是推广这种**思路**。而ui-model的外在表现则是这样一组最精简的“交互逻辑”。\n\n理解了“N选1”逻辑之后，再想想“N选M”的逻辑都有哪些应用？双态切换逻辑都有哪些应用？\n\n## ui-model的概念模型\n\n![Architecture](README_images/architecture.png)\n\n可以看到，在这个概念模型中，ui-model是一个与JS框架和CSS框架平行的构造，因此三者可以自由组合。JS框架负责对模型和视图进行同步，CSS框架负责外观，而ui-model专注于处理交互逻辑。\n\n同样的一套ui-model代码，可以同时用于Angular/React等框架中，而其CSS框架既可以选用Bootstrap也可以选用Semantic UI等等。三者之间在实现上没有依赖。\n\n当然，对于一些常见场景，我们可以为JS框架提供一些Binding库，比如ui-model-angular，它会对ui-model的逻辑进行适合Angular特性的封装。\n\n## 传统的组件库为何难以复用？\n\n如果你使用过第三方组件库，那么大概也体会过组件库的一些共有缺点。\n\n首先，大部分组件库都与某个前端框架紧紧绑定在一起，Angular的组件库显然无法用于React，反之也一样。甚至有些库还紧紧地绑定了CSS框架，如果绑定的是Bootstrap等设计良好的框架也就罢了，至少你可以通过CSS进行深度定制；如果是设计不良的框架，那就惨了，有些修改你可能只有去改它的源码，而这将破坏封装。\n\n其次，组件库的配置过于复杂，一些大型套件甚至都需要专门学习一段时间才能上手，而一旦换了套件，关于本组件库的知识基本上就作废了。固然，它们所解决的需求本身就很复杂，但问题在于这些复杂的需求都是由少数几个通用的交互逻辑变形组合而成的（就像前文所说的多种交互控件抽取出的select逻辑），这种复杂度是否真的是我们必须付出的代价？\n\n最后，组件库很难在可定制性和复杂度之间进行平衡。可定制性强的组件库且不说自身的开发难度高，即使在使用方面也同样不易。传统方式下的组件库，通常都要通过配置去实现各种可定制性，最多是支持用回调函数进行定制，但是这种方式必然导致巨大的文档以及沉重的记忆负担。\n\n那么，组件库难以复用的根本原因是什么呢？一句话：违反了SoC（关注点分离）这一根本性的设计原则。传统的组件库同时涵盖了三个关注点：信息架构（HTML）、交互逻辑（JS）、外观样式（CSS），当这三个关注点紧紧捆绑在一起的时候，上述三大问题就很难避免了。\n\n相对来说，CSS库较早的独立出来，比如Bootstrap的CSS框架部分就仅仅实现了外观，对HTML和JS几乎没有依赖，加之其本身的设计就相当合理，因此快速流行起来。\n\n而ui-model就是JS世界中的Bootstrap。\n\n另一个关注点，信息架构（HTML）由于最贴近业务需求，因此可以留给应用去自己实现。而现有的前端框架则作为交互逻辑和信息架构之间的桥梁。ui-model对这个“桥梁”的唯一假设就是它能够实现模型和界面之间的同步 —— 并不关心它使用数据绑定实现还是使用Virtual DOM实现。\n\n## ui-model的前景与未来\n\n虽然简单，但ui-model仍然是一片蓝海。除了最简单的select、multi-select和toggle外，还有诸如slice、map等稍复杂的交互逻辑，还包括Calendar等更复杂的逻辑。\n\n除了这些通用的交互逻辑外，还可以实现很多更贴近业务的交互逻辑，比如购物车，如果我们为它抽取出一个ui-model，那么只要把它绑定到HTML上就可以正常工作了。而对这个HTML及相应的CSS，各种应用可以任意定制。\n\n## 历史与现状\n\nui-model的思想来自两年多之前雪狼对企业内部可复用性的研究，他发现了传统思路下的复用工作受挫的症结在于它们违反了SoC原则，因此也会被迫违反OCP原则。\n\n后来，雪狼在一些实际项目中应用这种思想简化了很多问题，并深切体会到了它的优点，还发现了更多可以抽象为select等ui-model的交互控件以及更多的ui-model。\n\n经过一段时间的沉淀，雪狼把这个想法拿出来和Rex进行探讨，我们都认为这是一个很有价值的思想，值得分享给社区，于是我们建立了一个叫做lean-ui的GitHub组，写下了一些初步思想以及探讨性实现，但是由于事情较多，同时精力转向了推广Angular 2，因此很长时间内没有再动它。直到今天，2017年新年，我们把它更名为更贴切的ui-model，并正式把它公布给前端社区，也同时作为我们的交付承诺以及对各位志愿者的邀请。\n\n## 规划与未来\n\n接下来，我们会先将过去实现过的ui-model整理一下、开源出来，作为给大家参与开发的范例。之后，我们还会进一步开发更多的ui-model，更多的前端框架中间层以及更多应用范例。\n\n希望大家记住：ui-model首先是一种思想，而不局限于这个具体的库。我们也希望出现更多的基于ui-model思想实现的竞争库，我们乐于见到良性的竞争，因为 —— 这才叫繁荣。\n\n我们希望，你在实际开发中对ui-model思想的应用不要局限于交互逻辑，而是外延到业务逻辑部分，希望ui-model的思想能给你一些启迪，帮助你开发出更加符合SoC原则的应用。\n\n## 组织与参与\n\n我们的活动基地是\u003chttps://github.com/ui-model\u003e组，欢迎大家star \u0026 fork它。\n\n我们的开发计划是先做一个基于TypeScript的版本，由于其对类型提供了良好支持，因此很适合做API探索。\n\n我们也会用到RxJS来对外公开各种事件接口，但会尽量避免引入其高级特性。\n\n我们会基于Angular 2来实现第一个中间层及其范例，若有ReactJS等其它前端框架方面的专家，我们也同样欢迎加入。同时考虑到遗留系统是如此之多，我们还预留了一个给jQuery程序员的仓库。\n\n初期，请给我们提issue来让我们了解你的需求和应用场景，反馈我们代码中的bug，并且我们非常欢迎各位给我们提交PR，无论我们是否会接受，我们都感激不尽。\n\n之后，等开发步入了正轨，我们就会根据issue和PR的记录来逐渐邀请一些活跃开发者加入我们的开发组。\n\n最后，别忘了，我们还鼓励各位基于ui-model的思想来开发竞争库，将来对于优秀的竞争库，我们愿意从这里链接到你们。建议在发布npm包时添加ui-model标签或干脆以ui-model-前缀来命名你们自己的库，以便使用者更容易找到你们。\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fui-model%2Fui-model","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fui-model%2Fui-model","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fui-model%2Fui-model/lists"}