react-rewards

Package containing a few microinteractions you can use to reward your users for little things and make them smile!

Github星跟踪图

react-rewards logo

npm version forthebadge

Demo available here!

Usage

This package was built using React-Pose, react-dom-confetti and Lottie-web.

Why should I use that? Read my blog post and you will know – https://www.thedevelobear.com/post/microinteractions/

Install from npm by typing npm install react-rewards or yarn add react-rewards while in your package.json directory.

This package lets you add microinteractions to your app, and rewards users with the rain of confettis, flying emoji or memphis design particles in seconds. In order to make it rain, you need to wrap your button of choice with the <Reward> component, fire the rewardMe() method from the refs and voilà. You can also "punish" the user by calling the punishMe() method and showing them that something went wrong.

import Reward from 'react-rewards';

// in render
<Reward
  ref={(ref) => { this.reward = ref }}
  type='emoji'
>
  <button onClick={this.fetchSomeData} />
</Reward>

// in fetchSomeData:
// to reward a user with confetti/emoji/memphis rain:
this.reward.rewardMe();
// to "punish" user :
this.reward.punishMe();

Props & config

Basic props:, name, type, description, required, default, -----------------, --------, --------------------------------------------------------, ------------, -------------, ref, func, function that creates a ref of the reward component, yes, type, string, 'confetti', 'emoji' or 'memphis', no, 'confetti', config, object, a configuration object described below, no, see below, Config object:, name, type, description, default (confetti / emoji), -----------------, --------, --------------------------------------------------------, ---------------------------, lifetime, number, time of life of each particle in ms, 200 / 200, angle, number, initial direction of particles in degrees, 90 / 90, decay, number, how much the velocity decreases with each frame, 0.91 / 0.91, spread, number, spread of particles in degrees, 45 / 100, startVelocity, number, initial velocity of particles, 35 / 20, elementCount, number, particles quantity, 40 / 15, elementSize, number, particle size in px, 8 / 20, zIndex, number, z-index of particles, 10 / 10, springAnimation, bool, whether the button should be animated, true, colors, array, An array of colors used when generating confettis, emoji, array, An array of emoji used when generating emoji particles

主要指标

概览
名称与所有者thedevelobear/react-rewards
主编程语言TypeScript
编程语言JavaScript (语言数: 2)
平台
许可证MIT License
所有者活动
创建于2018-11-12 23:28:34
推送于2025-01-30 18:11:56
最后一次提交2025-01-29 23:39:42
发布数7
最新版本名称v2.1.0 (发布于 )
第一版名称v1.1.2 (发布于 )
用户参与
星数1.7k
关注者数4
派生数62
提交数106
已启用问题?
问题数25
打开的问题数1
拉请求数53
打开的拉请求数2
关闭的拉请求数32
项目设置
已启用Wiki?
已存档?
是复刻?
已锁定?
是镜像?
是私有?