π¨ Ripple
Ripple is a simple, lightweight, and easy-to-use Roblox library for creating simple transitions and animations. It is inspired by roact-spring and is primarily intended to be a general-use alternative to Flipper for Roblox-TS.
You may use Ripple with or without Roact. Currently, there is no package for using Ripple with Roact.
π¦ Installation
Ripple is available on NPM and can be installed with the following commands:
npm install @rbxts/ripple
yarn add @rbxts/ripple
pnpm add @rbxts/ripple
π Documentation
To see Ripple in action, check out the example repository.
β‘ Quick Start
Call createMotion
to create an animation.
Use the spring
, linear
, instant
, and tween
methods to set the goal of your animation.
import { Motion, MotionGoal, config, createMotion } from "@rbxts/ripple";
const motion = createMotion(Vector3.zero, { start: true });
motion.spring(Vector3.one, config.spring.stiff);
motion.onStep((value, deltaTime) => {
print(value, deltaTime);
});
print(motion.get());
βοΈ Usage with React
useMotion(initialValue, options?)
Creates a memoized Motion object set to the given initial value.
Returns a binding that updates with the Motion, along with the Motion object.
function MyComponent() {
const [binding, motion] = useMotion(0);
// ...
}
export function useMotion(initialValue: number, options?: MotionOptions): LuaTuple<[Binding<number>, Motion<number>]>;
export function useMotion<T extends MotionGoal>(
initialValue: T,
options?: MotionOptions,
): LuaTuple<[Binding<T>, Motion<T>]>;
export function useMotion<T extends MotionGoal>(initialValue: T, options: MotionOptions = { start: true }) {
const motion = useMemo(() => {
return createMotion(initialValue, options);
}, []);
const [binding, setValue] = useBinding(initialValue);
useEffect(() => {
const disconnect = motion.onStep(setValue);
return () => {
disconnect();
motion.destroy();
};
}, []);
return $tuple(binding, motion);
}
useSpring(value, springConfig?)
Applies spring animations to the given value, and updates the goal with the latest value on every re-render.
Returns a binding that updates with the Motion.
function MyComponent({ someValue }: Props) {
const binding = useSpring(someValue);
// ...
}
export function useSpring(goal: number | Binding<number>, options?: SpringOptions): Binding<number>;
export function useSpring<T extends MotionGoal>(goal: T | Binding<T>, options?: SpringOptions): Binding<T>;
export function useSpring(goal: MotionGoal | Binding<MotionGoal>, options?: SpringOptions) {
const [binding, motion] = useMotion(getBindingValue(goal), { start: false });
const previousValue = useRef(getBindingValue(goal));
useEventListener(RunService.Heartbeat, (delta) => {
const currentValue = getBindingValue(goal);
if (currentValue !== previousValue.current) {
previousValue.current = currentValue;
motion.spring(currentValue, options);
}
motion.step(delta);
});
return binding;
}
π License
Ripple is licensed under the MIT License.