@micro-zoe/micro-app 0.5.1 → 0.6.1

package/README.md

@@ -57,11 +57,8 @@ microApp.start()
 ```html
 <!-- my-page.vue -->
 <template>
-  <div>
-    <h1>micro application</h1>
-    <!-- 👇 name is the application name, url is the html address -->
-    <micro-app name='app1' url='http://localhost:3000/'></micro-app>
-  </div>
+  <!-- 👇 name is the app name, url is the app address -->
+  <micro-app name='my-app' url='http://localhost:3000/'></micro-app>
 </template>
 ```
 
@@ -145,7 +142,13 @@ For more commands, see [DEVELP](https://github.com/micro-zoe/micro-app/blob/mast
 <details>
   <summary>Does it support vite?</summary>
   
-  Yes, please see [adapt vite](https://micro-zoe.github.io/micro-app/docs.html#/zh-cn/advanced?id=_2%e3%80%81%e9%80%82%e9%85%8dvite) for details.
+  Yes, please see [adapt vite](https://micro-zoe.github.io/micro-app/docs.html#/zh-cn/framework/vite) for details.
+</details>
+
+<details>
+  <summary>Does it support ssr?</summary>
+  
+  Yes, please see [nextjs](https://micro-zoe.github.io/micro-app/docs.html#/zh-cn/framework/nextjs), [nuxtjs](https://micro-zoe.github.io/micro-app/docs.html#/zh-cn/framework/nuxtjs) for details.
 </details>
 
 # Contributors

package/README.zh-cn.md

@@ -25,7 +25,7 @@
   </a>
 </p>
 
-[English](https://github.com/micro-zoe/micro-app)｜简体中文｜[官网文档](https://micro-zoe.github.io/micro-app/)｜[讨论组](https://github.com/micro-zoe/micro-app/discussions)｜[Gitter群聊](https://gitter.im/microzoe/micro-app)
+[English](https://github.com/micro-zoe/micro-app)｜简体中文｜[官网文档](https://micro-zoe.github.io/micro-app/)｜[讨论组](https://github.com/micro-zoe/micro-app/discussions)｜[聊天室](https://gitter.im/microzoe/micro-app)
 
 # 📖简介
 micro-app是京东零售推出的一款微前端框架，它基于类WebComponent进行渲染，从组件化的思维实现微前端，旨在降低上手难度、提升工作效率。它是目前接入微前端成本最低的框架，并且提供了JS沙箱、样式隔离、元素隔离、预加载、资源地址补全、插件系统、数据通信等一系列完善的功能。
@@ -44,7 +44,7 @@ micro-app与技术栈无关，对前端框架没有限制，任何框架都可
 yarn add @micro-zoe/micro-app
 ```
 
-**2、在入口处引入依赖**
+**2、在入口文件引入**
 ```js
 // main.js
 import microApp from '@micro-zoe/micro-app'
@@ -56,11 +56,8 @@ microApp.start()
 ```html
 <!-- my-page.vue -->
 <template>
-  <div>
-    <h1>子应用</h1>
-    <!-- 👇 name为应用名称，url为html地址 -->
-    <micro-app name='app1' url='http://localhost:3000/'></micro-app>
-  </div>
+  <!-- 👇 name为应用名称，url为应用地址 -->
+  <micro-app name='my-app' url='http://localhost:3000/'></micro-app>
 </template>
 ```
 
@@ -146,7 +143,13 @@ yarn start # 访问 http://localhost:3000
 <details>
   <summary>支持vite吗?</summary>
   
-  支持，详情请查看[适配vite](https://micro-zoe.github.io/micro-app/docs.html#/zh-cn/advanced?id=_2%e3%80%81%e9%80%82%e9%85%8dvite)
+  支持，详情请查看[适配vite](https://micro-zoe.github.io/micro-app/docs.html#/zh-cn/framework/vite)
+</details>
+
+<details>
+  <summary>支持ssr吗?</summary>
+  
+  支持，详情请查看[nextjs](https://micro-zoe.github.io/micro-app/docs.html#/zh-cn/framework/nextjs)、[nuxtjs](https://micro-zoe.github.io/micro-app/docs.html#/zh-cn/framework/nuxtjs)
 </details>
 
 # 贡献者们

package/lib/index.d.ts

@@ -8,8 +8,7 @@ declare module '@micro-zoe/micro-app' {
     export { default as preFetch, } from '@micro-zoe/micro-app/prefetch';
     export { removeDomScope, pureCreateElement, version, } from '@micro-zoe/micro-app/libs/utils';
     export { EventCenterForMicroApp, } from '@micro-zoe/micro-app/interact';
-    export { getActiveApps, // version >= 0.5.1
-    getAllApps, } from './create_app';
+    export { getActiveApps, getAllApps, unmountApp, unmountAllApps, } from '@micro-zoe/micro-app/create_app';
 }
 
 declare module '@micro-zoe/micro-app/micro_app' {
@@ -24,6 +23,7 @@ declare module '@micro-zoe/micro-app/micro_app' {
         disableScopecss?: boolean;
         disableSandbox?: boolean;
         macro?: boolean;
+        ssr?: boolean;
         lifeCycles?: lifeCyclesType;
         plugins?: plugins;
         fetch?: fetchType;
@@ -275,3 +275,82 @@ declare module '@micro-zoe/micro-app/interact' {
     export {};
 }
 
+declare module '@micro-zoe/micro-app/create_app' {
+    import type { AppInterface, sourceType, SandBoxInterface } from '@micro-app/types';
+    export const appInstanceMap: Map<string, AppInterface>;
+    export interface CreateAppParam {
+            name: string;
+            url: string;
+            ssrUrl?: string;
+            scopecss: boolean;
+            useSandbox: boolean;
+            macro?: boolean;
+            inline?: boolean;
+            baseroute?: string;
+            container?: HTMLElement | ShadowRoot;
+    }
+    export default class CreateApp implements AppInterface {
+            umdMode: boolean;
+            isPrefetch: boolean;
+            name: string;
+            url: string;
+            ssrUrl: string;
+            container: HTMLElement | ShadowRoot | null;
+            inline: boolean;
+            scopecss: boolean;
+            useSandbox: boolean;
+            macro: boolean;
+            baseroute: string;
+            source: sourceType;
+            sandBox: SandBoxInterface | null;
+            constructor({ name, url, ssrUrl, container, inline, scopecss, useSandbox, macro, baseroute, }: CreateAppParam);
+            loadSourceCode(): void;
+            /**
+                * When resource is loaded, mount app if it is not prefetch or unmount
+                */
+            onLoad(html: HTMLElement): void;
+            /**
+                * Error loading HTML
+                * @param e Error
+                */
+            onLoadError(e: Error): void;
+            /**
+                * mount app
+                * @param container app container
+                * @param inline js runs in inline mode
+                * @param baseroute route prefix, default is ''
+                */
+            mount(container?: HTMLElement | ShadowRoot, inline?: boolean, baseroute?: string): void;
+            /**
+                * unmount app
+                * @param destroy completely destroy, delete cache resources
+                * @param unmountcb callback of unmount
+                */
+            unmount(destroy: boolean, unmountcb?: CallableFunction): void;
+            actionsForCompletelyDestory(): void;
+            hiddenKeepAliveApp(): void;
+            showKeepAliveApp(container: HTMLElement | ShadowRoot): void;
+            /**
+                * app rendering error
+                * @param e Error
+                */
+            onerror(e: Error): void;
+            getAppState(): string;
+            getKeepAliveState(): string | null;
+    }
+    export function getActiveApps(): string[];
+    export function getAllApps(): string[];
+    export interface unmountAppParams {
+            destroy?: boolean;
+            clearAliveState?: boolean;
+    }
+    /**
+        * unmount app by appname
+        * @param appName
+        * @param options unmountAppParams
+        * @returns Promise<void>
+        */
+    export function unmountApp(appName: string, options?: unmountAppParams): Promise<void>;
+    export function unmountAllApps(options?: unmountAppParams): Promise<void>;
+}
+