Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added style prop to TranslateYAndOpacity and documentation #40

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 13 additions & 0 deletions src/TranslateY/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# TranslateYAndOpacity

## Properties

| Property | Description | Default |
| ----------- | ----------- | ------- |
| `type` | Sets the animation type. | `timing` |
| `value` | Sets the current Y position. | `null` |
| `duration` | The number of milliseconds each iteration of the animation takes to complete. | `500` |
| `delay` | The number of milliseconds to delay the start of the animation. | `0` |
| `initialValue` | Sets the initial Y position from where the element will start the animation up to the current value. | `null` |
| `animateOnDidMount` | Start the animation when the component is mounted. | `false` |
| `useNativeDriver` | Uses the native driver when true. | `false` |
4 changes: 4 additions & 0 deletions src/TranslateY.js → src/TranslateY/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,17 @@ import PropTypes from 'prop-types';
const propTypes = {
type: PropTypes.string,
value: PropTypes.number,
duration: PropTypes.number, // eslint-disable-line react/no-unused-prop-types
delay: PropTypes.number, // eslint-disable-line react/no-unused-prop-types
initialValue: PropTypes.number,
startOnDidMount: PropTypes.bool,
useNativeDriver: PropTypes.bool,
};
const defaultProps = {
type: 'timing',
value: 0,
duration: 500,
delay: 0,
initialValue: null,
startOnDidMount: false,
useNativeDriver: true,
Expand Down
12 changes: 12 additions & 0 deletions src/TranslateYAndOpacity/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# TranslateYAndOpacity

## Properties

| Property | Description | Default |
| ----------- | ----------- | ------- |
| `opacityMin` | Sets the minimum opacity. | `0` |
| `translateYMin` | Sets the initial Y position from where the element will start the animation up to 0. | `-4` |
| `duration` | The number of milliseconds each iteration of the animation takes to complete. | `500` |
| `delay` | The number of milliseconds to delay the start of the animation. | `0` |
| `animateOnDidMount` | Start the animation when the component is mounted. | `false` |
| `useNativeDriver` | Uses the native driver when true. | `true` |
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@ const propTypes = {
opacityMin: PropTypes.number,
translateYMin: PropTypes.number,
duration: PropTypes.number, // eslint-disable-line react/no-unused-prop-types
animateOnDidMount: PropTypes.bool,
delay: PropTypes.number, // eslint-disable-line react/no-unused-prop-types
animateOnDidMount: PropTypes.bool,
useNativeDriver: PropTypes.bool, // eslint-disable-line react/no-unused-prop-types
};
const defaultProps = {
opacityMin: 0,
translateYMin: -4,
duration: 500,
animateOnDidMount: false,
delay: 0,
useNativeDriver: false,
animateOnDidMount: false,
useNativeDriver: true,
};

class TranslateYAndOpacity extends PureComponent {
Expand Down Expand Up @@ -88,15 +88,17 @@ class TranslateYAndOpacity extends PureComponent {
});
}
render() {
const { children } = this.props;
const { style, children } = this.props;
const { opacityValue, translateYValue } = this.state;

const animatedStyle = {
opacity: opacityValue,
transform: [{ translateY: translateYValue }],
};

return <Animated.View style={animatedStyle}>{children}</Animated.View>;
return (
<Animated.View style={[style, animatedStyle]}>{children}</Animated.View>
);
}
}

Expand Down