xto-fronted 0.1.9 → 0.2.0

package/README.md

@@ -12,6 +12,104 @@
 - 🌓 亮色/暗色主题切换
 - 📱 响应式布局
 
+## 安装
+
+```bash
+# npm
+npm install xto-fronted
+
+# pnpm
+pnpm add xto-fronted
+
+# yarn
+yarn add xto-fronted
+```
+
+## 快速开始
+
+```typescript
+// main.ts
+import { createApp } from 'vue'
+import { createPinia } from 'pinia'
+import App from './App.vue'
+import router from './router'
+
+// 初始化 xto-fronted
+import { createXtoApp } from 'xto-fronted'
+
+createXtoApp({
+  appName: '我的应用',
+  baseUrl: 'https://api.example.com',
+  appId: 'MY-APP-ID',
+  clientId: 'MY-CLIENT-ID',
+  indexPath: '/dashboard',
+  loginPath: '/login'
+})
+
+// 样式
+import 'xto-fronted/style.css'
+import '@xto/base/es/style.css'
+import '@xto/form/es/style.css'
+import '@xto/feedback/es/style.css'
+import '@xto/navigation/es/style.css'
+
+const app = createApp(App)
+app.use(createPinia())
+app.use(router)
+app.mount('#app')
+```
+
+```typescript
+// router/index.ts
+import { createRouter, createLayoutRoute, Login, NotFound } from 'xto-fronted'
+
+const businessRoutes = [
+  {
+    path: '/dashboard',
+    name: 'Dashboard',
+    component: () => import('@/views/dashboard/index.vue'),
+    meta: { title: '仪表盘', icon: 'dashboard' }
+  }
+]
+
+const layoutRoute = createLayoutRoute(businessRoutes, { indexPath: '/dashboard' })
+
+const routes = [
+  { path: '/login', name: 'Login', component: Login },
+  layoutRoute,
+  { path: '/:pathMatch(.*)*', redirect: '/404' }
+]
+
+export default createRouter(routes)
+```
+
+```vue
+<!-- App.vue -->
+<script setup>
+import { useAppStore } from 'xto-fronted'
+const appStore = useAppStore()
+</script>
+
+<template>
+  <div class="app" :class="{ dark: appStore.isDark }">
+    <router-view />
+  </div>
+</template>
+```
+
+## 示例项目
+
+查看 [example](./example) 目录获取完整的示例项目。
+
+```bash
+# 在根目录安装依赖（包含 example）
+pnpm install
+
+# 运行示例项目
+cd example
+pnpm dev
+```
+
 ## 项目结构
 
 ```

package/dist/api/auth.d.ts

@@ -1,5 +1,6 @@
 import { ApiResponse } from '../utils/request';
 import { LoginResult } from '../types/api';
+
 export interface LoginParams {
     uid: string;
     password: string;

package/dist/api/menu.d.ts

@@ -1,3 +1,4 @@
 import { ApiResponse } from '../utils/request';
 import { RemoteMenuItem } from '../types/api';
+
 export declare function getUserMenu(): Promise<ApiResponse<RemoteMenuItem[]>>;

package/dist/api/system.d.ts

@@ -1,5 +1,6 @@
 import { PageParams, PageResponse } from '../utils/request';
 import { RoleInfo, MenuItem } from '../types/api';
+
 export declare function getRoleList(params: PageParams & {
     status?: number;
     keyword?: string;

package/dist/api/user.d.ts

@@ -1,3 +1,4 @@
 import { ApiResponse } from '../utils/request';
 import { UserInfo } from '../types/api';
+
 export declare function getCurrentUser(): Promise<ApiResponse<UserInfo>>;

package/dist/components/Error/403.vue.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, HTMLDivElement>;
+declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
 export default _default;

package/dist/components/Error/404.vue.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, HTMLDivElement>;
+declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
 export default _default;

package/dist/components/Layout/Footer.vue.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, HTMLDivElement>;
+declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
 export default _default;

package/dist/components/Layout/Header.vue.d.ts

@@ -1,4 +1,15 @@
-declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {
-    dropdownRef: HTMLDivElement;
-}, HTMLDivElement>;
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<__VLS_TypePropsToRuntimeProps<{
+    showCollapse?: boolean;
+}>>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_TypePropsToRuntimeProps<{
+    showCollapse?: boolean;
+}>>> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
 export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/dist/components/Layout/Sidebar.vue.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, HTMLDivElement>;
+declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
 export default _default;

package/dist/components/Layout/Tabs.vue.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, HTMLDivElement>;
+declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
 export default _default;

package/dist/{App.vue.d.ts → components/Layout/TopMenu.vue.d.ts}

@@ -1,2 +1,2 @@
-declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, HTMLDivElement>;
+declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
 export default _default;

package/dist/components/Layout/index.vue.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, HTMLDivElement>;
+declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
 export default _default;

package/dist/components/Login/index.vue.d.ts

@@ -1,15 +1,25 @@
-type __VLS_Props = {
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<__VLS_TypePropsToRuntimeProps<{
     logo?: string;
     title?: string;
     subtitle?: string;
-};
-declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
-    error: (error: any) => any;
-    success: (data: any) => any;
-}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+}>>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    success: (data: any) => void;
+    error: (error: any) => void;
+}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_TypePropsToRuntimeProps<{
+    logo?: string;
+    title?: string;
+    subtitle?: string;
+}>>> & Readonly<{
     onError?: ((error: any) => any) | undefined;
     onSuccess?: ((data: any) => any) | undefined;
-}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
-    formRef: any;
-}, HTMLDivElement>;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
 export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/dist/components/SettingDrawer/index.vue.d.ts

@@ -0,0 +1,19 @@
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<__VLS_TypePropsToRuntimeProps<{
+    visible: boolean;
+}>>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    "update:visible": (val: boolean) => void;
+}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_TypePropsToRuntimeProps<{
+    visible: boolean;
+}>>> & Readonly<{
+    "onUpdate:visible"?: ((val: boolean) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/dist/composables/useApp.d.ts

@@ -1,4 +1,5 @@
 import { UserInfo, LoginResult } from '../types/api';
+
 export declare function useApp(): {
     loading: import('vue').Ref<boolean, boolean>;
     isLoggedIn: import('vue').ComputedRef<boolean>;

package/dist/composables/useMenu.d.ts

@@ -1,5 +1,6 @@
 import { MenuItem } from '../types/api';
-export declare function useMenu(iconMap?: Record<string, string>): {
+
+export declare function useMenu(): {
     searchKeyword: import('vue').Ref<string, string>;
     activeMenu: import('vue').ComputedRef<string>;
     isCollapsed: import('vue').ComputedRef<boolean>;
@@ -27,7 +28,6 @@ export declare function useMenu(iconMap?: Record<string, string>): {
     flattenMenus: (menus: MenuItem[], parentTitle?: string) => (MenuItem & {
         parentTitle: string;
     })[];
-    getMenuIcon: (icon?: string) => string;
     handleMenuSelect: (index: string) => void;
     handleSearchItemClick: (path: string) => void;
     clearSearch: () => void;

package/dist/directives/permission.d.ts

@@ -1,4 +1,5 @@
 import { Directive } from 'vue';
+
 declare const permission: Directive;
 export default permission;
 export declare function setupPermissionDirective(app: any): void;

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { XtoConfig, setConfig, getConfig, getConfigValue } from './config';
+
 export { default as Layout } from './components/Layout/index.vue';
 export { default as Header } from './components/Layout/Header.vue';
 export { default as Sidebar } from './components/Layout/Sidebar.vue';
@@ -7,6 +8,7 @@ export { default as Footer } from './components/Layout/Footer.vue';
 export { default as Login } from './components/Login/index.vue';
 export { default as NotFound } from './components/Error/404.vue';
 export { default as Forbidden } from './components/Error/403.vue';
+export { default as SettingDrawer } from './components/SettingDrawer/index.vue';
 export { useApp } from './composables/useApp';
 export { useAuth } from './composables/useAuth';
 export { useMenu } from './composables/useMenu';