Skip to content

Commit 21bb759

Browse files
committed
docs: fix typo
1 parent c369e13 commit 21bb759

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

PERFORMANCE.md

Whitespace-only changes.

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![npm][version-badge]][version]
44
[![MIT License][license-badge]][license]
55

6-
Helpers that let you observe the value of an [Animated][animated] or [Reanimated][reanimated] values and convert between them using native events.
6+
Helpers that let you observe [Animated][animated] and [Reanimated][reanimated] values and convert between them using native events.
77

88
## Use case
99

@@ -21,7 +21,7 @@ The library exports the following components:
2121

2222
### `AnimatedConverter`
2323

24-
A component that converts between an [`Animated.Node`][animated.node] and a [`SharedValue`][reanimated.sharedvalue] natively.
24+
A component that converts between an [`Animated.Node`][animated.node] and a [`SharedValue<number>`][reanimated.sharedvalue] natively.
2525

2626
It accepts the following props:
2727

@@ -55,7 +55,7 @@ A component that observes changes in a given value and emits an event when the v
5555

5656
It accepts the following props:
5757

58-
- `value`: The value to observe. It can be a `number`, [`Animated.Node`][animated.node] for [Animated][animated], [`SharedValue`][reanimated.sharedvalue] or [`DerivedValue`][reanimated.derivedvalue] for [Reanimated][reanimated].
58+
- `value`: The value to observe. It can be a `number`, [`Animated.Node`][animated.node] for [Animated][animated], [`SharedValue<number>`][reanimated.sharedvalue] or [`DerivedValue<number>`][reanimated.derivedvalue] for [Reanimated][reanimated].
5959
- `onValueChange`: A callback function that is called when the observed value changes.
6060

6161
Usage:
@@ -77,9 +77,9 @@ const animatedValue = useRef(new Animated.Value(0)).current;
7777

7878
## How it works
7979

80-
The library renders a native component that receives an [`Animated.Node`][animated.node] or [`SharedValue`][reanimated.sharedvalue] value. When the value changes, the library dispatches an event with this value.
80+
The library renders a native component that receives an [`Animated.Node`][animated.node] or [`SharedValue<number>`][reanimated.sharedvalue] value. When the value changes, the library dispatches an event with this value.
8181

82-
This event is then used with [`Animated.event`][animated.event] (with native driver) or [`useEvent`][reanimated.useevent] to update [`Animated.Value`][animated.value] or [`SharedValue`][reanimated.sharedvalue] respectively, depending on the usage.
82+
This event is then used with [`Animated.event`][animated.event] (with native driver) or [`useEvent`][reanimated.useevent] to update [`Animated.Value`][animated.value] or [`SharedValue<number>`][reanimated.sharedvalue] respectively, depending on the usage.
8383

8484
## Contributing
8585

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "react-native-animated-observer",
33
"version": "0.2.2",
4-
"description": "A component that lets you observe value of an Animated or Reanimated values and convert between them",
4+
"description": "A component that lets you observe Animated and Reanimated values and convert between them",
55
"main": "./lib/module/index.js",
66
"types": "./lib/typescript/src/index.d.ts",
77
"exports": {

0 commit comments

Comments
 (0)