@meng-xi/vite-plugin 0.0.7 → 0.0.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README-en.md +790 -404
- package/README.md +788 -403
- package/dist/index.cjs +1 -1
- package/dist/index.d.cts +1 -1
- package/dist/index.d.mts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.mjs +1 -1
- package/dist/plugins/index.cjs +1 -1
- package/dist/plugins/index.d.cts +764 -2
- package/dist/plugins/index.d.mts +764 -2
- package/dist/plugins/index.d.ts +764 -2
- package/dist/plugins/index.mjs +1 -1
- package/dist/shared/vite-plugin.BI4kA-bR.mjs +526 -0
- package/dist/shared/vite-plugin.CsdNNQ-4.cjs +526 -0
- package/package.json +72 -72
- package/dist/shared/vite-plugin.CIahO6bu.mjs +0 -37
- package/dist/shared/vite-plugin.DqgHJjxa.cjs +0 -37
package/dist/plugins/index.d.ts
CHANGED
|
@@ -756,5 +756,767 @@ interface InjectIcoOptions extends BasePluginOptions {
|
|
|
756
756
|
*/
|
|
757
757
|
declare const injectIco: PluginFactory<InjectIcoOptions, string | InjectIcoOptions>;
|
|
758
758
|
|
|
759
|
-
|
|
760
|
-
|
|
759
|
+
/**
|
|
760
|
+
* Loading 组件的显示位置
|
|
761
|
+
*
|
|
762
|
+
* @remarks 控制加载指示器在视口中的垂直对齐方式
|
|
763
|
+
*
|
|
764
|
+
* @defaultValue `'center'`
|
|
765
|
+
*
|
|
766
|
+
* @example
|
|
767
|
+
* ```typescript
|
|
768
|
+
* injectLoading({ position: 'top' })
|
|
769
|
+
* ```
|
|
770
|
+
*/
|
|
771
|
+
type LoadingPosition = 'center' | 'top' | 'bottom';
|
|
772
|
+
/**
|
|
773
|
+
* Loading 自动绑定请求拦截的模式
|
|
774
|
+
*
|
|
775
|
+
* @remarks 决定插件自动拦截哪些类型的网络请求来管理 loading 状态
|
|
776
|
+
*
|
|
777
|
+
* @defaultValue `'none'`
|
|
778
|
+
*
|
|
779
|
+
* @example
|
|
780
|
+
* ```typescript
|
|
781
|
+
* // 自动拦截所有 fetch 请求
|
|
782
|
+
* injectLoading({ autoBind: 'fetch' })
|
|
783
|
+
* ```
|
|
784
|
+
*/
|
|
785
|
+
type AutoBindMode = 'fetch' | 'xhr' | 'all' | 'none';
|
|
786
|
+
/**
|
|
787
|
+
* Loading 旋转图标的内置类型
|
|
788
|
+
*
|
|
789
|
+
* @remarks 提供四种内置加载动画,无需自定义 CSS 即可使用
|
|
790
|
+
*
|
|
791
|
+
* @defaultValue `'spinner'`
|
|
792
|
+
*
|
|
793
|
+
* @example
|
|
794
|
+
* ```typescript
|
|
795
|
+
* injectLoading({ spinnerType: 'dots' })
|
|
796
|
+
* ```
|
|
797
|
+
*/
|
|
798
|
+
type SpinnerType = 'spinner' | 'dots' | 'pulse' | 'bar';
|
|
799
|
+
/**
|
|
800
|
+
* 当 `defaultVisible` 为 `true` 时,loading 的自动隐藏时机
|
|
801
|
+
*
|
|
802
|
+
* @remarks 仅在 {@link InjectLoadingOptions.defaultVisible} 为 `true` 时生效,
|
|
803
|
+
* 决定 loading 在页面加载过程中的自动隐藏策略
|
|
804
|
+
*
|
|
805
|
+
* @defaultValue `'DOMContentLoaded'`
|
|
806
|
+
*
|
|
807
|
+
* @example
|
|
808
|
+
* ```typescript
|
|
809
|
+
* // Vue/React SPA:手动控制隐藏时机
|
|
810
|
+
* injectLoading({ defaultVisible: true, autoHideOn: 'manual' })
|
|
811
|
+
* // 在应用入口:window.__LOADING_MANAGER__.hide()
|
|
812
|
+
* ```
|
|
813
|
+
*/
|
|
814
|
+
type AutoHideOn = 'DOMContentLoaded' | 'load' | 'manual';
|
|
815
|
+
/**
|
|
816
|
+
* Loading 过渡动画配置
|
|
817
|
+
*
|
|
818
|
+
* @remarks 控制 loading 显示/隐藏时的 CSS 过渡效果
|
|
819
|
+
*/
|
|
820
|
+
interface TransitionConfig {
|
|
821
|
+
/**
|
|
822
|
+
* 是否启用过渡动画
|
|
823
|
+
*
|
|
824
|
+
* @defaultValue `true`
|
|
825
|
+
*/
|
|
826
|
+
enabled?: boolean;
|
|
827
|
+
/**
|
|
828
|
+
* 过渡动画持续时间(毫秒)
|
|
829
|
+
*
|
|
830
|
+
* @defaultValue `200`
|
|
831
|
+
*
|
|
832
|
+
* @throws 配置验证时若为负数将抛出错误
|
|
833
|
+
*/
|
|
834
|
+
duration?: number;
|
|
835
|
+
/**
|
|
836
|
+
* CSS 过渡缓动函数
|
|
837
|
+
*
|
|
838
|
+
* @defaultValue `'ease-out'`
|
|
839
|
+
*
|
|
840
|
+
* @example
|
|
841
|
+
* ```typescript
|
|
842
|
+
* { easing: 'cubic-bezier(0.4, 0, 0.2, 1)' }
|
|
843
|
+
* ```
|
|
844
|
+
*/
|
|
845
|
+
easing?: string;
|
|
846
|
+
}
|
|
847
|
+
/**
|
|
848
|
+
* Loading 自定义样式配置
|
|
849
|
+
*
|
|
850
|
+
* @remarks 控制 loading 遮罩层、图标和文本的视觉表现
|
|
851
|
+
*/
|
|
852
|
+
interface LoadingStyle {
|
|
853
|
+
/**
|
|
854
|
+
* 遮罩层背景色(CSS 颜色值)
|
|
855
|
+
*
|
|
856
|
+
* @defaultValue `'rgba(255, 255, 255, 0.7)'`
|
|
857
|
+
*/
|
|
858
|
+
overlayColor?: string;
|
|
859
|
+
/**
|
|
860
|
+
* Loading 图标颜色(CSS 颜色值)
|
|
861
|
+
*
|
|
862
|
+
* @defaultValue `'#4361ee'`
|
|
863
|
+
*/
|
|
864
|
+
spinnerColor?: string;
|
|
865
|
+
/**
|
|
866
|
+
* Loading 图标大小(CSS 长度值)
|
|
867
|
+
*
|
|
868
|
+
* @defaultValue `'40px'`
|
|
869
|
+
*/
|
|
870
|
+
spinnerSize?: string;
|
|
871
|
+
/**
|
|
872
|
+
* 文本颜色(CSS 颜色值)
|
|
873
|
+
*
|
|
874
|
+
* @defaultValue `'#333'`
|
|
875
|
+
*/
|
|
876
|
+
textColor?: string;
|
|
877
|
+
/**
|
|
878
|
+
* 文本大小(CSS 长度值)
|
|
879
|
+
*
|
|
880
|
+
* @defaultValue `'14px'`
|
|
881
|
+
*/
|
|
882
|
+
textSize?: string;
|
|
883
|
+
/**
|
|
884
|
+
* 自定义 CSS 类名,附加到 overlay 元素上
|
|
885
|
+
*
|
|
886
|
+
* @remarks 可用于覆盖默认样式或添加额外样式
|
|
887
|
+
*/
|
|
888
|
+
customClass?: string;
|
|
889
|
+
/**
|
|
890
|
+
* 自定义内联样式字符串,附加到 overlay 元素上
|
|
891
|
+
*
|
|
892
|
+
* @remarks 将作为 `style` 属性值直接注入
|
|
893
|
+
*/
|
|
894
|
+
customStyle?: string;
|
|
895
|
+
/**
|
|
896
|
+
* 遮罩层 z-index 值
|
|
897
|
+
*
|
|
898
|
+
* @defaultValue `9999`
|
|
899
|
+
*
|
|
900
|
+
* @throws 配置验证时若为负数将抛出错误
|
|
901
|
+
*/
|
|
902
|
+
zIndex?: number;
|
|
903
|
+
/**
|
|
904
|
+
* 是否启用遮罩层的指针事件
|
|
905
|
+
*
|
|
906
|
+
* @remarks
|
|
907
|
+
* 对应 CSS `pointer-events` 属性,控制遮罩层是否拦截用户的点击、滚动等交互操作:
|
|
908
|
+
* - `true`(默认):启用指针事件(`pointer-events: auto`),遮罩层阻止所有交互
|
|
909
|
+
* - `false`:禁用指针事件(`pointer-events: none`),遮罩层允许交互穿透
|
|
910
|
+
*
|
|
911
|
+
* @defaultValue `true`
|
|
912
|
+
*
|
|
913
|
+
* @example
|
|
914
|
+
* ```typescript
|
|
915
|
+
* // 阻止交互(默认行为)
|
|
916
|
+
* injectLoading({ style: { pointerEvents: true } })
|
|
917
|
+
*
|
|
918
|
+
* // 允许交互穿透(如仅展示加载状态,不阻止操作)
|
|
919
|
+
* injectLoading({ style: { pointerEvents: false } })
|
|
920
|
+
* ```
|
|
921
|
+
*/
|
|
922
|
+
pointerEvents?: boolean;
|
|
923
|
+
/**
|
|
924
|
+
* 是否启用 backdrop-filter 模糊效果
|
|
925
|
+
*
|
|
926
|
+
* @remarks 启用后遮罩层下方的页面内容将被高斯模糊处理,
|
|
927
|
+
* 需要浏览器支持 `backdrop-filter` CSS 属性
|
|
928
|
+
*
|
|
929
|
+
* @defaultValue `false`
|
|
930
|
+
*/
|
|
931
|
+
backdropBlur?: boolean;
|
|
932
|
+
/**
|
|
933
|
+
* backdrop-filter 模糊程度(单位:px)
|
|
934
|
+
*
|
|
935
|
+
* @remarks 仅在 {@link backdropBlur} 为 `true` 时生效
|
|
936
|
+
*
|
|
937
|
+
* @defaultValue `4`
|
|
938
|
+
*
|
|
939
|
+
* @throws 配置验证时若为负数将抛出错误
|
|
940
|
+
*/
|
|
941
|
+
backdropBlurAmount?: number;
|
|
942
|
+
}
|
|
943
|
+
/**
|
|
944
|
+
* Loading 最小显示时间配置
|
|
945
|
+
*
|
|
946
|
+
* @remarks 确保 loading 至少显示指定时长,避免快速闪烁
|
|
947
|
+
*/
|
|
948
|
+
interface MinDisplayTime {
|
|
949
|
+
/**
|
|
950
|
+
* 是否启用最小显示时间
|
|
951
|
+
*
|
|
952
|
+
* @defaultValue `true`
|
|
953
|
+
*/
|
|
954
|
+
enabled?: boolean;
|
|
955
|
+
/**
|
|
956
|
+
* 最小显示时间(毫秒)
|
|
957
|
+
*
|
|
958
|
+
* @remarks 即使请求在更短时间内完成,loading 也会至少显示此时长
|
|
959
|
+
*
|
|
960
|
+
* @defaultValue `300`
|
|
961
|
+
*
|
|
962
|
+
* @throws 配置验证时若为负数将抛出错误
|
|
963
|
+
*/
|
|
964
|
+
duration?: number;
|
|
965
|
+
}
|
|
966
|
+
/**
|
|
967
|
+
* Loading 延迟显示配置
|
|
968
|
+
*
|
|
969
|
+
* @remarks 当请求在短时间内完成时,延迟显示可避免 loading 闪烁
|
|
970
|
+
*/
|
|
971
|
+
interface DelayShow {
|
|
972
|
+
/**
|
|
973
|
+
* 是否启用延迟显示
|
|
974
|
+
*
|
|
975
|
+
* @defaultValue `true`
|
|
976
|
+
*/
|
|
977
|
+
enabled?: boolean;
|
|
978
|
+
/**
|
|
979
|
+
* 延迟时间(毫秒)
|
|
980
|
+
*
|
|
981
|
+
* @remarks 请求开始后等待此时长再显示 loading;
|
|
982
|
+
* 若请求在此时间内完成,则不会显示 loading
|
|
983
|
+
*
|
|
984
|
+
* @defaultValue `200`
|
|
985
|
+
*
|
|
986
|
+
* @throws 配置验证时若为负数将抛出错误
|
|
987
|
+
*/
|
|
988
|
+
duration?: number;
|
|
989
|
+
}
|
|
990
|
+
/**
|
|
991
|
+
* Loading 防抖隐藏配置
|
|
992
|
+
*
|
|
993
|
+
* @remarks 当频繁触发 hide 操作时,延迟执行以避免 loading 闪烁
|
|
994
|
+
*/
|
|
995
|
+
interface DebounceHide {
|
|
996
|
+
/**
|
|
997
|
+
* 是否启用防抖隐藏
|
|
998
|
+
*
|
|
999
|
+
* @defaultValue `false`
|
|
1000
|
+
*/
|
|
1001
|
+
enabled?: boolean;
|
|
1002
|
+
/**
|
|
1003
|
+
* 防抖等待时间(毫秒)
|
|
1004
|
+
*
|
|
1005
|
+
* @remarks 在最后一次 hide 调用后等待此时长再执行隐藏
|
|
1006
|
+
*
|
|
1007
|
+
* @defaultValue `100`
|
|
1008
|
+
*
|
|
1009
|
+
* @throws 配置验证时若为负数将抛出错误
|
|
1010
|
+
*/
|
|
1011
|
+
duration?: number;
|
|
1012
|
+
}
|
|
1013
|
+
/**
|
|
1014
|
+
* Loading 请求过滤配置
|
|
1015
|
+
*
|
|
1016
|
+
* @remarks 用于精细控制哪些网络请求会触发 loading 状态变化
|
|
1017
|
+
*/
|
|
1018
|
+
interface RequestFilter {
|
|
1019
|
+
/**
|
|
1020
|
+
* 需要排除的 URL 正则表达式数组
|
|
1021
|
+
*
|
|
1022
|
+
* @remarks 匹配的 URL 不会触发 loading
|
|
1023
|
+
*
|
|
1024
|
+
* @example
|
|
1025
|
+
* ```typescript
|
|
1026
|
+
* { excludeUrls: [/\/api\/health/, /\/static\//] }
|
|
1027
|
+
* ```
|
|
1028
|
+
*/
|
|
1029
|
+
excludeUrls?: RegExp[];
|
|
1030
|
+
/**
|
|
1031
|
+
* 需要包含的 URL 正则表达式数组
|
|
1032
|
+
*
|
|
1033
|
+
* @remarks 仅匹配的 URL 才会触发 loading。
|
|
1034
|
+
* 与 {@link excludeUrls} 互斥,{@link includeUrls} 优先级更高
|
|
1035
|
+
*
|
|
1036
|
+
* @example
|
|
1037
|
+
* ```typescript
|
|
1038
|
+
* { includeUrls: [/\/api\/data/] }
|
|
1039
|
+
* ```
|
|
1040
|
+
*/
|
|
1041
|
+
includeUrls?: RegExp[];
|
|
1042
|
+
/**
|
|
1043
|
+
* 需要排除的 HTTP 方法数组(不区分大小写)
|
|
1044
|
+
*
|
|
1045
|
+
* @example
|
|
1046
|
+
* ```typescript
|
|
1047
|
+
* { excludeMethods: ['OPTIONS', 'HEAD'] }
|
|
1048
|
+
* ```
|
|
1049
|
+
*/
|
|
1050
|
+
excludeMethods?: string[];
|
|
1051
|
+
/**
|
|
1052
|
+
* 需要排除的 URL 字符串前缀数组
|
|
1053
|
+
*
|
|
1054
|
+
* @remarks 使用前缀匹配(`indexOf === 0`),比正则更高效
|
|
1055
|
+
*
|
|
1056
|
+
* @example
|
|
1057
|
+
* ```typescript
|
|
1058
|
+
* { excludeUrlPrefixes: ['http://localhost', 'data:'] }
|
|
1059
|
+
* ```
|
|
1060
|
+
*/
|
|
1061
|
+
excludeUrlPrefixes?: string[];
|
|
1062
|
+
}
|
|
1063
|
+
/**
|
|
1064
|
+
* Loading 生命周期回调
|
|
1065
|
+
*
|
|
1066
|
+
* @remarks 回调以 **函数体字符串** 形式提供,因为插件在构建时注入代码到浏览器端,
|
|
1067
|
+
* 无法直接传递函数引用。字符串应为有效的 JavaScript 函数体代码。
|
|
1068
|
+
*/
|
|
1069
|
+
interface LoadingCallbacks {
|
|
1070
|
+
/**
|
|
1071
|
+
* Loading 显示前的回调
|
|
1072
|
+
*
|
|
1073
|
+
* @remarks 函数体内 `return false` 可阻止显示
|
|
1074
|
+
*
|
|
1075
|
+
* @example
|
|
1076
|
+
* ```typescript
|
|
1077
|
+
* { onBeforeShow: 'if (someCondition) return false;' }
|
|
1078
|
+
* ```
|
|
1079
|
+
*/
|
|
1080
|
+
onBeforeShow?: string;
|
|
1081
|
+
/**
|
|
1082
|
+
* Loading 显示后的回调
|
|
1083
|
+
*
|
|
1084
|
+
* @example
|
|
1085
|
+
* ```typescript
|
|
1086
|
+
* { onShow: 'console.log("loading shown")' }
|
|
1087
|
+
* ```
|
|
1088
|
+
*/
|
|
1089
|
+
onShow?: string;
|
|
1090
|
+
/**
|
|
1091
|
+
* Loading 隐藏前的回调
|
|
1092
|
+
*
|
|
1093
|
+
* @remarks 函数体内 `return false` 可阻止隐藏
|
|
1094
|
+
*
|
|
1095
|
+
* @example
|
|
1096
|
+
* ```typescript
|
|
1097
|
+
* { onBeforeHide: 'if (shouldKeepVisible) return false;' }
|
|
1098
|
+
* ```
|
|
1099
|
+
*/
|
|
1100
|
+
onBeforeHide?: string;
|
|
1101
|
+
/**
|
|
1102
|
+
* Loading 隐藏后的回调
|
|
1103
|
+
*
|
|
1104
|
+
* @example
|
|
1105
|
+
* ```typescript
|
|
1106
|
+
* { onHide: 'console.log("loading hidden")' }
|
|
1107
|
+
* ```
|
|
1108
|
+
*/
|
|
1109
|
+
onHide?: string;
|
|
1110
|
+
/**
|
|
1111
|
+
* Loading 销毁时的回调
|
|
1112
|
+
*
|
|
1113
|
+
* @remarks 在 DOM 清理和拦截器恢复之后执行
|
|
1114
|
+
*/
|
|
1115
|
+
onDestroy?: string;
|
|
1116
|
+
}
|
|
1117
|
+
/**
|
|
1118
|
+
* Loading 管理器实例接口
|
|
1119
|
+
*
|
|
1120
|
+
* @remarks 注入到浏览器全局变量(默认 `window.__LOADING_MANAGER__`),
|
|
1121
|
+
* 提供运行时 loading 状态控制方法
|
|
1122
|
+
*/
|
|
1123
|
+
interface LoadingManager {
|
|
1124
|
+
/**
|
|
1125
|
+
* 显示 loading
|
|
1126
|
+
*
|
|
1127
|
+
* @param text - 可选,显示的文本内容;不传则保留默认文本
|
|
1128
|
+
*
|
|
1129
|
+
* @example
|
|
1130
|
+
* ```typescript
|
|
1131
|
+
* window.__LOADING_MANAGER__.show()
|
|
1132
|
+
* window.__LOADING_MANAGER__.show('正在保存...')
|
|
1133
|
+
* ```
|
|
1134
|
+
*/
|
|
1135
|
+
show(text?: string): void;
|
|
1136
|
+
/**
|
|
1137
|
+
* 隐藏 loading
|
|
1138
|
+
*
|
|
1139
|
+
* @remarks 受 {@link MinDisplayTime} 和 {@link DebounceHide} 配置约束;
|
|
1140
|
+
* 若需忽略这些约束,请使用 {@link forceHide}
|
|
1141
|
+
*/
|
|
1142
|
+
hide(): void;
|
|
1143
|
+
/**
|
|
1144
|
+
* 强制隐藏 loading,忽略最小显示时间和防抖隐藏
|
|
1145
|
+
*
|
|
1146
|
+
* @remarks 适用于需要立即隐藏 loading 的紧急场景
|
|
1147
|
+
*/
|
|
1148
|
+
forceHide(): void;
|
|
1149
|
+
/**
|
|
1150
|
+
* 切换 loading 的显示/隐藏状态
|
|
1151
|
+
*
|
|
1152
|
+
* @remarks 如果当前显示则调用 {@link hide},如果当前隐藏则调用 {@link show}
|
|
1153
|
+
*
|
|
1154
|
+
* @param text - 可选,切换为显示时的文本内容;不传则保留默认文本
|
|
1155
|
+
*
|
|
1156
|
+
* @example
|
|
1157
|
+
* ```typescript
|
|
1158
|
+
* window.__LOADING_MANAGER__.toggle()
|
|
1159
|
+
* window.__LOADING_MANAGER__.toggle('正在加载...')
|
|
1160
|
+
* ```
|
|
1161
|
+
*/
|
|
1162
|
+
toggle(text?: string): void;
|
|
1163
|
+
/**
|
|
1164
|
+
* 启用遮罩层的指针事件,拦截所有点击和滚动操作
|
|
1165
|
+
*
|
|
1166
|
+
* @remarks 设置遮罩层的 `pointer-events: auto`,恢复默认的交互拦截行为。
|
|
1167
|
+
* 适用于运行时动态启用交互阻止,例如在特定操作期间临时锁定页面
|
|
1168
|
+
*
|
|
1169
|
+
* @example
|
|
1170
|
+
* ```typescript
|
|
1171
|
+
* window.__LOADING_MANAGER__.enablePointerEvents()
|
|
1172
|
+
* ```
|
|
1173
|
+
*/
|
|
1174
|
+
enablePointerEvents(): void;
|
|
1175
|
+
/**
|
|
1176
|
+
* 禁用遮罩层的指针事件,允许交互穿透
|
|
1177
|
+
*
|
|
1178
|
+
* @remarks 设置遮罩层的 `pointer-events: none`,使鼠标事件穿透到下层元素。
|
|
1179
|
+
* 适用于运行时动态禁用交互阻止,例如需要用户在 loading 期间仍能操作页面
|
|
1180
|
+
*
|
|
1181
|
+
* @example
|
|
1182
|
+
* ```typescript
|
|
1183
|
+
* window.__LOADING_MANAGER__.disablePointerEvents()
|
|
1184
|
+
* ```
|
|
1185
|
+
*/
|
|
1186
|
+
disablePointerEvents(): void;
|
|
1187
|
+
/**
|
|
1188
|
+
* 切换遮罩层的指针事件状态
|
|
1189
|
+
*
|
|
1190
|
+
* @remarks 如果当前启用指针事件则调用 {@link disablePointerEvents},如果当前禁用则调用 {@link enablePointerEvents}
|
|
1191
|
+
*
|
|
1192
|
+
* @example
|
|
1193
|
+
* ```typescript
|
|
1194
|
+
* window.__LOADING_MANAGER__.togglePointerEvents()
|
|
1195
|
+
* ```
|
|
1196
|
+
*/
|
|
1197
|
+
togglePointerEvents(): void;
|
|
1198
|
+
/**
|
|
1199
|
+
* 更新 loading 文本内容
|
|
1200
|
+
*
|
|
1201
|
+
* @param text - 新的文本内容
|
|
1202
|
+
*
|
|
1203
|
+
* @example
|
|
1204
|
+
* ```typescript
|
|
1205
|
+
* window.__LOADING_MANAGER__.updateText('正在处理数据...')
|
|
1206
|
+
* ```
|
|
1207
|
+
*/
|
|
1208
|
+
updateText(text: string): void;
|
|
1209
|
+
/**
|
|
1210
|
+
* 获取当前 loading 是否正在显示
|
|
1211
|
+
*
|
|
1212
|
+
* @returns `true` 表示 loading 正在显示且未被销毁
|
|
1213
|
+
*/
|
|
1214
|
+
isVisible(): boolean;
|
|
1215
|
+
/**
|
|
1216
|
+
* 获取当前遮罩层是否启用了指针事件
|
|
1217
|
+
*
|
|
1218
|
+
* @returns `true` 表示指针事件已启用(遮罩层拦截交互),`false` 表示已禁用(允许穿透)
|
|
1219
|
+
*/
|
|
1220
|
+
isPointerEventsEnabled(): boolean;
|
|
1221
|
+
/**
|
|
1222
|
+
* 获取当前挂起的请求数量
|
|
1223
|
+
*
|
|
1224
|
+
* @returns 当前正在进行的、被拦截的请求数量
|
|
1225
|
+
*/
|
|
1226
|
+
getPendingCount(): number;
|
|
1227
|
+
/**
|
|
1228
|
+
* 销毁 loading 实例
|
|
1229
|
+
*
|
|
1230
|
+
* @remarks 清理 DOM 元素、事件监听器,并恢复原始的 fetch/XHR 拦截。
|
|
1231
|
+
* 销毁后所有其他方法调用将被安全忽略
|
|
1232
|
+
*/
|
|
1233
|
+
destroy(): void;
|
|
1234
|
+
}
|
|
1235
|
+
/**
|
|
1236
|
+
* injectLoading 插件的配置选项
|
|
1237
|
+
*
|
|
1238
|
+
* @remarks 继承自 {@link BasePluginOptions},包含 loading 的所有可配置项
|
|
1239
|
+
*/
|
|
1240
|
+
interface InjectLoadingOptions extends BasePluginOptions {
|
|
1241
|
+
/**
|
|
1242
|
+
* Loading 显示位置
|
|
1243
|
+
*
|
|
1244
|
+
* @defaultValue `'center'`
|
|
1245
|
+
*/
|
|
1246
|
+
position?: LoadingPosition;
|
|
1247
|
+
/**
|
|
1248
|
+
* 默认显示文本
|
|
1249
|
+
*
|
|
1250
|
+
* @defaultValue `'加载中...'`
|
|
1251
|
+
*/
|
|
1252
|
+
defaultText?: string;
|
|
1253
|
+
/**
|
|
1254
|
+
* 旋转图标类型
|
|
1255
|
+
*
|
|
1256
|
+
* @defaultValue `'spinner'`
|
|
1257
|
+
*/
|
|
1258
|
+
spinnerType?: SpinnerType;
|
|
1259
|
+
/**
|
|
1260
|
+
* 自定义样式配置
|
|
1261
|
+
*
|
|
1262
|
+
* @remarks 详见 {@link LoadingStyle}
|
|
1263
|
+
*/
|
|
1264
|
+
style?: LoadingStyle;
|
|
1265
|
+
/**
|
|
1266
|
+
* 过渡动画配置
|
|
1267
|
+
*
|
|
1268
|
+
* @defaultValue `{ enabled: true, duration: 200, easing: 'ease-out' }`
|
|
1269
|
+
*/
|
|
1270
|
+
transition?: TransitionConfig;
|
|
1271
|
+
/**
|
|
1272
|
+
* 最小显示时间配置
|
|
1273
|
+
*
|
|
1274
|
+
* @remarks 详见 {@link MinDisplayTime}
|
|
1275
|
+
*/
|
|
1276
|
+
minDisplayTime?: MinDisplayTime;
|
|
1277
|
+
/**
|
|
1278
|
+
* 延迟显示配置
|
|
1279
|
+
*
|
|
1280
|
+
* @remarks 详见 {@link DelayShow}
|
|
1281
|
+
*/
|
|
1282
|
+
delayShow?: DelayShow;
|
|
1283
|
+
/**
|
|
1284
|
+
* 防抖隐藏配置
|
|
1285
|
+
*
|
|
1286
|
+
* @remarks 详见 {@link DebounceHide}
|
|
1287
|
+
*/
|
|
1288
|
+
debounceHide?: DebounceHide;
|
|
1289
|
+
/**
|
|
1290
|
+
* 自动绑定请求拦截模式
|
|
1291
|
+
*
|
|
1292
|
+
* @defaultValue `'none'`
|
|
1293
|
+
*/
|
|
1294
|
+
autoBind?: AutoBindMode;
|
|
1295
|
+
/**
|
|
1296
|
+
* 请求过滤配置
|
|
1297
|
+
*
|
|
1298
|
+
* @remarks 详见 {@link RequestFilter}
|
|
1299
|
+
*/
|
|
1300
|
+
requestFilter?: RequestFilter;
|
|
1301
|
+
/**
|
|
1302
|
+
* 注入到浏览器全局的变量名
|
|
1303
|
+
*
|
|
1304
|
+
* @defaultValue `'__LOADING_MANAGER__'`
|
|
1305
|
+
*
|
|
1306
|
+
* @example
|
|
1307
|
+
* ```typescript
|
|
1308
|
+
* injectLoading({ globalName: '__MY_LOADING__' })
|
|
1309
|
+
* // 使用:window.__MY_LOADING__.show()
|
|
1310
|
+
* ```
|
|
1311
|
+
*/
|
|
1312
|
+
globalName?: string;
|
|
1313
|
+
/**
|
|
1314
|
+
* 自定义 Loading HTML 模板
|
|
1315
|
+
*
|
|
1316
|
+
* @remarks 如果提供,将替代默认的 loading 模板。
|
|
1317
|
+
* 模板中 **必须** 包含一个具有 `data-loading-text` 属性的元素用于文本显示,
|
|
1318
|
+
* 否则 {@link LoadingManager.updateText} 将无法工作
|
|
1319
|
+
*
|
|
1320
|
+
* @example
|
|
1321
|
+
* ```typescript
|
|
1322
|
+
* injectLoading({
|
|
1323
|
+
* customTemplate: '<div class="my-loader"><span data-loading-text></span></div>'
|
|
1324
|
+
* })
|
|
1325
|
+
* ```
|
|
1326
|
+
*/
|
|
1327
|
+
customTemplate?: string;
|
|
1328
|
+
/**
|
|
1329
|
+
* Loading DOM 的初始可见状态
|
|
1330
|
+
*
|
|
1331
|
+
* @defaultValue `false`
|
|
1332
|
+
*
|
|
1333
|
+
* @remarks
|
|
1334
|
+
* 设为 `true` 时,loading DOM 以可见状态注入到 HTML 的 `<head>` 中,
|
|
1335
|
+
* 无需等待 JS 执行即可在白屏阶段显示 loading。
|
|
1336
|
+
*
|
|
1337
|
+
* 典型用法:配合 {@link autoHideOn} 使用,实现"白屏时显示 → 页面就绪后自动隐藏"。
|
|
1338
|
+
*
|
|
1339
|
+
* @example
|
|
1340
|
+
* ```typescript
|
|
1341
|
+
* // 白屏阶段即显示 loading,DOMContentLoaded 后自动隐藏
|
|
1342
|
+
* injectLoading({ defaultVisible: true, autoHideOn: 'DOMContentLoaded' })
|
|
1343
|
+
*
|
|
1344
|
+
* // 白屏阶段即显示 loading,所有资源加载完成后自动隐藏
|
|
1345
|
+
* injectLoading({ defaultVisible: true, autoHideOn: 'load' })
|
|
1346
|
+
*
|
|
1347
|
+
* // Vue/React SPA:白屏阶段即显示,框架渲染完成后手动隐藏
|
|
1348
|
+
* injectLoading({ defaultVisible: true, autoHideOn: 'manual' })
|
|
1349
|
+
* // 在应用入口处:window.__LOADING_MANAGER__.hide()
|
|
1350
|
+
* ```
|
|
1351
|
+
*/
|
|
1352
|
+
defaultVisible?: boolean;
|
|
1353
|
+
/**
|
|
1354
|
+
* 当 `defaultVisible` 为 `true` 时,loading 的自动隐藏时机
|
|
1355
|
+
*
|
|
1356
|
+
* @defaultValue `'DOMContentLoaded'`
|
|
1357
|
+
*
|
|
1358
|
+
* @remarks 仅在 {@link defaultVisible} 为 `true` 时生效:
|
|
1359
|
+
* - `'DOMContentLoaded'` — DOM 解析完成后自动隐藏(适合 SSR/MPA)
|
|
1360
|
+
* - `'load'` — 所有资源(图片、样式等)加载完成后自动隐藏(适合资源较重的页面)
|
|
1361
|
+
* - `'manual'` — 不自动隐藏,需在应用代码中手动调用 `window.__LOADING_MANAGER__.hide()`
|
|
1362
|
+
* (适合 Vue/React SPA,在框架渲染完成后手动隐藏)
|
|
1363
|
+
*/
|
|
1364
|
+
autoHideOn?: AutoHideOn;
|
|
1365
|
+
/**
|
|
1366
|
+
* 生命周期回调
|
|
1367
|
+
*
|
|
1368
|
+
* @remarks 回调以函数体字符串形式提供,在运行时执行。
|
|
1369
|
+
* 详见 {@link LoadingCallbacks}
|
|
1370
|
+
*
|
|
1371
|
+
* @example
|
|
1372
|
+
* ```typescript
|
|
1373
|
+
* injectLoading({
|
|
1374
|
+
* callbacks: {
|
|
1375
|
+
* onShow: 'console.log("loading shown")',
|
|
1376
|
+
* onBeforeShow: 'return true'
|
|
1377
|
+
* }
|
|
1378
|
+
* })
|
|
1379
|
+
* ```
|
|
1380
|
+
*/
|
|
1381
|
+
callbacks?: LoadingCallbacks;
|
|
1382
|
+
}
|
|
1383
|
+
|
|
1384
|
+
/**
|
|
1385
|
+
* 注入全局 Loading 状态管理插件
|
|
1386
|
+
*
|
|
1387
|
+
* @param options - 插件配置选项,详见 {@link InjectLoadingOptions}
|
|
1388
|
+
* @returns Vite 插件实例
|
|
1389
|
+
*
|
|
1390
|
+
* @example
|
|
1391
|
+
* ```typescript
|
|
1392
|
+
* // 基本使用
|
|
1393
|
+
* injectLoading()
|
|
1394
|
+
*
|
|
1395
|
+
* // 自定义位置和文本
|
|
1396
|
+
* injectLoading({
|
|
1397
|
+
* position: 'top',
|
|
1398
|
+
* defaultText: '请稍候...'
|
|
1399
|
+
* })
|
|
1400
|
+
*
|
|
1401
|
+
* // 使用不同类型的加载图标
|
|
1402
|
+
* injectLoading({
|
|
1403
|
+
* spinnerType: 'dots', // spinner | dots | pulse | bar
|
|
1404
|
+
* })
|
|
1405
|
+
*
|
|
1406
|
+
* // 自动拦截 fetch 请求
|
|
1407
|
+
* injectLoading({
|
|
1408
|
+
* autoBind: 'fetch',
|
|
1409
|
+
* requestFilter: {
|
|
1410
|
+
* excludeUrls: [/\/api\/health/],
|
|
1411
|
+
* excludeUrlPrefixes: ['http://localhost']
|
|
1412
|
+
* }
|
|
1413
|
+
* })
|
|
1414
|
+
*
|
|
1415
|
+
* // 自定义样式(含模糊背景)
|
|
1416
|
+
* injectLoading({
|
|
1417
|
+
* style: {
|
|
1418
|
+
* overlayColor: 'rgba(0, 0, 0, 0.5)',
|
|
1419
|
+
* spinnerColor: '#ff6b6b',
|
|
1420
|
+
* spinnerSize: '50px',
|
|
1421
|
+
* backdropBlur: true,
|
|
1422
|
+
* backdropBlurAmount: 6
|
|
1423
|
+
* }
|
|
1424
|
+
* })
|
|
1425
|
+
*
|
|
1426
|
+
* // 自定义过渡动画
|
|
1427
|
+
* injectLoading({
|
|
1428
|
+
* transition: {
|
|
1429
|
+
* enabled: true,
|
|
1430
|
+
* duration: 300,
|
|
1431
|
+
* easing: 'cubic-bezier(0.4, 0, 0.2, 1)'
|
|
1432
|
+
* }
|
|
1433
|
+
* })
|
|
1434
|
+
*
|
|
1435
|
+
* // 防抖隐藏(避免快速闪烁)
|
|
1436
|
+
* injectLoading({
|
|
1437
|
+
* debounceHide: {
|
|
1438
|
+
* enabled: true,
|
|
1439
|
+
* duration: 100
|
|
1440
|
+
* }
|
|
1441
|
+
* })
|
|
1442
|
+
*
|
|
1443
|
+
* // 生命周期回调
|
|
1444
|
+
* injectLoading({
|
|
1445
|
+
* callbacks: {
|
|
1446
|
+
* onShow: 'console.log("loading shown")',
|
|
1447
|
+
* onBeforeShow: 'return true', // 返回 false 可阻止显示
|
|
1448
|
+
* onHide: 'console.log("loading hidden")'
|
|
1449
|
+
* }
|
|
1450
|
+
* })
|
|
1451
|
+
*
|
|
1452
|
+
* // 自定义模板
|
|
1453
|
+
* injectLoading({
|
|
1454
|
+
* customTemplate: '<div class="my-loader"><span data-loading-text></span></div>'
|
|
1455
|
+
* })
|
|
1456
|
+
*
|
|
1457
|
+
* // 白屏阶段即显示 loading,DOMContentLoaded 后自动隐藏
|
|
1458
|
+
* injectLoading({
|
|
1459
|
+
* defaultVisible: true,
|
|
1460
|
+
* autoHideOn: 'DOMContentLoaded'
|
|
1461
|
+
* })
|
|
1462
|
+
*
|
|
1463
|
+
* // 白屏阶段即显示 loading,所有资源加载完成后自动隐藏
|
|
1464
|
+
* injectLoading({
|
|
1465
|
+
* defaultVisible: true,
|
|
1466
|
+
* autoHideOn: 'load'
|
|
1467
|
+
* })
|
|
1468
|
+
*
|
|
1469
|
+
* // Vue/React SPA:白屏阶段即显示,框架渲染完成后手动隐藏
|
|
1470
|
+
* injectLoading({
|
|
1471
|
+
* defaultVisible: true,
|
|
1472
|
+
* autoHideOn: 'manual'
|
|
1473
|
+
* })
|
|
1474
|
+
* // 在应用入口处手动隐藏:
|
|
1475
|
+
* // window.__LOADING_MANAGER__.hide()
|
|
1476
|
+
* ```
|
|
1477
|
+
*
|
|
1478
|
+
* @remarks
|
|
1479
|
+
* 该插件在 HTML 中注入全局 Loading 状态管理代码,提供以下能力:
|
|
1480
|
+
* - 全局 loading 的创建、显示、隐藏和销毁
|
|
1481
|
+
* - 跨组件/页面共享 loading 状态
|
|
1482
|
+
* - 多种内置加载图标(spinner / dots / pulse / bar)
|
|
1483
|
+
* - 自定义样式、文本和显示位置
|
|
1484
|
+
* - 过渡动画配置(淡入淡出)
|
|
1485
|
+
* - 自动拦截 fetch/XHR 请求实现 loading 自动管理
|
|
1486
|
+
* - 延迟显示和最小显示时间机制
|
|
1487
|
+
* - 防抖隐藏避免闪烁
|
|
1488
|
+
* - 请求过滤(排除/包含特定 URL、前缀匹配、方法过滤)
|
|
1489
|
+
* - 生命周期回调(onBeforeShow / onShow / onBeforeHide / onHide / onDestroy)
|
|
1490
|
+
* - 背景模糊效果(backdrop-filter)
|
|
1491
|
+
* - 销毁时自动恢复原始 fetch/XHR
|
|
1492
|
+
* - SSR 环境安全检测
|
|
1493
|
+
* - 白屏阶段即显示 loading(defaultVisible + autoHideOn)
|
|
1494
|
+
*
|
|
1495
|
+
* 运行时 API:
|
|
1496
|
+
* ```typescript
|
|
1497
|
+
* // 显示 loading
|
|
1498
|
+
* window.__LOADING_MANAGER__.show('加载中...')
|
|
1499
|
+
*
|
|
1500
|
+
* // 隐藏 loading
|
|
1501
|
+
* window.__LOADING_MANAGER__.hide()
|
|
1502
|
+
*
|
|
1503
|
+
* // 强制隐藏(忽略最小显示时间)
|
|
1504
|
+
* window.__LOADING_MANAGER__.forceHide()
|
|
1505
|
+
*
|
|
1506
|
+
* // 更新文本
|
|
1507
|
+
* window.__LOADING_MANAGER__.updateText('正在处理...')
|
|
1508
|
+
*
|
|
1509
|
+
* // 检查状态
|
|
1510
|
+
* window.__LOADING_MANAGER__.isVisible()
|
|
1511
|
+
*
|
|
1512
|
+
* // 获取挂起请求数
|
|
1513
|
+
* window.__LOADING_MANAGER__.getPendingCount()
|
|
1514
|
+
*
|
|
1515
|
+
* // 销毁(恢复原始 fetch/XHR)
|
|
1516
|
+
* window.__LOADING_MANAGER__.destroy()
|
|
1517
|
+
* ```
|
|
1518
|
+
*/
|
|
1519
|
+
declare const injectLoading: PluginFactory<InjectLoadingOptions, InjectLoadingOptions>;
|
|
1520
|
+
|
|
1521
|
+
export { buildProgress, copyFile, generateRouter, generateVersion, injectIco, injectLoading };
|
|
1522
|
+
export type { AutoBindMode, AutoHideOn, BuildPhase, BuildProgressOptions, CopyFileOptions, DebounceHide, DelayShow, GenerateRouterOptions, GenerateVersionOptions, Icon, InjectIcoOptions, InjectLoadingOptions, LoadingCallbacks, LoadingManager, LoadingPosition, LoadingStyle, MinDisplayTime, NameStrategy, OutputFormat, OutputType, ProgressFormat, ProgressTheme, RequestFilter, RouteConfig, RouteMeta, SpinnerType, TransitionConfig, UniAppPageConfig, UniAppPagesJson, UniAppTabBarConfig, VersionFormat };
|