@viewfly/platform-browser 0.0.1-alpha.11 → 0.0.1-alpha.13

package/README.md

@@ -1,4 +1,57 @@
 Viewfly
 ================================
 
-Viewfly 是一个简单、数据驱动的前端视图库，完整文档请参考官方网站：[viewfly.org](https://viewfly.org)
+Viewfly 是一个简单、数据驱动的前端框架。此项目为内核运行在浏览器上的支持层。
+
+## 安装
+
+```
+npm install @viewfly/platform-browser
+```
+
+## API
+
+### createApp()
+
+createApp 用于创建一个独立的应用。
+
+```js
+import { createApp } from '@viewfly/platform-browser'
+
+function App() {
+  return () => {
+    return <div>App!</div>
+  }
+}
+
+const app = createApp(document.getElementById('app'), <App/>)
+
+// 销毁 app 实例
+app.destroy()
+```
+
+### fork()
+
+可以在任意组件内创建一个子应用，并可以继承当前组件的上下文（特指当前组件的依赖注入树），常用于创建一个弹窗或对话框。
+
+```jsx
+function App() {
+  function Modal() {
+    return () => {
+      return <div>modal</div>
+    }
+  }
+  // 创建子应用
+  const childApp = fork(<Modal/>)
+  // 启动子应用
+  childApp.mount(document.getElementById('modal'))
+  // 销毁子应用
+  childApp.destroy()
+
+  return () => {
+    return <div>App!</div>
+  }
+}
+```
+
+完整文档请参考官方网站：[viewfly.org](https://viewfly.org)

package/bundles/fork.d.ts

@@ -1,2 +1,2 @@
 import { RootNode, Viewfly } from '@viewfly/core';
-export declare function fork(host: HTMLElement, root: RootNode): Viewfly;
+export declare function fork(root: RootNode): Viewfly;

package/bundles/index.esm.js

@@ -244,7 +244,6 @@ DomRenderer = __decorate([
 function createApp(host, root, autoUpdate = true) {
     host.innerHTML = '';
     const app = new Viewfly({
-        host,
         root,
         autoUpdate,
         providers: [
@@ -254,12 +253,12 @@ function createApp(host, root, autoUpdate = true) {
             }
         ]
     });
-    app.run();
+    app.mount(host);
     return app;
 }
 
 const forkErrorFn = makeError('fork');
-function fork(host, root) {
+function fork(root) {
     let parentComponent;
     try {
         parentComponent = provide([]);
@@ -268,7 +267,6 @@ function fork(host, root) {
         throw forkErrorFn('The fork function can only be called synchronously within a component.');
     }
     const app = new Viewfly({
-        host,
         root,
         context: parentComponent,
         providers: [

package/bundles/index.js

@@ -246,7 +246,6 @@ exports.DomRenderer = __decorate([
 function createApp(host, root, autoUpdate = true) {
     host.innerHTML = '';
     const app = new core.Viewfly({
-        host,
         root,
         autoUpdate,
         providers: [
@@ -256,12 +255,12 @@ function createApp(host, root, autoUpdate = true) {
             }
         ]
     });
-    app.run();
+    app.mount(host);
     return app;
 }
 
 const forkErrorFn = core.makeError('fork');
-function fork(host, root) {
+function fork(root) {
     let parentComponent;
     try {
         parentComponent = core.provide([]);
@@ -270,7 +269,6 @@ function fork(host, root) {
         throw forkErrorFn('The fork function can only be called synchronously within a component.');
     }
     const app = new core.Viewfly({
-        host,
         root,
         context: parentComponent,
         providers: [

package/package.json

@@ -1,14 +1,11 @@
 {
   "name": "@viewfly/platform-browser",
-  "version": "0.0.1-alpha.11",
-  "description": "Viewfly is a simple and easy-to-use JavaScript framework with an intuitive development experience.",
+  "version": "0.0.1-alpha.13",
+  "description": "This project is used to enable the Viewfly framework to run in a browser.",
   "main": "./bundles/index.js",
   "module": "./bundles/index.esm.js",
   "typings": "./bundles/public-api.d.ts",
   "scripts": {
-    "start": "webpack-dev-server",
-    "test": "cross-env env=test jest",
-    "test-c": "cross-env env=test jest --coverage",
     "build:lib": "rimraf bundles && rollup --config rollup.config.ts --configPlugin @rollup/plugin-typescript",
     "publish:lib": "npm run build:lib && npm publish --access=public"
   },
@@ -16,7 +13,7 @@
   "keywords": [],
   "dependencies": {
     "@tanbo/di": "^1.1.4",
-    "@viewfly/core": "^0.0.1-alpha.11",
+    "@viewfly/core": "^0.0.1-alpha.13",
     "reflect-metadata": "^0.1.13"
   },
   "devDependencies": {
@@ -36,6 +33,5 @@
   },
   "bugs": {
     "url": "https://github.com/viewfly/viewfly.git/issues"
-  },
-  "gitHead": "38e6182b1ae82b0f9626742507ca7a4583d182f9"
+  }
 }