@univa/core 0.0.2 → 0.0.4

package/README.md

@@ -61,7 +61,244 @@ export default defineConfig({
 
 ## 功能详解
 
-待补充...
+### 自动导入
+
+自动导入 Vue、Pinia、uni-app 等 API，无需手动 import：
+
+```typescript
+// 无需 import，直接使用
+const count = ref(0)
+const router = useRouter()
+const store = useStore()
+```
+
+**自动扫描目录**：
+- `src/hooks/**` - 自动导入 hooks
+- `src/store/**` - 自动导入 store
+- `src/constants/**` - 自动导入常量
+
+### 组件自动注册
+
+自动注册 `components` 目录下的组件，无需手动 import：
+
+```
+src/
+├── components/
+│   ├── MyButton.vue
+│   └── common/
+│       └── Icon.vue
+└── components-biz/
+    └── Card.vue
+```
+
+在页面中直接使用：
+
+```vue
+<template>
+  <MyButton />
+  <Icon />
+  <BizCard />
+</template>
+```
+
+**特性**：
+- `components/` 和 `common/` 是全局命名空间，不添加前缀
+- `components-biz/` 会自动添加 `Biz` 命名空间前缀
+- 自动生成类型声明文件
+
+### 页面管理
+
+#### 定义页面配置
+
+**方式 1：在 pages.config.ts 中定义**
+
+```typescript
+// pages.config.ts
+import { definePagesConfig } from '@univa/core'
+
+export default definePagesConfig({
+  tabBarMode: 'CUSTOM', // 'NONE' | 'NATIVE' | 'CUSTOM'
+  tabBar: {
+    list: [
+      {
+        pagePath: 'pages/index',
+        text: '首页',
+        iconPath: 'images/tabbar/home.png',
+        selectedIconPath: 'images/tabbar/home_selected.png',
+      },
+    ],
+  },
+})
+```
+
+**方式 2：在 vite.config.ts 中直接定义**
+
+```typescript
+// vite.config.ts
+import { Univa } from '@univa/core'
+import { defineConfig } from 'vite'
+
+export default defineConfig({
+  plugins: [
+    Univa({
+      pages: {
+        config: {
+          tabBarMode: 'CUSTOM',
+          tabBar: {
+            list: [...],
+          },
+        },
+      },
+    }),
+  ],
+})
+```
+
+#### 获取 TabBar 配置
+
+在组件中获取 tabBar 配置：
+
+```typescript
+import tabBar from 'virtual:univa-tabbar'
+
+if (tabBar) {
+  console.log(tabBar.list) // TabBar 列表
+}
+```
+
+### UnoCSS 预设
+
+内置 UnoCSS 预设，提供开箱即用的原子化 CSS：
+
+**内置预设**：
+- `presetUni()` - uni-app 专属预设
+- `presetIcons()` - 图标预设（scale: 1.2）
+- `presetLegacyCompat()` - 兼容性预设（处理低端安卓机）
+
+**内置快捷方式**：
+```typescript
+'border-s' // border border-solid
+'wh-full' // w-full h-full
+'f-c-c' // flex justify-center items-center
+'f-col-c' // flex-col justify-center items-center
+'flex-items' // flex items-center
+'flex-justify' // flex justify-center
+'flex-col' // flex flex-col
+```
+
+**安全区域规则**：
+```html
+<div class="p-safe">安全区域内边距</div>
+<div class="pt-safe">顶部安全区域</div>
+<div class="pb-safe">底部安全区域</div>
+```
+
+### 根组件
+
+自动创建和管理 `App.univa.vue` 根组件：
+
+```vue
+<script setup lang="ts">
+</script>
+
+<template>
+  <UnivaPageMeta background-color="#ff0000" page-style="color: green" />
+  <view class="container">
+    <UnivaRootView />
+  </view>
+</template>
+```
+
+**特性**：
+- 自动创建根组件文件
+- 支持虚拟节点（`virtualHost`）
+- 支持全局 ref
+- 支持 `<UnivaPageMeta>` 组件配置页面元信息
+- 支持 `<UnivaRootView />` 组件作为根视图
+
+### Manifest 配置
+
+在 `vite.config.ts` 中直接配置 manifest：
+
+```typescript
+import { Univa } from '@univa/core'
+import { defineConfig } from 'vite'
+
+export default defineConfig({
+  plugins: [
+    Univa({
+      manifest: {
+        name: 'my-app',
+        appid: '__UNI__XXXXXX',
+        description: 'My Application',
+        versionName: '1.0.0',
+        versionCode: '100',
+      },
+    }),
+  ],
+})
+```
+
+## 配置选项
+
+```typescript
+import type { UnivaUserConfig } from '@univa/core'
+
+const config: UnivaUserConfig = {
+  // 自动导入配置（默认 true）
+  autoImport: true,
+
+  // 组件自动注册配置（默认 true）
+  components: true,
+
+  // 页面配置
+  pages: {
+    config: {
+      // TabBar 模式：'NONE' | 'NATIVE' | 'CUSTOM'
+      tabBarMode: 'NATIVE',
+      tabBar: {
+        color: '#A6A6A6',
+        selectedColor: '#003594',
+        list: [
+          {
+            pagePath: 'pages/index',
+            text: '首页',
+            iconPath: 'images/tabbar/home.png',
+            selectedIconPath: 'images/tabbar/home_selected.png',
+          },
+        ],
+      },
+      // 全局样式配置
+      globalStyle: {
+        navigationBarBackgroundColor: '#000000',
+        navigationBarTextStyle: 'black',
+        navigationBarTitleText: 'My App',
+        navigationStyle: 'custom',
+        enablePullDownRefresh: false,
+        onReachBottomDistance: 50,
+        animationType: 'pop-in',
+        animationDuration: 300,
+      },
+    },
+    // 排除的页面
+    exclude: ['pages/exclude/**'],
+    // 分包配置
+    subPackages: ['pages-sub'],
+  },
+
+  // 根组件配置（默认 true）
+  appRoot: true,
+
+  // Manifest 配置
+  manifest: {
+    name: 'my-app',
+    appid: '__UNI__XXXXXX',
+    description: 'My Application',
+    versionName: '1.0.0',
+    versionCode: '100',
+  },
+}
+```
 
 ## 依赖
 

package/dist/hooks.cjs

@@ -0,0 +1,83 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/hooks.ts
+var hooks_exports = {};
+__export(hooks_exports, {
+  usePageContext: () => usePageContext
+});
+module.exports = __toCommonJS(hooks_exports);
+
+// src/hooks/usePageContext/index.ts
+var import_uni_app = require("@dcloudio/uni-app");
+var import_vue = require("vue");
+function usePageContext(options = {}) {
+  const isMounted = (0, import_vue.ref)(false);
+  const univaRootRef = (0, import_vue.ref)();
+  const scrollTop = (0, import_vue.ref)(0);
+  const mountedCallbacks = [];
+  const unmountedCallbacks = [];
+  const showAfterMountedCallbacks = [];
+  const onPageShowAfterMounted = (callback) => {
+    showAfterMountedCallbacks.push(callback);
+  };
+  const onPageMounted = (callback) => {
+    mountedCallbacks.push(callback);
+  };
+  const onPageUnmounted = (callback) => {
+    unmountedCallbacks.push(callback);
+  };
+  (0, import_uni_app.onShow)(() => {
+    if (isMounted.value) {
+      showAfterMountedCallbacks.forEach((cb) => cb());
+    }
+  });
+  (0, import_uni_app.onPageScroll)((e) => {
+    scrollTop.value = e.scrollTop;
+  });
+  (0, import_vue.onMounted)(() => {
+    const pagesStack = getCurrentPages();
+    const pageStack = pagesStack[pagesStack.length - 1];
+    if (!pageStack?.$vm?.$refs?.univaRootRef) {
+      throw new Error('[usePageContext] univaRootRef not found. Make sure the page has <univa-root ref="univaRootRef" /> component.');
+    }
+    univaRootRef.value = pageStack.$vm.$refs.univaRootRef;
+    isMounted.value = true;
+    mountedCallbacks.forEach((cb) => cb());
+  });
+  (0, import_vue.onUnmounted)(() => {
+    isMounted.value = false;
+    unmountedCallbacks.forEach((cb) => cb());
+    mountedCallbacks.length = 0;
+    unmountedCallbacks.length = 0;
+    showAfterMountedCallbacks.length = 0;
+  });
+  return {
+    isMounted,
+    univaRootRef,
+    scrollTop: (0, import_vue.computed)(() => scrollTop.value),
+    onPageMounted,
+    onPageUnmounted,
+    onPageShowAfterMounted
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  usePageContext
+});

package/dist/hooks.d.cts

@@ -0,0 +1,36 @@
+import { Ref, ComputedRef } from 'vue';
+
+interface PageContextOptions {
+    /**
+     * uniapp 必须在页面内检测到 onPageScroll 关键词才会注册事件。
+     * @see https://github.com/dcloudio/uni-app/issues/3099 让页面被正则捕获从而开启监听
+     */
+    onPageScroll?: any;
+}
+interface PageContext {
+    isMounted: Ref<boolean>;
+    univaRootRef: Ref<any>;
+    scrollTop: ComputedRef<number>;
+    /**
+     * 页面挂载成功时执行
+     * @param callback
+     * @returns
+     */
+    onPageMounted: (callback: () => void) => void;
+    /**
+     * 页面卸载时执行
+     * @param callback
+     * @returns
+     */
+    onPageUnmounted: (callback: () => void) => void;
+    /**
+     * 页面挂载成功后的每次显示时执行
+     * @param callback
+     * @returns
+     */
+    onPageShowAfterMounted: (callback: () => void) => void;
+}
+
+declare function usePageContext(options?: PageContextOptions): PageContext;
+
+export { usePageContext };

package/dist/hooks.d.ts

@@ -0,0 +1,36 @@
+import { Ref, ComputedRef } from 'vue';
+
+interface PageContextOptions {
+    /**
+     * uniapp 必须在页面内检测到 onPageScroll 关键词才会注册事件。
+     * @see https://github.com/dcloudio/uni-app/issues/3099 让页面被正则捕获从而开启监听
+     */
+    onPageScroll?: any;
+}
+interface PageContext {
+    isMounted: Ref<boolean>;
+    univaRootRef: Ref<any>;
+    scrollTop: ComputedRef<number>;
+    /**
+     * 页面挂载成功时执行
+     * @param callback
+     * @returns
+     */
+    onPageMounted: (callback: () => void) => void;
+    /**
+     * 页面卸载时执行
+     * @param callback
+     * @returns
+     */
+    onPageUnmounted: (callback: () => void) => void;
+    /**
+     * 页面挂载成功后的每次显示时执行
+     * @param callback
+     * @returns
+     */
+    onPageShowAfterMounted: (callback: () => void) => void;
+}
+
+declare function usePageContext(options?: PageContextOptions): PageContext;
+
+export { usePageContext };

package/dist/hooks.js

@@ -0,0 +1,56 @@
+// src/hooks/usePageContext/index.ts
+import { onPageScroll, onShow } from "@dcloudio/uni-app";
+import { computed, onMounted, onUnmounted, ref } from "vue";
+function usePageContext(options = {}) {
+  const isMounted = ref(false);
+  const univaRootRef = ref();
+  const scrollTop = ref(0);
+  const mountedCallbacks = [];
+  const unmountedCallbacks = [];
+  const showAfterMountedCallbacks = [];
+  const onPageShowAfterMounted = (callback) => {
+    showAfterMountedCallbacks.push(callback);
+  };
+  const onPageMounted = (callback) => {
+    mountedCallbacks.push(callback);
+  };
+  const onPageUnmounted = (callback) => {
+    unmountedCallbacks.push(callback);
+  };
+  onShow(() => {
+    if (isMounted.value) {
+      showAfterMountedCallbacks.forEach((cb) => cb());
+    }
+  });
+  onPageScroll((e) => {
+    scrollTop.value = e.scrollTop;
+  });
+  onMounted(() => {
+    const pagesStack = getCurrentPages();
+    const pageStack = pagesStack[pagesStack.length - 1];
+    if (!pageStack?.$vm?.$refs?.univaRootRef) {
+      throw new Error('[usePageContext] univaRootRef not found. Make sure the page has <univa-root ref="univaRootRef" /> component.');
+    }
+    univaRootRef.value = pageStack.$vm.$refs.univaRootRef;
+    isMounted.value = true;
+    mountedCallbacks.forEach((cb) => cb());
+  });
+  onUnmounted(() => {
+    isMounted.value = false;
+    unmountedCallbacks.forEach((cb) => cb());
+    mountedCallbacks.length = 0;
+    unmountedCallbacks.length = 0;
+    showAfterMountedCallbacks.length = 0;
+  });
+  return {
+    isMounted,
+    univaRootRef,
+    scrollTop: computed(() => scrollTop.value),
+    onPageMounted,
+    onPageUnmounted,
+    onPageShowAfterMounted
+  };
+}
+export {
+  usePageContext
+};

package/dist/index.cjs

@@ -56,7 +56,11 @@ function createAutoImportPlugin(options) {
     imports: [
       "vue",
       "pinia",
-      "uni-app"
+      "uni-app",
+      {
+        from: "@univa/core/hooks",
+        imports: ["usePageContext"]
+      }
     ],
     dirs: [
       "src/hooks/**",

package/dist/index.js

@@ -16,7 +16,11 @@ function createAutoImportPlugin(options) {
     imports: [
       "vue",
       "pinia",
-      "uni-app"
+      "uni-app",
+      {
+        from: "@univa/core/hooks",
+        imports: ["usePageContext"]
+      }
     ],
     dirs: [
       "src/hooks/**",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@univa/core",
   "type": "module",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "",
   "author": "",
   "license": "MIT",
@@ -17,6 +17,16 @@
         "default": "./dist/index.cjs"
       }
     },
+    "./hooks": {
+      "import": {
+        "types": "./dist/hooks.d.ts",
+        "default": "./dist/hooks.js"
+      },
+      "require": {
+        "types": "./dist/hooks.d.cts",
+        "default": "./dist/hooks.cjs"
+      }
+    },
     "./client": {
       "types": "./src/client.d.ts"
     }
@@ -38,9 +48,15 @@
     "build": "tsup",
     "dev": "tsup --watch"
   },
+  "peerDependencies": {
+    "@dcloudio/uni-app": "^3.0.0-3090920231225001",
+    "vite": "^5.2.8",
+    "vue": "^3.4.21"
+  },
   "dependencies": {
     "@uni-helper/eslint-config": "0.7.3",
     "@uni-helper/plugin-uni": "0.1.0",
+    "@uni-helper/uni-types": "1.0.0-alpha.8",
     "@uni-helper/unocss-preset-uni": "0.2.11",
     "@uni-helper/vite-plugin-uni-components": "0.2.10",
     "@uni-helper/vite-plugin-uni-layouts": "0.1.11",
@@ -48,18 +64,21 @@
     "@uni-ku/bundle-optimizer": "2.1.2",
     "@univa/manifest": "^0.0.1",
     "@univa/root": "^0.0.1",
+    "@univa/tsconfig": "^0.0.2",
     "@unocss/eslint-plugin": "66.6.7",
     "@unocss/preset-legacy-compat": "66.0.0",
     "eslint": "10.3.0",
     "sass": "1.99.0",
     "unocss": "66.0.0",
-    "unplugin-auto-import": "21.0.0",
+    "unplugin-auto-import": "20.0.0",
     "vite-plugin-uni-polyfill": "0.1.0"
   },
   "devDependencies": {
-    "c12": "4.0.0-beta.4",
-    "tsup": "^8.5.1",
+    "@dcloudio/uni-app": "^3.0.0-3090920231225001",
+    "c12": "3.3.4",
+    "tsup": "8.5.1",
     "typescript": "^5.4.0",
-    "vite": "5.2.8"
+    "vite": "5.2.8",
+    "vue": "^3.4.21"
   }
 }

package/src/client.d.ts

@@ -1,6 +1,8 @@
 /// <reference path="./global.d.ts" />
 /// <reference types="@uni-helper/vite-plugin-uni-pages/client" />
 /// <reference types="vite/client" />
+/// <reference types="@uni-ku/bundle-optimizer/client" />
+/// <reference types="@uni-helper/uni-types" />
 
 declare module 'virtual:univa-tabbar' {
   import type { TabBar } from '@uni-helper/vite-plugin-uni-pages'