Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@feenan/scalebox-react

feenan5MIT0.1.3TypeScript support: included

一个用于开发大屏的react组件,支持全局模式和容器模式

scalebox, full, screen, fullScreen, 大屏

readme

第三方库使用

NPM包地址

安装

npm install @feenan/scalebox-react

使用场景

在React项目中,当你需要开发大屏,希望宽高保持固定比例自适应视口或者其他容器展示时。

使用方式1--全屏模式

import ScaleBox from '@feenan/scalebox-react'
import '@feenan/scalebox-react/lib/index.css'

<ScaleBox width={1908} height={1000} isFullScreen>
    <div>这里是具体的被放缩的子组件</div>
</ScaleBox>

使用方式2--容器模式

import ScaleBox from '@feenan/scalebox-react'
import '@feenan/scalebox-react/lib/index.css'

<ScaleBox width={1908} height={1000} container={wrapperDom}>
    <div>这里是具体的被放缩的子组件</div>
</ScaleBox>

API

属性 说明 类型 默认值
width 大屏初始宽 number -
height 大屏初始高 number -
isFullScreen 是否自适应视口宽高(window.innerWidth/window.innerHeight) boolean -
container 是否自适应该DOM元素宽高 HTMLElement -

本地调试

本地启动

npm run start

修改代码后测试

npm run test

本地打包

npm run build