mitosis README

The project's README from github.com/BuilderIO/mitosis. As one markdown file: README.md.



Mitosis logo

Write components once, compile to every framework


code style: prettier PRs Welcome License Types

Overview

Mitosis provides a unified development experience across all frameworks, enabling you to build components in a single codebase and compile them to React, Vue, Angular, Svelte, Solid, Alpine, Qwik, and more.

Using Mitosis, you can:

PS: We are actively looking for folks interested in becoming contributors to Mitosis. If interested, look at our list of good first issues or reach out on our Discord

Gif example of devloping with Mitosis

Quickstart

To create a new Mitosis project from scratch, run the following create command:

npm create @builder.io/mitosis@latest

Once completed, make sure to read the README.md generated in your new project. It will explain the structure of your project, and provide a walkthrough on how to build/test your components.

Read the full getting started docs for more.

Integration with Figma

To make generating Mitosis components easier, as well as to keep your design system in code in sync with your design system in Figma, Mitosis integrates with Figma.

Learn more about our Figma integration.

Demo of using Mitosis with Figma

Resources

Contribute

Interested in contribute? Head over to the CONTRIBUTING docs and see how you can get setup & started!

Once you're ready, checkout our issues page and grab your first issue!



Made with love by Builder.io

mitosis (BuilderIO/mitosis)

Searching Database…

14.4K ·GitHub
Что это такое?Mitosis — это компилятор, который позволяет написать компонент интерфейса один раз и скомпилировать его в нативный код для React, Vue, Angular, Svelte, Solid, Qwik, Alpine и других фреймворков.
Это библиотека времени выполнения или компилятор, который я запускаю на этапе сборки?Это компилятор для этапа сборки, а не библиотека времени выполнения: компоненты пишутся на общем синтаксисе Mitosis, а на выходе для каждой целевой платформы генерируется нативный код конкретного фреймворка.
Как начать новый проект на Mitosis?Создайте проект официальной командой create, затем следуйте сгенерированному файлу README.md, в котором описаны структура проекта и то, как собирать и тестировать компоненты.
Нужна ли мне определённая версия Node.js для работы с CLI?Да, в поле engines проекта требуется Node.js 16 или новее, чтобы запускать CLI Mitosis и инструменты сборки.
Придётся ли мне отказаться от возможностей конкретного фреймворка, если я пишу один общий компонент?Поскольку один компонент Mitosis должен корректно компилироваться во многие разные фреймворки, его нужно писать на ограниченном общем синтаксисе, похожем на JSX, а не свободно использовать все возможности отдельно взятого фреймворка.
Это в первую очередь для команд, которые держат дизайн-систему синхронной в нескольких фреймворках?Да, Mitosis рассчитан на команды, которым нужен единый источник компонентов, чтобы дизайн-система оставалась согласованной, будь то приложения на React, Vue, Angular, Svelte или Solid.
Может ли Mitosis синхронизировать компоненты с дизайнами в Figma?Да, у Mitosis есть интеграция с Figma, которая помогает генерировать компоненты из дизайнов и поддерживать дизайн-систему в Figma синхронной с кодом.
Почему бы просто не использовать Web Components?В README отмечено, что Mitosis избегает проблем Web Components, компилируя код в нативный код каждого фреймворка, а не полагаясь на общую среду выполнения пользовательских элементов.
Можно ли публиковать скомпилированные компоненты в npm?Да, после компиляции можно опубликовать сгенерированный код для каждого фреймворка в npm, так что одна дизайн-система может выпускать отдельные пакеты для React, Vue или Svelte из одного исходника.
Можно ли попробовать Mitosis без установки чего-либо?Да, в README есть ссылка на онлайн-песочницу Playground, где можно экспериментировать с компонентами Mitosis прямо в браузере.
What are similar projects?shaders, core, blobatar, puck, lucide, storybook, solid, formily
Creator
BuilderIO
Size
31.2 MB
Stars
14.4K
Age
5y
Commits · 90 Days