{"id":19444157,"url":"https://github.com/maibornwolff/mwui","last_synced_at":"2025-04-25T00:32:56.476Z","repository":{"id":57879394,"uuid":"525363720","full_name":"MaibornWolff/mwui","owner":"MaibornWolff","description":"Storybook (dev): https://maibornwolff.github.io/mwui-dev","archived":false,"fork":false,"pushed_at":"2024-12-21T09:52:20.000Z","size":31719,"stargazers_count":9,"open_issues_count":16,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-19T21:51:37.553Z","etag":null,"topics":["angular","component-library","components","design-system","react","stencil","storybook","vue","web-components"],"latest_commit_sha":null,"homepage":"https://maibornwolff.github.io/mwui","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MaibornWolff.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-08-16T12:10:23.000Z","updated_at":"2024-10-21T16:33:39.000Z","dependencies_parsed_at":"2025-04-22T00:15:21.034Z","dependency_job_id":null,"html_url":"https://github.com/MaibornWolff/mwui","commit_stats":null,"previous_names":["maibornwolff/tlm-components"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaibornWolff%2Fmwui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaibornWolff%2Fmwui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaibornWolff%2Fmwui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaibornWolff%2Fmwui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MaibornWolff","download_url":"https://codeload.github.com/MaibornWolff/mwui/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250733585,"owners_count":21478396,"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","component-library","components","design-system","react","stencil","storybook","vue","web-components"],"created_at":"2024-11-10T16:05:19.233Z","updated_at":"2025-04-25T00:32:55.521Z","avatar_url":"https://github.com/MaibornWolff.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"./mw_logo.png\" alt=\"maibornwolff logo\" align=\"right\" height=\"60\"\u003e\n\n# The Liberation Machine - Component Library\n\n![Built With Stencil](https://img.shields.io/badge/-Built%20With%20Stencil-16161d.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDE5LjIuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGRkZGRjt9Cjwvc3R5bGU%2BCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MjQuNywzNzMuOWMwLDM3LjYtNTUuMSw2OC42LTkyLjcsNjguNkgxODAuNGMtMzcuOSwwLTkyLjctMzAuNy05Mi43LTY4LjZ2LTMuNmgzMzYuOVYzNzMuOXoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQyNC43LDI5Mi4xSDE4MC40Yy0zNy42LDAtOTIuNy0zMS05Mi43LTY4LjZ2LTMuNkgzMzJjMzcuNiwwLDkyLjcsMzEsOTIuNyw2OC42VjI5Mi4xeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDI0LjcsMTQxLjdIODcuN3YtMy42YzAtMzcuNiw1NC44LTY4LjYsOTIuNy02OC42SDMzMmMzNy45LDAsOTIuNywzMC43LDkyLjcsNjguNlYxNDEuN3oiLz4KPC9zdmc%2BCg%3D%3D\u0026colorA=16161d\u0026style=flat-square)\n[![@maibornwolff/mwui-stencil](https://img.shields.io/npm/v/@maibornwolff/mwui-stencil?color=blue)](https://www.npmjs.com/package/@maibornwolff/mwui-stencil)\n[![Storybook](https://raw.githubusercontent.com/storybookjs/brand/master/badge/badge-storybook.svg?sanitize=true)](https://maibornwolff.github.io/mwui-dev)\n![Pipeline](https://github.com/MaibornWolff/mwui/actions/workflows/main-build.yml/badge.svg)\n![Pipeline](https://github.com/MaibornWolff/mwui/actions/workflows/release-build.yml/badge.svg)\n\nA web component library as part of the MW Design System project \u003cstrong\u003eThe Liberation Machine\u003c/strong\u003e. Using Figma Token Studio plugin, we create modifiable Design Systems connected to a ready-to-use Web Component Library.\n\n## Storybook\n\n| Environment | URL                                     | Description                                                                                    |\n| ----------- | --------------------------------------- | ---------------------------------------------------------------------------------------------- |\n| Dev         | https://maibornwolff.github.io/mwui-dev | Reflects the current state of the main branch and updates automatically with changes in Figma. |\n| Prod        | https://maibornwolff.github.io/mwui     | Reflects the state released on [npm](https://www.npmjs.com/search?q=%40maibornwolff%2Fmwui).   |\n\n## The Design System Pipeline\n\nAll the Components are developed based on the mwui Design System in Figma. We use `Design Tokens` to version and synchronize design decisions between the Design and the WebComponents.\n\nThe [Token-Farm](mwui-token-farm/README.md) module transforms any changes in the Design Tokens into Style Dictionary outputs which are linked to the respective Web Component.\n\n![TLM Workflow - Design System Pipeline](tlm_overview.png \"TLM Workflow\")\n\n## Related Docs\n\n-   [Token-Farm](mwui-token-farm/README.md)\n-   [Stencil Library](mwui-stencil/README.md)\n-   [React Library](mwui-react/README.md)\n-   [Vue Library](mwui-vue/README.md)\n-   [Angular Library](mwui-angular/README.md)\n-   [Setup Figma Token Plugin](token-plugin.md)\n\n## Contributing\n\n\u003e **Note**\n\u003e\n\u003e Adding a new Web Component should always be discussed with the Design Team to have the right Tokens and Designs in place. We prefer component-specific tokens over semantic or core tokens. Missing tokens are discussed with Design Team.\n\nWe use [Github Projects](https://github.com/orgs/MaibornWolff/projects/4/views/1) to organize tasks and issues linked to this Repository.\n\nFollow this checklist to comply with our definition of done.\n\n-   [x] components are tested\n-   [x] components are represented in Storybook\n-   [x] components are documented (e.g. storybook mdx doc)\n-   [x] components are reviewed together with design team\n\n### Documentation\n\nA stencil component ideally is created using the CLI command `npm run generate` inside the mwui-stencil directory. Each component should be represented in various states and variants in a Storybook `*.stories.ts` file. If there is more complex documentation needed, both a stories file and a customized `*.docs.mdx` file (e.g. [mw-button.docs.mdx](https://github.com/MaibornWolff/mwui/blob/main/mwui-stencil/src/components/mw-button/mw-button.docs.mdx)) can and should be provided.\n\nTo further improve automated component docs, make sure to correctly type `Properties` and provide comments to each prop (those will show up in the Storybook ArgTypes in addition to the default output generated).\n\n### Build \u0026 Release Libraries\n\nWe maintain several packages, including the core (mwui-stencil), token transformation and framework specific component libraries. Learn more about the [build and release process](./release.md).\n\n| Package                       | Status                                                                                                                                                                  |\n| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| @maibornwolff/mwui-stencil    | [![@maibornwolff/mwui-stencil](https://img.shields.io/npm/v/@maibornwolff/mwui-stencil?color=green)](https://www.npmjs.com/package/@maibornwolff/mwui-stencil)          |\n| @maibornwolff/mwui-token-farm | [![@maibornwolff/mwui-token-farm](https://img.shields.io/npm/v/@maibornwolff/mwui-token-farm?color=green)](https://www.npmjs.com/package/@maibornwolff/mwui-token-farm) |\n| @maibornwolff/mwui-react      | [![@maibornwolff/mwui-react](https://img.shields.io/npm/v/@maibornwolff/mwui-react?color=blue)](https://www.npmjs.com/package/@maibornwolff/mwui-react)                 |\n| @maibornwolff/mwui-vue        | [![@maibornwolff/mwui-vue](https://img.shields.io/npm/v/@maibornwolff/mwui-vue?color=blue)](https://www.npmjs.com/package/@maibornwolff/mwui-vue)                       |\n| @maibornwolff/mwui-angular    | [![@maibornwolff/mwui-angular](https://img.shields.io/npm/v/@maibornwolff/mwui-angular?color=blue)](https://www.npmjs.com/package/@maibornwolff/mwui-angular)           |\n\n### Usage in React, Vue and Angular\n\nTo leverage the usage of our WebComponents we provide framework-specific wrappers for React, Vue and Angular. You can install and use the mwui Components accordingly:\n\n```bash\nnpm install @maibornwolff/mwui-react # in React\nnpm install @maibornwolff/mwui-vue # in Vue\nnpm install @maibornwolff/mwui-angular # in Angular\n\n# you might also need the core package to have access to global stylings, see [React](mwui-react/README.md) for more information.\nnpm install @maibornwolff/mwui-stencil\n```\n\nFor more info on the individual wrappers, check out the [React](mwui-react/README.md), [Vue](mwui-vue/README.md) or [Angular](mwui-angular/README.md) documentation.\n\n### Use as Web Components\n\nTo install the library within the chosen framework, run:\n\n```bash\nnpm install @maibornwolff/mwui-stencil\n```\n\nInclude the following in the `main.js` (e.g. Angular, Vue) or `index.js` (e.g. React):\n\n```JavaScript\nimport { defineCustomElements } from \"@maibornwolff/mwui-stencil/loader\";\ndefineCustomElements(window);\n```\n\n### Styling\n\nTo ensure CSS variables are available, import the global stylesheet in your Application root.\n\n```javascript\nimport \"@maibornwolff/mwui-stencil/dist/mwui-stencil/mwui-stencil.css\";\n```\n\nThe CSS variables are used within the Web Components and you can also refer to them styling your own layout and elements.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaibornwolff%2Fmwui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaibornwolff%2Fmwui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaibornwolff%2Fmwui/lists"}