https://github.com/hamdiwanis/nativescript-shine-button

NativeScript plugin that add shine effect to your button.
https://github.com/hamdiwanis/nativescript-shine-button

Last synced: about 1 month ago
JSON representation

NativeScript plugin that add shine effect to your button.

• Host: GitHub
• URL: https://github.com/hamdiwanis/nativescript-shine-button
• Owner: hamdiwanis
• License: apache-2.0
• Created: 2018-06-26T23:59:23.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-02-15T13:43:07.000Z (almost 6 years ago)
• Last Synced: 2024-04-14T10:15:30.534Z (8 months ago)
• Language: JavaScript
• Size: 2.4 MB
• Stars: 7
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• fucking-awesome-web-effect - nativescript-shine-button - NativeScript plugin that add shine effect to your button. (🚀 A series of exquisite and compact web page cool effects / Button Effect)
• awesome-web-effect - nativescript-shine-button - NativeScript plugin that add shine effect to your button. (🚀 A series of exquisite and compact web page cool effects / Button Effect)

README

        


     NativeScript Shine Button







> Note: This Plugin based on [WCLShineButton for IOS](https://github.com/imwcl/WCLShineButton) and [ShineButton for Android](https://github.com/ChadCSong/ShineButton) .

## Installation

```bash

tns plugin add nativescript-shine-button

```

### Usage

```html

     

```

see the demo project for more info.

## Angular

Add this to app.module.ts so you can use a ShineButton tag in the view:

```

import { registerElement } from "nativescript-angular";

registerElement("ShineButton", () => require("nativescript-shine-button").ShineButton);

```

## API

| **Property**            | **Description**                          |

| ----------------------- | ---------------------------------------- |

| `src`                   | button image (png)                       |

| `color`                 | Default button color                     |

| `fillColor`             | Fill button color                        |

| `allowRandomColor`      | Allow shine color random                 |

| `animDuration`          | shine anim duration in sec               |

| `bigShineColor`         | big shine color                          |

| `enableFlashing`        | Enable effect like flash                 |

| `shineCount`            | shine count around button                |

| `shineTurnAngle`        | turn angle of shine                      |

| `shineDistanceMultiple` | multiple of distance to button           |

| `smallShineOffsetAngle` | angle offset of small shine to big shine |

| `smallShineColor`       | small shine color                        |

| `shineSize`             | size of shine by pixel                   |

## Next

- [ ] adjust the properties to be more consistent on android and ios.

## Contribute

if you want to help improve the plugin you can consider it yours and make as PRs as you want :)

## Get Help

Please, use [github issues](https://github.com/hamdiwanis/nativescript-shine-button/issues) strictly for [reporting bugs](CONTRIBUTING.md#reporting-bugs) or [requesting features](CONTRIBUTING.md#requesting-new-features).

## Contact

Twitter: [hamdiwanis](https://twitter.com/hamdiwanis)  \

Email: [email protected]