@custom-react-hooks/use-element-size

中文文档
1.5.1发布于 2024/08/18MITTypeScriptCommonJS零依赖近 30 天下载 1.9万

useElementSize 是一个能动态跟踪 HTML 元素维度的回放钩。 它更新了元素的宽度和高度,以应对窗口的再大小,元素的安装/卸载,并调整变化.

中文使用文档
文档目录11 节
  1. 特征
  2. 安装
  3. 只安装当前钩
  4. 安装全部钩
  5. 导入虎克
  6. 使用量
  7. API 参考
  8. 参数
  9. 返回对象
  10. 使用大小写
  11. 捐款

useElementSize 钩子

useElementSize 是一个能动态跟踪 HTML 元素维度的回放钩。 它更新了元素的宽度和高度,以应对窗口的再大小,元素的安装/卸载,并调整变化.

特征

  • 动态维度跟踪 : 自动跟踪和更新指定元素的宽度和高度.
  • 对环境变化的反应: 响应窗口调整大小并调整变化,确保精确的大小测量.
  • 安保部门安全: 与服务器侧渲染兼容,避免在不带设备的环境中出错 window 对象.
  • 优化精确度 : 用途 useLayoutEffect 用于DOM变异后的精确维度测量.

安装

选择并安装适合您项目需要的单个钩子, 或安装整个收藏, 用于全套公用事业 .

只安装当前钩

npm install @custom-react-hooks/use-element-size

或者说

yarn add @custom-react-hooks/use-element-size

安装全部钩

npm install @custom-react-hooks/all

或者说

yarn add @custom-react-hooks/all

导入虎克

这个 useElementSize 钩必须使用下列命名的导入方式导入:

已命名的导入 :

import { useElementSize } from '@custom-react-hooks/use-element-size';

这种方法确保了钩子无缝地融入到您的项目中,在您如何使用我们的包时保持一致性和可预测性.

使用量

import React, { useRef, useState } from 'react';
import { useElementSize } from '@custom-react-hooks/all';

const ElementSizeComponent = () => {
  const [setRef, size] = useElementSize();

  return (
    <div className="element-size">
      <div
        ref={setRef}
        className="resize"
      >
        <p>Drag from the bottom-right corner to resize.</p>
      </div>
      <br />
      <div>Current Size:</div>
      <div className="btns">
        <p>
          Width: <span>{size.width}px</span>
        </p>
        <p>
          Height: <span>{size.height}px</span>
        </p>
      </div>
    </div>
  );
};

export default ElementSizeComponent;

在这个例子中, useElementSize 用于测量和显示一个 div 键.

API 参考

参数

  • ref: 附加在您想要测量大小的元素上的反射对象.

返回对象

  • width: 元素的宽度
  • height: 元素的高度.

使用大小写

  • 响应组件: 根据其大小调整组件行为或样式.
  • 版式计算: 计算取决于元素大小的网格或泥瓦布局等项目的布局.
  • 大小依赖渲染: 根据可用大小渲染出不同的内容或组件.
  • 动画和过渡: 当元素大小变化时触发动画或过渡.
  • 优化 Canvas 或 SVG: 根据其容器大小调整画布或SVG元素的尺寸.

捐款

你对改进的贡献 useElementSize 欢迎光临。 请随意向存储处提交问题或调取请求.

版本与发布记录

@custom-react-hooks/use-element-size 共发布 7 个版本,首次发布于 2023/12/02;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.5.1latest2024/08/182 年前
1.5.02024/08/182 年前
1.4.192023/12/092 年前
1.4.182023/12/082 年前
1.4.162023/12/072 年前
1.4.152023/12/022 年前

关于 @custom-react-hooks/use-element-size 的常见问题

@custom-react-hooks/use-element-size 是什么?

useElementSize 是一个能动态跟踪 HTML 元素维度的回放钩。 它更新了元素的宽度和高度,以应对窗口的再大小,元素的安装/卸载,并调整变化.

如何安装 @custom-react-hooks/use-element-size?

在项目目录运行 npm install @custom-react-hooks/use-element-size,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(>=16)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@custom-react-hooks/use-element-size 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@custom-react-hooks/use-element-size 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@custom-react-hooks/use-element-size 可以商用吗?

@custom-react-hooks/use-element-size 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@custom-react-hooks/use-element-size 的下载量有多少?

根据 npm 官方下载统计,@custom-react-hooks/use-element-size 在 2026/10/11 – 2026/11/09 这 30 天内被下载 18,569 次,日均约 619 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@custom-react-hooks/use-element-size 还在维护吗?

最新版本 1.5.1 发布于 2024/08/18(2 年前);至今共发布 7 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/12/02。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。