earthnut 0.1.5 → 0.1.7-alpha.0

package/customHooks/useRipples/buildBackground/utils/restore-css-background.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/buildBackground/utils/restore-css-background.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 import { Ripples } from '../../ripplesClass';
 /**
  * 恢复背景样式

package/customHooks/useRipples/callback/can-side.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/callback/can-side.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 import { Ripples } from '../ripplesClass';
 /**
  *  是否能执行渐变

package/customHooks/useRipples/callback/destroy.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/callback/destroy.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 import { Ripples } from '../ripplesClass';
 /**  注销  */
 export declare function destroy(this: Ripples): void;

package/customHooks/useRipples/callback/drop.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/callback/drop.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 import { Ripples } from '../ripplesClass';
 /**  触发滴落效果  */
 export declare function drop(this: Ripples, x: number, y: number, radius: number, strength: number): void;

package/customHooks/useRipples/callback/extract-url.d.ts

@@ -1,2 +1,8 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/callback/extract-url.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 /** 检测数据是否为 url 外联图像地址 */
 export declare function extractUrl(value: string): string | null;

package/customHooks/useRipples/callback/fade.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/callback/fade.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 import { Ripples } from '../ripplesClass';
 /**  两个图像间的淡入淡出  */
 export declare function fade(this: Ripples): any;

package/customHooks/useRipples/callback/get-new-image.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/callback/get-new-image.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 import { OriginStyle } from '../buildBackground/type';
 import { UseOptions } from '../rippersData/useOptions';
 /**  获取当前的背景图的地址  */

package/customHooks/useRipples/callback/reload-background.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/callback/reload-background.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 import { Ripples } from '../ripplesClass';
 /**
  * 重新加载背景图片

package/customHooks/useRipples/callback/scale.d.ts

@@ -1,2 +1,8 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/callback/scale.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 /**  缩放效果 （暂未用到） */
 export declare function scale(): void;

package/customHooks/useRipples/index.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/index.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 import { BackgroundRipplesProps, RippleImgUrl, RipplesOptions } from './types';
 import { Ripples } from './ripplesClass';
 /**
@@ -6,7 +12,7 @@ import { Ripples } from './ripplesClass';
  *
  *
  * @param canvas `usrRef` 包裹的 `HTMLCanvasElement`，用于绘制图像
- * @param props  初始化的
+ * @param option  初始化的
  * @version 0.0.3
  * @see  https://earthnut.dev/use-ripples
  * @see  JQuery https://github.com/sirxemic/jquery.ripples
@@ -36,5 +42,5 @@ import { Ripples } from './ripplesClass';
  * ```
  *
  */
-export declare function useRipples(canvas: React.RefObject<HTMLCanvasElement | null>, props?: BackgroundRipplesProps): React.RefObject<Ripples | null>;
+export declare function useRipples(canvas: React.RefObject<HTMLCanvasElement | null>, option?: RipplesOptions): React.RefObject<Ripples | null>;
 export type { Ripples, BackgroundRipplesProps, RipplesOptions, RippleImgUrl };

package/customHooks/useRipples/init/index.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/init/index.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 import { Ripples } from '../ripplesClass';
 /**
  * 初始化 webGL

package/customHooks/useRipples/init/initEvent.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/init/initEvent.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 import { Ripples } from '../ripplesClass';
 /**
  * 初始化事件

package/customHooks/useRipples/init/initShaders.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/init/initShaders.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 import { Ripples } from '../ripplesClass';
 /**
  *

package/customHooks/useRipples/init/initTexture.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/init/initTexture.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 import { Ripples } from '../ripplesClass';
 /**
  *

package/customHooks/useRipples/render/computeTextureBoundaries.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/render/computeTextureBoundaries.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 import { Ripples } from '../ripplesClass';
 /**  计算纹理边界及背景图  */
 export declare function computeTextureBoundaries(this: Ripples): void;

package/customHooks/useRipples/render/draw.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/render/draw.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 import { Ripples } from '../ripplesClass';
 /**
  *

package/customHooks/useRipples/render/drawQuad.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/render/drawQuad.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 import { Ripples } from '../ripplesClass';
 /**
  *

package/customHooks/useRipples/render/dropAtPointer.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/render/dropAtPointer.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 import { Ripples } from '../ripplesClass';
 /**
  *

package/customHooks/useRipples/render/index.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/render/index.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 import { Ripples } from '../ripplesClass';
 /**
  * 开启绘制

package/customHooks/useRipples/render/swapBufferIndices.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/render/swapBufferIndices.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 import { Ripples } from '../ripplesClass';
 /**
  * swap 缓冲区索引

package/customHooks/useRipples/render/update.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/render/update.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 import { Ripples } from '../ripplesClass';
 /**
  * 更新

package/customHooks/useRipples/rippersData/defaultData.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/rippersData/defaultData.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 import { RipplesDefaultData } from '../types';
 /**
  * 默认值

package/customHooks/useRipples/rippersData/fadeData.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/rippersData/fadeData.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 import { Ripples } from '../ripplesClass';
 export type DrawImage = {
     /**  资源  */

package/customHooks/useRipples/rippersData/index.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/rippersData/index.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 /****************************************************************************
  * @Author earthnut
  * @Email earthnut.dev@outlook.com

package/customHooks/useRipples/rippersData/loadConfig.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/rippersData/loadConfig.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 /****************************************************************************
  * @Author earthnut
  * @Email earthnut.dev@outlook.com

package/customHooks/useRipples/rippersData/renderData.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/rippersData/renderData.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 import { OriginStyle } from '../buildBackground/type';
 import { Ripples } from '../ripplesClass';
 import { Program, Textures } from '../types';

package/customHooks/useRipples/rippersData/useOptions.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/rippersData/useOptions.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 import { ImageCrossOrigin, RippleImgUrl, RipplesUseOptions } from '../types';
 /** 用户使用参数  */
 export declare class UseOptions {

package/customHooks/useRipples/rippersData/vertexSource.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/rippersData/vertexSource.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 /**
  *
  */

package/customHooks/useRipples/ripple.html.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/ripple.html.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 import { Ripples } from './ripplesClass';
 import { RipplesOptions } from './types';
 /**

package/customHooks/useRipples/ripplesClass.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/ripplesClass.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 import { RipplesData } from './rippersData';
 import { RipplesOptions } from './types';
 import { RipplesRenderData } from './rippersData/renderData';

package/customHooks/useRipples/tools.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/tools.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 /****************************************************************************
  * @Author earthnut
  * @Email earthnut.dev@outlook.com

package/customHooks/useRipples/types.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/types.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 /****************************************************************************
  * @Author earthnut
  * @Email earthnut.dev@outlook.com
@@ -6,7 +12,6 @@
  * @CreateDate  周二  12/17/2024
  * @Description BackgroundRipples 的类型声明文件
  ****************************************************************************/
-import { CSSProperties, ReactElement } from 'react';
 export type ImageCrossOrigin = 'anonymous' | 'use-credentials' | 'no-cors';
 /**
  *
@@ -29,13 +34,7 @@ export type ImageCrossOrigin = 'anonymous' | 'use-credentials' | 'no-cors';
  *    - darkMode 暗黑模式，仅用于在默认的背景图时更改默认背景图的背景色，如果使用了 `imgUrl` 配置，请执行处理色差异常
  *
  */
-export interface BackgroundRipplesProps {
-    /**
-     * 用于设定外层的样式
-     */
-    style?: CSSProperties;
-    /**  子元素  */
-    children?: ReactElement | ReactElement[];
+export type BackgroundRipplesProps = React.HTMLAttributes<HTMLDivElement> & {
     /**
      * ## 可设定涟漪的参数
      *
@@ -53,7 +52,7 @@ export interface BackgroundRipplesProps {
      * - darkMode 暗黑模式，仅用于在默认的背景图时更改默认背景图的背景色，如果使用了 `imgUrl` 配置，请执行处理色差异常
      */
     option?: RipplesOptions;
-}
+};
 /**
  *
  * WebGLProgram

package/customHooks/useRipples/use-lazy-ripple.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useRipples/use-lazy-ripple.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
+import { useRipples } from '.';
+/**  动态加载包含的自定义的钩子  */
+export declare function useLazyRipples(): {
+    hook: typeof useRipples | undefined;
+    isLoading: boolean;
+    error: null;
+};

package/customHooks/useTimeId.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @license MIT
+ * earthnut@customHooks/useTimeId.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 /**
  *
  * ### 导出一个使用 `useRef` 创建的 `NodeJS.Timeout`
@@ -5,7 +11,7 @@
  * 该数值在组件卸载时会自动调用 `clearTimeout` 清理
  *
  * @version 0.0.3
- * @see   https://earthnut.dev/use-time-id
+ * @see   https://earthnut.dev/custom-hooks/use-time-id
  * @example
  *
  * 使用：

package/dog.d.ts

@@ -1,2 +1,8 @@
+/**
+ * @license MIT
+ * earthnut@dog.d.ts 
+ * Copyright (c) 2025 earthnut.dev
+ * 请在项目根参看详细许可证明
+ */
 /**  开发环境执行，该方法在 env === 'production' 时通过 babel 和 webpack 过滤移除  */
 export declare const dog: import("@qqi/log").DevLog;