1.0.1 • Published 5 years ago

r-analog-clock v1.0.1

Weekly downloads
5
License
MIT
Repository
github
Last release
5 years ago

效果图

说明:这是基于react开发的一个模拟时钟组件。

1.安装&使用

  • 安装
npm install -D r-analog-clock
  • 使用
import React, { Component } from 'react'
import AnalogClock from 'r-analog-clock'

class Demo extends Component{
    render(){
        return (
            <div>
                <AnalogClock />
            </div>
        )
    }
}

2.例子

2.1 最简单使用

  • 代码
import React, { Component } from 'react'
import AnalogClock from 'r-analog-clock'
class Demo extends Component{
    render(){
        return (
            <div>
                <AnalogClock />
            </div>
        )
    }
}
  • 效果

2.2 显示罗马数字

  • 代码
import React, { Component } from 'react'
import AnalogClock from 'r-analog-clock'
class Demo extends Component{
    render(){
        return (
            <div>
                <AnalogClock scaleType="roman"/>
            </div>
        )
    }
}
  • 效果

2.3 自定义边框颜色、背景色、刻度线颜色以及小时数字颜色

  • 代码
import React, { Component } from 'react'
import AnalogClock from 'r-analog-clock'
class Demo extends Component{
    render(){
        return (
            <div>
                <AnalogClock 
                    bordercolor="brown" 
                    backgroundColor="black" 
                    hourColor="white" 
                    scaleColor="yellow"/>
            </div>
        )
    }
}
  • 效果

2.4 自定义边框图片、背景图片

  • 代码1
import React, { Component } from 'react'
import AnalogClock from 'r-analog-clock'
class Demo extends Component{
    render(){
        return (
            <div>
                <AnalogClock 
                     borderImage="/static/img/border.png"
                     backgroundImage="/static/img/bg.jpg"/>
            </div>
        )
    }
}
  • 代码2 使用远程图片
import React, { Component } from 'react'
import AnalogClock from 'r-analog-clock'
class Demo extends Component{
    render(){
        return (
            <div>
                <AnalogClock 
                     borderImage="https://timgsa.baidu.com/timg?image&quality=80&size=b9999_10000&sec=1545553805386&di=ec656215a2958d617ef30631e96304e0&imgtype=0&src=http%3A%2F%2Fimg1.ali213.net%2Fshouyou%2Fupload%2Fimage%2F2018%2F07%2F09%2F584_2018070952816881.png"
                     backgroundImage="https://timgsa.baidu.com/timg?image&quality=80&size=b9999_10000&sec=1545553773235&di=1c768f80fc088c2edc20fa75af77c515&imgtype=0&src=http%3A%2F%2Fb-ssl.duitang.com%2Fuploads%2Fitem%2F201607%2F03%2F20160703164252_2WySB.jpeg"/>
            </div>
        )
    }
}
  • 效果

3. props

属性说明类型默认值
size模拟时钟大小Number300
time指定显示某个时间,若有指定,那么时钟会停在指定的时间,类型可以是Date对象或字符串,如果是字符串,那么必须满足格式:"hh:mm:ss"String | Date-
padding内边距Number5
borderWidth边框宽度Number15
borderColor边框颜色Stringblack
borderImage边框背景图片,优先级高于borderColorString-
backgroundColor背景色Stringwhite
backgroundImage背景图片,优先级高于backgroundColorString-
backgroundMode背景图显示模式,可选值part或fullStringfull
backgroundAlpha背景图片的透明度Number0.5
scaleType显示的刻度类型,roman:罗马数字,arabic:阿拉伯数字,none:不显示Stringarabic
scaleColor刻度线颜色String#666
hourColor刻度值颜色String#666
handType指针类型line | triangletriangle
secondHandColor秒针颜色Stringred
minuteHandColor分针颜色String#666
hourHandColor时针颜色Stringblack
showShadow时针颜色Booleantrue

4. 方法

提示:给AnalogClock组件增加ref属性可获取组件的React实例,实例可执行下面的方法。例如:

import React, { Component } from 'react'
import AnalogClock from 'r-analog-clock'
class Demo extends Component{
    componentDidMount() {
        // this.ac.run();//运行时钟,如果props没有传入tiem属性,组件会自动调用run方法
        // this.ac.stop();//停止时钟
    }
    render(){
        return (
            <div>
                <AnalogClock ref={ac => this.ac = ac}/>
            </div>
        )
    }
}
方法名说明
run如果模拟时钟处于停止状态,那么可以执行此方法重新运行模拟时钟。
stop执行此方法,可以停止一个正在运行的模拟时钟。