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

chore: revamp the cookbook app #1635

Merged
merged 9 commits into from
Jul 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions examples/cookbook/App.tsx

This file was deleted.

8 changes: 5 additions & 3 deletions examples/cookbook/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# RNTL Cookbook

This example app gathers recipes from the [RNTL Cookbook](https://callstack.github.io/react-native-testing-library/cookbook).
This example app gathers recipes from
the [RNTL Cookbook](https://callstack.github.io/react-native-testing-library/cookbook).

Each recipe described in the Cookbook should have a corresponding code example in this repo.
Each recipe described in the Cookbook should have a corresponding code example screen in this repo.

Note:
Since examples will showcase usage of different dependencies, the dependencies in `package.json` fill will grow much larger that in an normal React Native. This is fine 🐶☕️🔥.
Since examples will showcase usage of different dependencies, the dependencies in `package.json`
file will grow much larger that in a normal React Native. This is fine 🐶☕️🔥.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import * as React from 'react';
import { screen } from '@testing-library/react-native';
import { renderWithProviders } from './test-utils';
import { WelcomeScreen } from './WelcomeScreen';
import WelcomeScreen from "../../../app/custom-render";

test('renders WelcomeScreen in light theme', () => {
renderWithProviders(<WelcomeScreen />, { theme: 'light' });
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import * as React from 'react';
import { render } from '@testing-library/react-native';
import { User, UserProvider } from './providers/user-provider';
import { Theme, ThemeProvider } from './providers/theme-provider';
import { User, UserProvider } from '../../../app/custom-render/providers/user-provider';
import { Theme, ThemeProvider } from '../../../app/custom-render/providers/theme-provider';

interface RenderWithProvidersProps {
user?: User | null;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import * as React from 'react';
import { render, screen, userEvent } from '@testing-library/react-native';
import TaskList from '../../../app/jotai';
import { renderWithAtoms } from './test-utils';
import { TaskList } from './TaskList';
import { addTask, getAllTasks, newTaskTitleAtom, store, tasksAtom } from './state';
import { Task } from './types';
import { Task } from '../../../app/jotai/types';
import { addTask, getAllTasks, newTaskTitleAtom, store, tasksAtom } from '../../../app/jotai/state';

jest.useFakeTimers();

Expand Down
23 changes: 19 additions & 4 deletions examples/cookbook/app.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,22 @@
"expo": {
"name": "RNTL Cookbook App",
"slug": "rntl-cookbook",
"scheme": "rntlcookbook",
"version": "1.0.0",
"orientation": "portrait",
"icon": "./assets/icon.png",
"userInterfaceStyle": "light",
"splash": {
"image": "./assets/splash.png",
"resizeMode": "contain",
"backgroundColor": "#ffffff"
"resizeMode": "cover",
"backgroundColor": "#FFFFFF"
},
"updates": {
"fallbackToCacheTimeout": 0
},
"assetBundlePatterns": ["**/*"],
"assetBundlePatterns": [
"**/*"
],
"ios": {
"supportsTablet": true
},
Expand All @@ -26,6 +29,18 @@
},
"web": {
"favicon": "./assets/favicon.png"
}
},
"plugins": [
"expo-router",
[
"expo-font",
{
"fonts": [
"./assets/fonts/OpenSans-Regular.ttf",
"./assets/fonts/OpenSans-Bold.ttf"
]
}
]
]
}
}
21 changes: 21 additions & 0 deletions examples/cookbook/app/_layout.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import { Stack } from 'expo-router';
import theme from '../theme';

export default function RootLayout() {
return (
<Stack
screenOptions={{
headerStyle: {
backgroundColor: theme.colors.primary,
},
headerTintColor: '#fff',
headerTitleStyle: {
fontWeight: 'bold',
},
headerBackTitleVisible: false,
}}
>
<Stack.Screen name="index" options={{ headerTitle: '' }} />
</Stack>
);
}
13 changes: 13 additions & 0 deletions examples/cookbook/app/custom-render/_layout.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import { Slot } from 'expo-router';
import { UserProvider } from './providers/user-provider';
import { ThemeProvider } from './providers/theme-provider';

export default function CustomRenderLayout() {
return (
<UserProvider.Provider value={null}>
<ThemeProvider.Provider value={'light'}>
<Slot />
</ThemeProvider.Provider>
</UserProvider.Provider>
);
}
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
import * as React from 'react';
import { View, Text } from 'react-native';
import { Text, View } from 'react-native';
import { useUser } from './providers/user-provider';
import { useTheme } from './providers/theme-provider';

export function WelcomeScreen() {
export default function WelcomeScreen() {
const theme = useTheme();
const user = useUser();

return (
<View>
<View style={{ flex: 1, alignItems: 'center', justifyContent: 'center' }}>
<Text>Hello {user ? user.name : 'Stranger'}</Text>
<Text>Theme: {theme}</Text>
</View>
Expand Down
105 changes: 105 additions & 0 deletions examples/cookbook/app/index.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
import React, {useCallback, useEffect} from 'react';
import { FlatList, Image, Pressable, StyleSheet, Text, View } from 'react-native';
import { useRouter } from 'expo-router';
import * as SplashScreen from 'expo-splash-screen';
import { useFonts } from 'expo-font';
import theme from '../theme';

void SplashScreen.preventAutoHideAsync();

export default function Home() {
const router = useRouter();
const [loaded, error] = useFonts({
'OpenSans-Bold': require('../assets/fonts/OpenSans-Bold.ttf'),
'OpenSans-Regular': require('../assets/fonts/OpenSans-Regular.ttf'),
});

useEffect(() => {
if (loaded || error) {
void SplashScreen.hideAsync();
}
}, [loaded, error]);

if (!loaded && !error) {
return null;
}
const renderItem = useCallback(({ item }: {item: Recipe}) => (
<Pressable style={styles.pressable} onPress={() => router.push(item.path)}>
<Text style={styles.pressableText}>{item.title}</Text>
</Pressable>
),[]);

return (
<View style={styles.container}>
<View style={styles.bannerContainer}>
<Image source={require('../assets/icon.png')} style={styles.logo} />
<Image
resizeMode={'contain'}
source={require('../assets/gradientRNBanner.png')}
style={styles.banner}
/>
<Text style={styles.title}>Testing Library</Text>
<Text style={styles.subTitle}>Cookbook App</Text>
</View>
<FlatList<Recipe>
data={recipes}
renderItem={renderItem}
keyExtractor={(item) => item.id.toString()}
/>
</View>
);
}

const styles = StyleSheet.create({
container: {
flex: 1,
justifyContent: 'center',
alignItems: 'center',
backgroundColor: '#F5F5F5',
paddingVertical: 20,
},
bannerContainer: {
alignItems: 'center',
marginBottom: 20,
},
title: {
fontSize: 20,
fontFamily: 'OpenSans-Bold',
color: theme.colors.black,
},
subTitle: {
fontSize: 14,
fontFamily: 'OpenSans-Regular',
color: theme.colors.gray,
},
banner: {
height: 40,
},
logo: {
width: 80,
height: 80,
marginBottom: 20,
},
pressable: {
backgroundColor: '#9b6dff',
padding: 12,
marginBottom: 8,
borderRadius: 16,
},
pressableText: {
color: '#fff',
fontSize: 14,
fontFamily: 'OpenSans-Bold',
textAlign: 'center',
},
});

type Recipe = {
id: number;
title: string;
path: string;
};
const recipes: Recipe[] = [
{ id: 2, title: 'Welcome Screen with Custom Render', path: 'custom-render/' },
{ id: 1, title: 'Task List with Jotai', path: 'jotai/' },
];
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
import 'react-native-get-random-values';
import { nanoid } from 'nanoid';
import * as React from 'react';
import { Pressable, Text, TextInput, View } from 'react-native';
import { useAtom } from 'jotai';
import { nanoid } from 'nanoid';
import { newTaskTitleAtom, tasksAtom } from './state';

export function TaskList() {
export default function TaskList() {
const [tasks, setTasks] = useAtom(tasksAtom);
const [newTaskTitle, setNewTaskTitle] = useAtom(newTaskTitleAtom);

Expand All @@ -20,7 +21,7 @@ export function TaskList() {
};

return (
<View>
<View style={{ flex: 1, alignItems: 'center', justifyContent: 'center' }}>
{tasks.map((task) => (
<Text key={task.id} testID="task-item">
{task.title}
Expand Down
File renamed without changes.
File renamed without changes.
Binary file modified examples/cookbook/assets/adaptive-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified examples/cookbook/assets/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added examples/cookbook/assets/fonts/OpenSans-Bold.ttf
Binary file not shown.
Binary file not shown.
Binary file added examples/cookbook/assets/gradientRNBanner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified examples/cookbook/assets/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified examples/cookbook/assets/splash.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions examples/cookbook/jest.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ module.exports = {
preset: '@testing-library/react-native',
moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json'],
setupFilesAfterEnv: ['./jest-setup.ts'],
testMatch: ['**/*.test.{ts,tsx}'],
};
11 changes: 10 additions & 1 deletion examples/cookbook/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"main": "node_modules/expo/AppEntry.js",
"main": "expo-router/entry",
"scripts": {
"start": "expo start",
"android": "expo start --android",
Expand All @@ -12,20 +12,29 @@
},
"dependencies": {
"expo": "^50.0.4",
"expo-constants": "~15.4.6",
"expo-font": "~11.10.3",
"expo-linking": "~6.2.2",
"expo-router": "~3.4.10",
"expo-status-bar": "~1.11.1",
"jotai": "^2.8.4",
"nanoid": "^3.3.7",
"react": "18.2.0",
"react-dom": "18.2.0",
"react-native": "0.73.2",
"react-native-get-random-values": "~1.8.0",
"react-native-safe-area-context": "4.8.2",
"react-native-screens": "~3.29.0",
"react-native-web": "~0.19.6"
},
"devDependencies": {
"@babel/core": "^7.20.0",
"@expo/metro-runtime": "~3.1.3",
"@testing-library/react-native": "^12.4.0",
"@types/eslint": "^8.56.10",
"@types/jest": "^29.5.12",
"@types/react": "~18.2.45",
"@types/react-native-get-random-values": "^1",
"eslint": "^8.57.0",
"jest": "^29.7.0",
"react-test-renderer": "18.2.0",
Expand Down
8 changes: 8 additions & 0 deletions examples/cookbook/theme.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
export default {
colors: {
primary: '#9b6dff',
secondary: '#58baad',
black: '#323232',
gray: '#5b5a5b',
},
};
Loading