ts-basic-components-marquee.md 2.8 KB
Newer Older
Z
zengyawen 已提交
1 2
# Marquee

C
caocan 已提交
3
跑马灯组件,用于滚动展示一段单行文本,仅当文本内容宽度超过跑马灯组件宽度时滚动。
Z
zengyawen 已提交
4 5


G
gmy 已提交
6 7 8
>  **说明:**
>
>  该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
Z
zengyawen 已提交
9 10 11 12 13 14 15 16 17 18 19


## 子组件




## 接口

Marquee(value: { start: boolean, step?: number, loop?: number, fromStart?: boolean, src: string })

G
gmy 已提交
20 21 22 23 24
**参数:**

| 参数名 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
| start | boolean | 是 | 控制跑马灯是否进入播放状态。 |
L
fix doc  
luoying_ace_admin 已提交
25
| step | number | 否 | 滚动动画文本滚动步长。<br/>默认值:6,单位vp |
G
gmy 已提交
26 27 28 29 30
| loop | number | 否 | 设置重复滚动的次数,小于等于零时无限循环。<br/>默认值:-1 |
| fromStart | boolean | 否 | 设置文本从头开始滚动或反向滚动。<br/>默认值:true |
| src | string | 是 | 需要滚动的文本。 |

## 属性
Z
zengyawen 已提交
31

G
gmy 已提交
32 33 34
| 名称       | 参数类型 | 描述                                 |
| ---------- | -------- | ------------------------------------ |
| allowScale | boolean  | 是否允许文本缩放。<br/>默认值:false |
Z
zengyawen 已提交
35 36 37

## 事件

G
gmy 已提交
38
| 名称 | 功能描述 |
Z
zengyawen 已提交
39
| -------- | -------- |
G
gmy 已提交
40 41 42
| onStart(event:&nbsp;()&nbsp;=&gt;&nbsp;void) | 开始滚动时触发回调。 |
| onBounce(event:&nbsp;()&nbsp;=&gt;&nbsp;void) | 完成一次滚动时触发,若循环次数不为1,则该事件会多次触发。 |
| onFinish(event:&nbsp;()&nbsp;=&gt;&nbsp;void) | 滚动全部循环次数完成时触发回调。 |
Z
zengyawen 已提交
43 44 45 46 47


## 示例


H
geshi  
HelloCrease 已提交
48 49
```ts
// xxx.ets
Z
zengyawen 已提交
50 51 52 53
@Entry
@Component
struct MarqueeExample {
  @State start: boolean = false
L
luoying_ace_admin 已提交
54 55 56 57
  private fromStart: boolean = true
  private step: number = 50
  private loop: number = Infinity
  private src: string = "Running Marquee starts rolling"
Z
zengyawen 已提交
58 59 60 61 62 63 64 65 66 67

  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
      Marquee({
        start: this.start,
        step: this.step,
        loop: this.loop,
        fromStart: this.fromStart,
        src: this.src
      })
L
luoying_ace_admin 已提交
68 69 70 71 72 73 74
        .width(360)
        .height(80)
        .fontColor('#FFFFFF')
        .fontSize(48)
        .fontWeight(700)
        .backgroundColor('#182431')
        .margin({ bottom: 40 })
Z
zengyawen 已提交
75
        .onStart(() => {
L
luoying_ace_admin 已提交
76
          console.info('Marquee animation complete onStart')
Z
zengyawen 已提交
77 78
        })
        .onBounce(() => {
L
luoying_ace_admin 已提交
79
          console.info('Marquee animation complete onBounce')
Z
zengyawen 已提交
80 81
        })
        .onFinish(() => {
L
luoying_ace_admin 已提交
82
          console.info('Marquee animation complete onFinish')
Z
zengyawen 已提交
83
        })
L
luoying_ace_admin 已提交
84 85 86 87 88 89 90 91 92
      Button('Start')
        .onClick(() => {
          this.start = true
        })
        .width(120)
        .height(40)
        .fontSize(16)
        .fontWeight(500)
        .backgroundColor('#007DFF')
Z
zengyawen 已提交
93 94 95 96 97 98 99
    }
    .width('100%')
    .height('100%')
  }
}
```

Y
yamila 已提交
100
![marquee](figures/marquee.gif)