jcjy-components 0.1.4 → 0.1.6

package/README.md

@@ -49,7 +49,7 @@ export default {
 本库已内置类型声明，TS 项目可直接获得类型提示。
 
 ```ts
-import type { AuthGatewayConfig } from "jcjy-components/dist/components/auth-gateway/interface";
+import type { AuthGatewayConfig } from "jcjy-components";
 ```
 
 ## 样式说明
@@ -77,6 +77,18 @@ import type { AuthGatewayConfig } from "jcjy-components/dist/components/auth-gat
 </template>
 ```
 
+`AuthGatewayConfig` 中与登录页展示相关的行为：
+
+- `loginBackground` 传值时，组件按该图片渲染登录页背景；若同时传 `nb: "1"`，则不显示背景图。
+- `loginBackground` 不传或传空字符串时，组件不再使用内置默认图，而是显示内置的侧边宣传文案区。
+- `layout` 仍支持 `default`、`center`、`left`，用于控制认证区在不同布局下的位置。
+
+普通账号登录默认展示“记住我”：
+
+- 勾选后登录，组件会把账号和原始密码保存到浏览器 `localStorage`，下次进入登录页自动回填。
+- 未勾选登录时，组件会清理已保存的账号和密码。
+- 保存时会对账号和密码做基于 `charCodeAt` 的可逆字符编码混淆，避免在 `localStorage` 中直接显示明文；该方式不等同安全加密，不能抵御同源脚本读取或有代码访问权限的人还原。
+
 ### 主题工具
 
 ```ts

package/dist/components/auth-gateway/ag-input.vue.d.ts

@@ -1,11 +1,19 @@
 type __VLS_Props = {
+    label: string;
     modelValue: string;
     type?: "text" | "password";
     id?: string;
     placeholder?: string;
     autocomplete?: string;
+    showPassword?: boolean;
 };
-declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
+declare var __VLS_1: {}, __VLS_3: {};
+type __VLS_Slots = {} & {
+    default?: (props: typeof __VLS_1) => any;
+} & {
+    suffix?: (props: typeof __VLS_3) => any;
+};
+declare const __VLS_base: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
     "update:modelValue": (value: string) => any;
 }, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
     "onUpdate:modelValue"?: ((value: string) => any) | undefined;
@@ -14,6 +22,13 @@ declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {
     id: string;
     placeholder: string;
     autocomplete: string;
+    showPassword: boolean;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
 declare const _default: typeof __VLS_export;
 export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/components/auth-gateway/interface.d.ts

@@ -6,8 +6,11 @@ export declare const TabKey: {
 };
 export type TabKey = (typeof TabKey)[keyof typeof TabKey];
 export interface AuthGatewayProps {
+    /** 网关配置项（标题、背景、布局等） */
     config: AuthGatewayConfig;
+    /** 是否启用严格注册规则（密码复杂度等） */
     strictRegister?: boolean;
+    /** 身份绑定回调（绑定学校/姓名/学号） */
     binding: (v: {
         orgName: string;
         name: string;
@@ -15,11 +18,13 @@ export interface AuthGatewayProps {
     }, headers: {
         token: string;
     }) => Promise<any>;
+    /** 账号注册回调 */
     register: (params: {
         userName: string;
         passwd: string;
         weChatOpenId?: string;
     }) => Promise<any>;
+    /** 登录回调（支持账号或微信） */
     login: (params: {
         weChatCode?: string;
         userName?: string;
@@ -30,21 +35,68 @@ export interface AuthGatewayProps {
         msg: string;
         weChatUserDetail: any;
     } | any>;
+    /** 微信登录配置（扫码 appId 与回调地址） */
     wechatConfig?: {
+        /** 微信开放平台应用 appId */
         appId: string;
+        /** 扫码后回调地址 */
         redirectUrl: string;
     };
 }
+/** AuthGateway 组件配置 */
 export interface AuthGatewayConfig {
+    /** 登录页标题 */
     title?: string;
+    /** 网站图标 URL */
     favicon?: string;
+    /** 登录页背景图 URL */
     loginBackground?: string;
+    /**
+     * 是否跳过身份绑定
+     * - "0": 需要绑定（默认）
+     * - "1": 跳过绑定
+     */
     skipBind?: "0" | "1";
+    /**
+     * 是否隐藏页脚
+     * - "0": 显示（默认）
+     * - "1": 隐藏
+     */
     hf?: "0" | "1";
+    /**
+     * 是否隐藏背景图
+     * - "0": 显示背景（默认）
+     * - "1": 隐藏背景
+     */
     nb?: "0" | "1";
+    /** 自定义页脚 HTML 文本 */
     cf?: string;
+    /**
+     * 来源标记
+     * - "inline": 内嵌模式（不自动跳转）
+     */
     from?: "inline";
+    /** 是否隐藏微信登录入口（有值即隐藏） */
     hideWx?: string;
+    /**
+     * 登录卡片布局
+     * - "default": 右侧（桌面）/居中（移动）
+     * - "center": 始终居中
+     * - "left": 左侧（桌面）/居中（移动）
+     */
     layout?: "default" | "center" | "left";
+    /**
+     * 是否隐藏注册入口
+     * - "0": 显示（默认）
+     * - "1": 隐藏
+     */
+    hideRegister?: "0" | "1";
+    /**
+     *  右上角 快捷导航 只有在默认模式时显示
+     */
+    links?: {
+        url: string;
+        name: string;
+    }[];
 }
 export declare const DEFAULT_CONFIG: AuthGatewayConfig;