https://github.com/wrathchaos/react-native-shake-text

https://github.com/wrathchaos/react-native-shake-text

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/wrathchaos/react-native-shake-text
• Owner: WrathChaos
• Created: 2021-08-21T11:03:11.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-07-31T06:21:18.000Z (about 2 years ago)
• Last Synced: 2025-05-10T04:05:04.720Z (5 months ago)
• Language: TypeScript
• Size: 8.5 MB
• Stars: 14
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          


[![Battle Tested ✅](https://img.shields.io/badge/-Battle--Tested%20%E2%9C%85-03666e?style=for-the-badge)](https://github.com/WrathChaos/react-native-shake-text)

[![React Native Shake Text](https://img.shields.io/badge/-Extremely%20easy%20to%20create%20a%20React%20Native%20Component%20Library%20with%20both%20Stateful%20and%20Functional%20Component%20Examples-orange?style=for-the-badge)](https://github.com/WrathChaos/react-native-shake-text)

[![npm version](https://img.shields.io/npm/v/react-native-shake-text.svg?style=for-the-badge)](https://www.npmjs.com/package/react-native-shake-text)

[![npm](https://img.shields.io/npm/dt/react-native-shake-text.svg?style=for-the-badge)](https://www.npmjs.com/package/react-native-shake-text)

![Platform - Android and iOS](https://img.shields.io/badge/platform-Android%20%7C%20iOS-blue.svg?style=for-the-badge)

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)

[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/prettier)



  



# Installation

Add the dependency:

```bash

npm i react-native-shake-text

```

## Peer Dependencies

Zero Dependency

# Usage

## Import

```jsx

import ShakeText from "react-native-shake-text";

```

## Fundamental Usage

```jsx

import ShakeText from "react-native-shake-text";

shakeTextRef: ShakeText | null = null;

 (this.shakeTextRef = ref)}

>

  Shake Text

{ 

  this.shakeEmailRef?.startShakeAnimation();

}}>

```

### Start the Shake Animation

Simply you just need to call the `startShakeAnimation` by its reference

```jsx

this.shakeEmailRef?.startShakeAnimation();

```

## Example Project 😍

You can checkout the example project 🥰

Simply run

- `npm i`

- `react-native run-ios/android`

should work of the example project.

# Configuration - Props

## Fundamentals

There is a prop-drilling for both animated view and the text. You can customize anything :)

## Future Plans

- [x] ~~LICENSE~~

- [ ] Write an article about the lib on Medium

## Author

FreakyCoder, kurayogun@gmail.com

## License

React Native Shake Text is available under the MIT license. See the LICENSE file for more info.