0.1.1 • Published 2 years ago

spacing-marker v0.1.1

Weekly downloads
-
License
-
Repository
-
Last release
2 years ago

HTML 元素间距标记

使用截图

spacing-marker-1.png

spacing-marker-2.png

使用方式

安装

npm i spacing-marker@latest

使用

import SpacingMarker from 'spacing-marker';

// 默认目标元素为document.body
SpacingMarker.start();

// 可设置目标元素及要附加标记的元素
SpacingMarker.start(el, appendToEl);

// 取消使用getBoundingClientRect()方法获取定位,将会使用与目标元素的相对位置作为定位信息
// 当目标元素开启了定位position且有transform属性时使用
SpacingMarker.useBoundingClientRect = false;
// 可指定自定义获取定位的方法。(内置获取定位的方法将失效)
SpacingMarker.getRect = (element: HTMLElement) => {
  const getAttr = (name: string) => Number(element.getAttribute(name));
  const left = getAttr('x');
  const top = getAttr('y');
  const width = getAttr('width');
  const height = getAttr('height');
  return {
    top: top,
    bottom: top + height,
    left: left,
    right: left + width,
    width: width,
    height: height,
  };
};

// 清除所有标记
SpacingMarker.clean();

// 结束标记
SpacingMarker.end();

属性

属性名称说明类型默认值
el需要元素间距标记的目标元素HTMLElementdocument.body
appendToEl最终要附加标记的元素HTMLElementdocument.body
useBoundingClientRect是否使用 getBoundingClientRect()方法获取定位Booleantrue
getRect自定义获取定位的方法Function(element) => {top: number,bottom: number,left: number,right: number,width: number,height: number}-
selectedColor选中标记颜色String#2196F3
targetColorhover 标记颜色String#fe1d5f
zIndex标记层级Number10000
scale标记缩放比例Number1
onRangingChange间距改变回调函数Function({ top, bottom, left, right })-

方法

方法名说明参数
start开启标记(el?:需要元素间距标记的目标元素, appendToEl?:最终要附加标记的元素)
end结束标记(el?:需要结束元素间距标记的目标元素)
clean清除标记-
updateScale更新标记缩放比例(scale:标记缩放比例)
0.1.1

2 years ago

0.1.0

2 years ago