Skip to content

Commit

Permalink
fixed lint errors for v0.18 (facebook#1417)
Browse files Browse the repository at this point in the history
  • Loading branch information
mitulsavani authored and rickhanlonii committed Oct 21, 2019
1 parent f4bd04a commit 4bcd62e
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 9 deletions.
1 change: 0 additions & 1 deletion .alexignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,3 @@ website/blog/
# Once you fix all of the errors, commit all of the changes including this file.
#
# To be considerate to the reviewer, please submit each version in different PRs.
website/versioned_docs/version-0.18/
8 changes: 4 additions & 4 deletions website/versioned_docs/version-0.18/animated.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Animated
original_id: animated
---

Animations are an important part of modern UX, and the `Animated` library is designed to make them fluid, powerful, and easy to build and maintain.
Animations are an important part of modern UX, and the `Animated` library is designed to make them fluid, powerful, and possible to build and maintain.

The simplest workflow is to create an `Animated.Value`, hook it up to one or more style attributes of an animated component, and then drive updates either via animations, such as `Animated.timing`, or by hooking into gestures like panning or scrolling via `Animated.event`. `Animated.Value` can also bind to props other than style, and can be interpolated as well. Here is a basic example of a container view that will fade in when it's mounted:

Expand Down Expand Up @@ -36,15 +36,15 @@ class FadeInView extends React.Component {
}
```

Note that only animatable components can be animated. `View`, `Text`, and `Image` are already provided, and you can create custom ones with `createAnimatedComponent`. These special components do the magic of binding the animated values to the properties, and do targeted native updates to avoid the cost of the react render and reconciliation process on every frame. They also handle cleanup on unmount so they are safe by default.
Note that only animatable components can be animated. `View`, `Text`, and `Image` are already provided, and you can create custom ones with `createAnimatedComponent`. These particular components do the magic of binding the animated values to the properties, and do targeted native updates to avoid the cost of the react render and reconciliation process on every frame. They also handle cleanup on unmount so they are safe by default.

Animations are heavily configurable. Custom and pre-defined easing functions, delays, durations, decay factors, spring constants, and more can all be tweaked depending on the type of animation.

A single `Animated.Value` can drive any number of properties, and each property can be run through an interpolation first. An interpolation maps input ranges to output ranges, typically using a linear interpolation but also supports easing functions. By default, it will extrapolate the curve beyond the ranges given, but you can also have it clamp the output value.

For example, you may want to think about your `Animated.Value` as going from 0 to 1, but animate the position from 150px to 0px and the opacity from 0 to

1. This can easily be done by modifying `style` in the example above like so:
1. This can be done by modifying `style` in the example above like so:

```jsx
style={{
Expand All @@ -58,7 +58,7 @@ For example, you may want to think about your `Animated.Value` as going from 0 t
}}>
```

Animations can also be combined in complex ways using composition functions such as `sequence` and `parallel`, and can also be chained together simply by setting the `toValue` of one animation to be another `Animated.Value`.
Animations can also be combined in complex ways using composition functions such as `sequence` and `parallel`, and can also be chained together by setting the `toValue` of one animation to be another `Animated.Value`.

`Animated.ValueXY` is handy for 2D animations, like panning, and there are other helpful additions like `setOffset` and `getLayout` to aid with typical interaction patterns, like drag-and-drop.

Expand Down
2 changes: 1 addition & 1 deletion website/versioned_docs/version-0.18/dimensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ static set(dims)

This should only be called from native code.

@param {object} dims Simple string-keyed object of dimensions to set
@param {object} dims string-keyed object of dimensions to set

---

Expand Down
4 changes: 2 additions & 2 deletions website/versioned_docs/version-0.18/imagestore.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Check if the ImageStore contains image data for the specified URI. @platform ios
static removeImageForTag(uri)
```

Delete an image from the ImageStore. Images are stored in memory and must be manually removed when you are finished with them, otherwise they will continue to use up RAM until the app is terminated. It is safe to call `removeImageForTag()` without first calling `hasImageForTag()`, it will simply fail silently. @platform ios
Delete an image from the ImageStore. Images are stored in memory and must be manually removed when you are finished with them, otherwise they will continue to use up RAM until the app is terminated. It is safe to call `removeImageForTag()` without first calling `hasImageForTag()`, it will silently fail. @platform ios

---

Expand All @@ -57,4 +57,4 @@ static getBase64ForTag(uri, success, failure)

Retrieves the base64-encoded data for an image in the ImageStore. If the specified URI does not match an image in the store, the failure callback will be called.

Note that it is very inefficient to transfer large quantities of binary data between JS and native code, so you should avoid calling this more than necessary. To display an image in the ImageStore, you can just pass the URI to an `<Image/>` component; there is no need to retrieve the base64 data.
Note that it is very inefficient to transfer large quantities of binary data between JS and native code, so you should avoid calling this more than necessary. To display an image in the ImageStore, you can pass the URI to an `<Image/>` component; there is no need to retrieve the base64 data.
2 changes: 1 addition & 1 deletion website/versioned_docs/version-0.18/scrollview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ original_id: scrollview

Component that wraps platform ScrollView while providing integration with touch locking "responder" system.

Keep in mind that ScrollViews must have a bounded height in order to work, since they contain unbounded-height children into a bounded container (via a scroll interaction). In order to bound the height of a ScrollView, either set the height of the view directly (discouraged) or make sure all parent views have bounded height. Forgetting to transfer `{flex: 1}` down the view stack can lead to errors here, which the element inspector makes easy to debug.
Keep in mind that ScrollViews must have a bounded height in order to work, since they contain unbounded-height children into a bounded container (via a scroll interaction). In order to bound the height of a ScrollView, either set the height of the view directly (discouraged) or make sure all parent views have bounded height. Forgetting to transfer `{flex: 1}` down the view stack can lead to errors here, which the element inspector helps to debug.

Doesn't yet support other contained responders from blocking this scroll view from becoming the responder.

Expand Down

0 comments on commit 4bcd62e

Please sign in to comment.