Paquetes

Harmonix se distribuye como cinco paquetes npm bajo el scope @uxland. El núcleo es el único que una aplicación necesita en tiempo de ejecución. Los demás te ayudan a crear, ejecutar, adaptar y publicar plugins. Cada paquete tiene su propia página en esta sección, con la instalación, las exportaciones o los comandos principales y enlaces a las guías detalladas.

1. Crear@uxland/create-harmonix-pluginnpm create @uxland/harmonix-plugin
2. Desarrollar@uxland/harmonix-demo-shellnpm run dev
3. Publicar@uxland/harmonix-cliharmonix publish
4. Ejecutar@uxland/harmonix-adapterswrapReactViewFactory()

@uxland/harmonixEl núcleo: el contrato de los plugins, bootstrapPlugins y las regiones. Toda aplicación se basa en él.

Cada paquete tiene su momento, y todos se apoyan en el núcleo.

Los paquetes

Paquete	Para qué sirve	Quién lo usa	Cuándo	npm
@uxland/harmonix	El núcleo: contrato de los plugins, bootstrapPlugins, gestor de regiones y tipos de la API	Autores de shells (los autores de plugins usan sus tipos)	Ejecución	npm
@uxland/harmonix-demo-shell	Un shell mínimo con tres regiones para ejecutar un plugin mientras lo desarrollas	Autores de plugins	Desarrollo	npm
@uxland/create-harmonix-plugin	Crea un proyecto de plugin con React, Lit o Angular (npm create @uxland/harmonix-plugin)	Autores de plugins	Desarrollo (una vez, al principio)	npm
@uxland/harmonix-adapters	Envuelve un componente React en un Web Component para que se pueda registrar como vista	Autores de plugins que usan React	Ejecución	npm
@uxland/harmonix-cli	harmonix publish: sube un plugin compilado a un Plugin Store	Autores de plugins	Publicación	npm

El núcleo depende de @uxland/regions, que proporciona las regiones en sí (el decorador @region y los adaptadores de región). Un shell usa los dos.

¿Cuál necesito?

Escribo un plugin.

1. Crea el proyecto con @uxland/create-harmonix-plugin. Instala todo lo demás que necesitas para desarrollar.
2. Ejecútalo dentro del shell de demostración con npm run dev.
3. Si usas React, registra tus vistas con @uxland/harmonix-adapters. La plantilla de React ya lo hace.
4. Haz el build y súbelo a tu Plugin Store con @uxland/harmonix-cli.

Construyo una aplicación (un shell).

Instala @uxland/harmonix y @uxland/regions, y escribe tu propio shell: su layout, sus regiones y la API que recibe cada plugin. Consulta Construir un shell. El shell de demostración es una referencia que funciona, no una base para aplicaciones en producción.

Escribo un plugin para una aplicación existente.

Tu plugin recibe la API del shell de esa aplicación, que extiende HarmonixApi del núcleo. Puedes desarrollarlo igualmente de forma aislada con el creador y el shell de demostración, siempre que solo uses lo que ofrecen los dos shells, y publicarlo con la CLI en el Plugin Store de la aplicación.

Solo quiero probar Harmonix.

Ejecuta npm create @uxland/harmonix-plugin@latest y sigue Crear un plugin.