Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/moschan/react-native-newsticker

The News Ticker component for React Native
https://github.com/moschan/react-native-newsticker

Last synced: 6 days ago
JSON representation

The News Ticker component for React Native

Awesome Lists containing this project

README 

        
react-native-newsticker

==

> The News Ticker component for React Native



[![npm](https://img.shields.io/npm/v/react-native-newsticker.svg)]()[![npm](https://img.shields.io/npm/l/react-native-newsticker.svg)]()



[![NPM](https://nodei.co/npm/react-native-newsticker.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/react-native-newsticker/)



Demo

---



![Demo](./doc/simple_demo.gif)



![Demo](./doc/restart_demo.gif)



Installation

==



in Cli

---

```

npm i react-native-newsticker

```



in JavaScirpt

---

```

import Newsticker from 'react-native-newsticker';

```



Usage

===



Default

---

```



```



Customized

---

```

 {this.onFinish()}}

  cursor={true}

  start={this.state.is_begin}

  back={this.state.is_back}

  text={'This is a really awesome Newsticker !!'}

/>

```



Props

===



text(String) `Default: ''`

---

The text of newsticker



start(boolean) `Default: true`

---

If you pass false, newsticker does’nt start. If you pass the false while runnning, newsticker is stopped. You can toggle newsticker using this param.



back(boolean) `Default: false`

---

If you pass true when `start` is true, newsticker start to backward.



typeInterval(int) `Default: 100`

---

newstick interval



blinkInterval(int) `Default: 500`

---

blink interval of cursor



onFinish(function)

---

if finish newstick, this function is called



cursor(boolean) `Default: true`

---

In default, The cursor apeer in right of text. when newsticker is end, cursor starts blink.

if you pass false, cursor is not shown.



style `Default: ''`

---

Style of text



Contributing

==

Of course! Welcome :)



You can use following command in `example` dir:



```

npm run sync

```



During running this command, when you change source to implement/fix something, these changes will sync to `example/node_modules/react-native-newsticker/`. You can check your change using example project easily.



License

==

MIT