You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore: Remove other mentions of legacy Example app (#3642)
## Description
This PR removes some leftover mentions of legacy Example app.
## Changes
Removed text instance of Example/ScreensExample. Removed
NEW_ARCH_ENABLED env from podfile (it's default now, and was put for
consistency with now removed Example)
## Before & after - visual documentation
no visual changes
## Checklist
- [ ] Ensured that CI passes
Copy file name to clipboardExpand all lines: guides/CONTRIBUTING.md
+6-9Lines changed: 6 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,7 +41,6 @@ We inform you that unrespectful issues will be closed.
41
41
-`common`– C++ code related to components - shadow nodes and state
42
42
-`cpp`– C++ code for turbo modules
43
43
-`apps`– apps implementations shared by wrappers
44
-
-`Example`– paper version of React Native mobile example app from apps
45
44
-`FabricExample`– fabric version of React Native mobile example app from apps
46
45
-`gesture-handler`– interop between react-native-screens and react-native-gesture-handler
47
46
-`guides`– guides for developers
@@ -72,13 +71,11 @@ Submitting Pull Requests that resolve issues is a great way to contribute to Scr
72
71
> [!tip]
73
72
> For commits and pull request names we follow a [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
74
73
75
-
We have two types of sources: pure examples (apps/Example for source code) and examples, dedicated for tests from issues / pull requests (apps/src/tests for source code). The first work as a showcase of the library, the latter contains specific test cases that corresponds to GitHub issues. For example, `Test1864.tsx` corresponds to issue [#1864](https://github.com/software-mansion/react-native-screens/issues/1864). Our developer flow usually consists of creating new `Test*.tsx` file with code example that we try to fix or add. For new features we try to prepare showcases in Example app. The `apps/App` file is where you set the source code for the application to use by either leaving `<Example>` as is or replacing it with `<Test.Test*>`.
76
-
There are two separate applications: Example and FabricExample in root which are used as wrappers for running the examples depending on the architecture needed.
74
+
We have two types of sources: pure examples (apps/Example for source code) and examples, dedicated for tests from issues / pull requests (apps/src/tests for source code). The former work as a showcase of the library, the latter contain isolated props' behavior, selected interactions between props, and specific test cases that corresponds to GitHub issues. For example, `Test1864.tsx` corresponds to issue [#1864](https://github.com/software-mansion/react-native-screens/issues/1864). Our developer flow usually consists of creating new `Test*.tsx` file with code example that we try to fix or add. For new features we try to prepare dedicated showcases. The `apps/App` file is where you set the source code for the application to use by either leaving `<Example>` as is or replacing it with `<Test.Test*>`.
77
75
78
76
-`apps/Example`– source code with showcase app
79
77
-`apps/src/tests`– source code with test examples app
80
78
-`apps/App`– source code management
81
-
-`Example/src`– wrapper with paper architecture for showcase and test examples app
82
79
-`FabricExample/src`– wrapper with fabric architecture for showcase and test examples app
83
80
-`TVOSExample/src`– source code with example app for TVOS
84
81
-`src`– contains JS core code of the library
@@ -91,11 +88,11 @@ To begin with, let install all dependencies:
91
88
92
89
1.`yarn`
93
90
2.`yarn submodules`
94
-
4.`cd Example` or `cd FabricExample` (depending on architecture you want to work on)
91
+
4.`cd FabricExample`
95
92
5.`yarn`
96
93
6.`yarn start`– make sure to start metro bundler before building the app in Android Studio
97
94
98
-
and open `react-native-screens/Example/android` with Android Studio.
95
+
and open `react-native-screens/FabricExample/android` with Android Studio.
99
96
100
97

101
98
@@ -107,17 +104,17 @@ To begin with, let install all dependencies:
107
104
108
105
1.`yarn`
109
106
2.`yarn submodules`
110
-
3.`cd Example` or `cd FabricExample`
107
+
3.`cd FabricExample`
111
108
4.`yarn`
112
109
5.`rbenv exec bundle install`
113
110
6.`(cd ios && rbenv exec bundle exec pod install && cd ../)`
114
111
7.`yarn start`– make sure to start metro bundler before building the app in XCode.
115
112
116
-
and open `react-native-screens/Example/ios/ScreensExample.xcworkspace` with XCode.
113
+
and open `react-native-screens/FabricExample/ios/FabricExample.xcworkspace` with XCode.
117
114
118
115

119
116
120
-
To find the native source code of `react-native-screens` navigate to `Pods > Development Pods > RNScreens > ScreensExample > node_modules > react-native-screens > ios` or `Pods > Development Pods > RNScreens > .. > ScreensExample > node_modules > react-native-screens > ios`. Making sure metro builder is run, you can now build React Native app or debug native code.
117
+
To find the native source code of `react-native-screens` navigate to `Pods > Development Pods > RNScreens > FabricExample > node_modules > react-native-screens > ios` or `Pods > Development Pods > RNScreens > .. > FabricExample > node_modules > react-native-screens > ios`. Making sure metro builder is run, you can now build React Native app or debug native code.
Copy file name to clipboardExpand all lines: guides/GUIDE_FOR_LIBRARY_AUTHORS.md
-4Lines changed: 0 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -854,16 +854,12 @@ In order for your native view on iOS to be notified when its parent navigation c
854
854
}
855
855
```
856
856
857
-
You can check our example app for a fully functional demo see [RNSSampleLifecycleAwareView.m](https://github.com/software-mansion/react-native-screens/blob/main/Example/ios/ScreensExample/RNSSampleLifecycleAwareView.m) for more details.
858
-
859
857
## Navigation lifecycle on Android
860
858
861
859
On Android, you can use [LifecycleObserver](https://developer.android.com/reference/android/arch/lifecycle/LifecycleObserver) interface which is a part of Android compat library to make your view handle lifecycle events.
862
-
Check [LifecycleAwareView.java](https://github.com/software-mansion/react-native-screens/blob/main/Example/android/app/src/main/java/com/swmansion/rnscreens/example/LifecycleAwareView.java) from our example app for more details on that.
863
860
864
861
In addition to that, you will need to register for receiving these updates. This can be done using [`LifecycleHelper.register`](https://github.com/software-mansion/react-native-screens/blob/main/android/src/main/java/com/swmansion/rnscreens/LifecycleHelper.java#L50).
865
862
Remember to call [`LifecycleHelper.unregister`](https://github.com/software-mansion/react-native-screens/blob/main/android/src/main/java/com/swmansion/rnscreens/LifecycleHelper.java#L59) before the view is dropped.
866
-
Please refer to [SampleLifecycleAwareViewManager.java](https://github.com/software-mansion/react-native-screens/blob/main/Example/android/app/src/main/java/com/swmansion/rnscreens/example/SampleLifecycleAwareViewManager.java) from our example app to see what are the best ways of using the above methods.
0 commit comments