项目简介
本项目基于Rollup和TypeScript构建,借助Rollup强大的打包能力,将项目代码编译成多种格式,同时利用TypeScript增强代码的类型检查和可维护性。项目提供了 useWindowSize
示例Hook组件,方便开发者参考如何使用Hooks监听窗口大小变化。
项目的主要特性和功能
- 多种输出格式:利用Rollup实现CommonJS(CJS)、ES6模块(ESM)和UMD格式的输出,满足不同场景使用需求。
- TypeScript集成:支持类型检查和自动补全,提升开发效率和代码质量。
- 示例Hook组件:包含
useWindowSize
组件,可实时监听窗口大小变化。 - 清晰的项目结构:代码组织清晰,便于开发者理解和扩展。
安装使用步骤
1. 安装依赖
打开终端,进入项目根目录,执行以下命令:
bash
pnpm install
2. 配置npm源(可选)
为加快安装速度,可在项目根目录下创建 .npmrc
文件,并添加以下内容:
bash
registry=https://registry.npmmirror.com
3. 编译项目
运行以下命令进行项目编译:
bash
pnpm build
编译完成后,会在 dist
目录下生成以下文件:
- bundle.cjs
- bundle.cjs.map
- bundle.d.ts
- bundle.mjs
- bundle.mjs.map
4. 使用Hook组件
在你的React项目中引入并使用生成的Hook组件(如 useWindowSize
)。使用前需确保项目支持React Hooks。你可在项目的 src
目录下查看Hook组件的源代码,进行参考和学习。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】