@birdwingo/react-native-spinning-numbers NPM

@birdwingo/react-native-spinning-numbers

npm downloads npm version

Features 🌟

🌀 Captivating Spinning Effect: Engage your users with an eye-catching visual experience by employing the spinning numbers animation! Perfect for displaying scores, statistics, and dynamic values.

🔢 Customizable Numbers: Tailor the appearance, size, and color of the numbers to match your app's theme. Endless possibilities at your fingertips!

🎛️ Dynamic Control: Effortlessly change the values on the fly through simple props. Sync the numbers with real-time data and keep your UI lively and interactive.

📱 Cross-Platform Support: Designed with React Native, this component works seamlessly across different platforms, offering a consistent experience on both iOS and Android devices.

🎨 Easy Styling: Apply your preferred styles with ease through well-structured customization options. Let your creativity flow and create a unique look!

⚙️ Performance Optimized: Efficiently built to minimize performance impact, ensuring a smooth experience even with frequent value changes.

🧰 Quick Integration: Get up and running in no time with comprehensive documentation and examples. Integrating spinning numbers into your app has never been easier!

🌟 Open Source and Community-Driven: Contributions are welcome! Join the community and help shape the future of this exciting component.

About

react-native-spinning-numbers is a customizable and animated component that offers a highly captivating way to display numerical values within your React Native application. This component combines an elegant visual effect of rotating numbers with the ability to dynamically change values, adding interactivity and intrigue to your user interfaces. It is used in the Birdwingo mobile app to show portfolio values and market prices changing in the real time.

Installation

npm install react-native-reanimated
npm install @birdwingo/react-native-spinning-numbers

Usage

To use the SpinningNumbers component, you need to import it in your React Native application and include it in your JSX code. Here's an example of how to use it:

import React, { useState } from 'react';
import { View, Text } from 'react-native';
import SpinningNumbers from '@birdwingo/react-native-spinning-numbers';

const YourComponent = () => {

  const [ value, setValue ] = useState( '$1478.78' );

  return (
    <SpinningNumbers
      style={{
        color: 'grey',
        fontSize: 45,
      }}
    >
      {value}
    </SpinningNumbers>
  );

};

export default YourComponent;

Props

Name	Type	Default value	Description
`children`	string	required	Text to be rendered
`style`	ViewStyle & TextStyle		Styles to be applied to text and container
`duration`	number	1000	Duration of the animation in ms
`parentheses`	boolean	false	Whether to show parentheses around text
`extendCharacters`	string	''	A string of characters that could appear in your text. You do not need to use it if your text contains only basic alphabetic characters, numbers or the following characters: `,.-+$%€!?&@#*`
`deps`	any[]	[]	An array of dependencies for useEffect, when those dependencies changed, text will be changed without animation
`autoMeasure`	boolean	false	Whether to auto measure text characters on first render