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

doc: added important tip when using android device #4357

Merged
merged 7 commits into from
Apr 13, 2023

Conversation

ace-builds
Copy link
Contributor

Summary

This pull request aims to improve the documentation on Events Fundamentals by adding instructions for how to set up event handlers on Android devices. Many developers, including myself, have had issues practicing the example on Android devices, which can be confusing for those who are not familiar with react-native-gesture-handler.

This addition would make it easier for developers to practice using event handlers with react-native-reanimated on Android devices directly from the docs and help avoid spending time researching why it isn't working.

Changes Made

This pull request adds a new section to the Events Fundamentals documentation that explains how to enable event handlers on Android devices. It includes simple instructions and code example to help developers enable the event handlers.

Test plan

As this is a documentation update, tests are not applicable. However, reviewers can follow the instructions provided in the new section and verify that the event handlers are working correctly on Android devices.

Copy link
Member

@tomekzaw tomekzaw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @Chinedu19, thanks for the PR, I've left some suggestions in the comments.

docs/docs/fundamentals/events.md Outdated Show resolved Hide resolved
docs/docs/fundamentals/events.md Outdated Show resolved Hide resolved
@ace-builds
Copy link
Contributor Author

I've implemented the changes you requested

Co-authored-by: Krzysztof Piaskowy <krzysztof.piaskowy@swmansion.com>
@ace-builds
Copy link
Contributor Author

@piaskowyk suggestion implemented

@tomekzaw
Copy link
Member

@Chinedu19 Thanks, can you please propagate this change to docs/versioned_docs/version-2.x/fundamentals/events.md as well?

@ace-builds
Copy link
Contributor Author

@Chinedu19 Thanks, can you please propagate this change to docs/versioned_docs/version-2.x/fundamentals/events.md as well?

Done

Copy link
Member

@tomekzaw tomekzaw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏

@tomekzaw tomekzaw added this pull request to the merge queue Apr 13, 2023
Merged via the queue into software-mansion:main with commit 2e47c4a Apr 13, 2023
fluiddot pushed a commit to wordpress-mobile/react-native-reanimated that referenced this pull request Jun 5, 2023
…4357)

<!-- Thanks for submitting a pull request! We appreciate you spending
the time to work on these changes. Please follow the template so that
the reviewers can easily understand what the code changes affect. -->

## Summary

<!-- Explain the motivation for this PR. Include "Fixes #<number>" if
applicable. -->
This pull request aims to improve the documentation on [Events
Fundamentals](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/events/)
by adding instructions for how to set up event handlers on Android
devices. Many developers, including myself, have had issues practicing
the example on Android devices, which can be confusing for those who are
not familiar with *react-native-gesture-handler*.

This addition would make it easier for developers to practice using
event handlers with *react-native-reanimated* on Android devices
directly from the docs and help avoid spending time researching why it
isn't working.

## Changes Made
This pull request adds a new section to the Events Fundamentals
documentation that explains how to enable event handlers on Android
devices. It includes simple instructions and code example to help
developers enable the event handlers.

## Test plan
<!-- Provide a minimal but complete code snippet that can be used to
test out this change along with instructions how to run it and a
description of the expected behavior. -->
As this is a documentation update, tests are not applicable. However,
reviewers can follow the instructions provided in the new section and
verify that the event handlers are working correctly on Android devices.

---------

Co-authored-by: Tomek Zawadzki <tomekzawadzki98@gmail.com>
Co-authored-by: Krzysztof Piaskowy <krzysztof.piaskowy@swmansion.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants