px2rem2js
TypeScript icon, indicating that this package has built-in type declarations

1.1.6 • Public • Published

px2rem2js

根据设计稿与 FontSize 基准值动态计算与设置Root FontSize,初始化 Rem 适配,首次加载及视窗变化时触发。在Js中,提供按照设计稿px到rem的转换方法。配合post-css插件postcss-pxtorem实现全方位适配。

安装

npm:

npm install --save px2rem2js

yarn:

yarn add px2rem2js

初始化一个简单的js适配场景

// src/utils/rem.ts
import px2rem2js from 'px2rem2js';
const p2r2js = new px2rem2js() // global default option: {designWidth:750,baseFontSize:100,suffix:true,context:window,maxWidth:this.designWidth}
export const initRem = p2r2js.initRem
export const getRem = p2r2js.getRem // current default option: {suffix:global.default.option.suffix}
export default p2r2js

// src/app.ts
import { initRem } from '@/utils/rem.ts'
initRem()

// src/pages/home.tsx
import { getRem } from '@/utils/rem.ts'
export default () => {
  return <div style={{width:getRem(100),height:getRem(100),fontSize:getRem(16)}}>Hello World!!</div>
}

搭配css适配

使用 post-css + postcss-pxtorem 插件

安装依赖

npm:

npm install post-css postcss-pxtorem postcss-loader -D

yarn:

yarn add post-css postcss-pxtorem postcss-loader -D 

配置postcss-loader

  // webpack.config.js,非webpack配置方式请参考官方文档
  module.exports = {
    // ...
    rules: [
      {
        test: /\.css$/,
        use: ['style-loader', 'postcss-loader'],
      },
    ]
  }

配置postcss-pxtorem插件

  // postcss.config.js,参考
  const px2rem = require('postcss-pxtorem')
  module.exports = {
    // ...
    plugins: [
      px2rem({
        //根元素字体大小,与px2rem2js实例化入参baseFontSize保持一致,建议统一使用环境变量取值
        rootValue: process.env.BASE_FONT_SIZE,
        //匹配CSS中的属性,* 代表启用所有属性
        propList: ['*'],
        //转换成rem后保留的小数点位数
        unitPrecision: 5,
        //忽略一些文件,不进行转换,比如我想忽略 依赖的UI框架
        // exclude: ['node_modules']
      }),
    ]
  }

特性

  • 语言:支持TS
  • 便捷:initRem方法封装了对root font-size的处理,配套getRem方法获取rem值,初始化完成后无需关心视窗变化的影响。
  • 灵活:支持配置designWidth(设计稿宽度),baseFontSize(基准值)等等。

API

global option

选项 含义 值类型 默认值 备注
designWidth 设计稿宽度 number 750 根据设计稿宽度开发
baseFontSize root font-size 基准值 number 100 提高可阅读性,扩大小数点精准度度
suffix 输出值是否带有rem boolean true 某些场景可能希望只输出值,不带单位
context 上下文 any window 允许配置应用于addEventListener和document的取值对象
maxWidth 支持适配的最大宽度 number|string|false designWidth 为false时没有最大宽度适配限制,font-size将保持修改。配置值时,当达到或超出该值时,font-size不再修改。场景如超过设计稿宽度的设备,比如ipad等,大屏下用户不一定就想看到那么大的效果,因此支持配置最大值。
  • 初始化:p2r2js.initRem()
  • 注册事件:p2r2js.on(<EvenTypes[string]>,callback),注册事件
  • 获取计算rem值:p2r2js.getRem(<number|string>,?<GetRemOptions>),第二个可选参数不传则使用实例化配置

GetRemOptions:

选项 含义 值类型 默认值 备注
suffix 输出值是否带有rem boolean true 某些场景可能希望只输出值,不带单位发

EvenTypes:

选项 触发时机 回调参数 备注
RESIZE 窗口大小改变时触发

本地 demo

npm i && npm run dev

开启本地服务打开html

Readme

Keywords

Package Sidebar

Install

npm i px2rem2js

Weekly Downloads

0

Version

1.1.6

License

MIT

Unpacked Size

68.9 kB

Total Files

6

Last publish

Collaborators

  • gison14