agentic-mobile-kit 0.0.1 → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +20 -8
- package/bin/cli.js +31 -5
- package/lib/init.js +199 -0
- package/package.json +17 -3
- package/stacks/react-native/template/.agents/skills/LICENSE-callstack +21 -0
- package/stacks/react-native/template/.agents/skills/THIRD_PARTY.md +9 -0
- package/stacks/react-native/template/.agents/skills/m-bugfix/SKILL.md +23 -0
- package/stacks/react-native/template/.agents/skills/m-bugfix/agents/openai.yaml +3 -0
- package/stacks/react-native/template/.agents/skills/m-continue/SKILL.md +22 -0
- package/stacks/react-native/template/.agents/skills/m-continue/agents/openai.yaml +3 -0
- package/stacks/react-native/template/.agents/skills/m-feature/SKILL.md +50 -0
- package/stacks/react-native/template/.agents/skills/m-feature/agents/openai.yaml +3 -0
- package/stacks/react-native/template/.agents/skills/m-pause/SKILL.md +14 -0
- package/stacks/react-native/template/.agents/skills/m-pause/agents/openai.yaml +3 -0
- package/stacks/react-native/template/.agents/skills/m-review/SKILL.md +29 -0
- package/stacks/react-native/template/.agents/skills/m-review/agents/openai.yaml +3 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/POWER.md +172 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/SKILL.md +238 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/agents/openai.yaml +4 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/bundle-analyze-app.md +208 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/bundle-analyze-js.md +264 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/bundle-barrel-exports.md +250 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/bundle-code-splitting.md +255 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/bundle-hermes-mmap.md +167 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/bundle-library-size.md +164 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/bundle-native-assets.md +208 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/bundle-r8-android.md +231 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/bundle-tree-shaking.md +215 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/js-animations-reanimated.md +273 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/js-atomic-state.md +190 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/js-bottomsheet.md +339 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/js-concurrent-react.md +238 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/js-lists-flatlist-flashlist.md +223 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/js-measure-fps.md +178 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/js-memory-leaks.md +168 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/js-profile-react.md +138 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/js-react-compiler.md +261 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/js-uncontrolled-components.md +219 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/native-android-16kb-alignment.md +114 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/native-measure-tti.md +221 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/native-memory-leaks.md +206 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/native-memory-patterns.md +240 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/native-platform-setup.md +112 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/native-profiling.md +140 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/native-sdks-over-polyfills.md +192 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/native-threading-model.md +230 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/native-turbo-modules.md +210 -0
- package/stacks/react-native/template/.agents/skills/react-native-best-practices/references/native-view-flattening.md +180 -0
- package/stacks/react-native/template/.agents/skills/react-navigation/SKILL.md +63 -0
- package/stacks/react-native/template/.agents/skills/react-navigation/agents/openai.yaml +4 -0
- package/stacks/react-native/template/.agents/skills/react-navigation/references/bottom-tabs.md +496 -0
- package/stacks/react-native/template/.agents/skills/react-navigation/references/drawers.md +474 -0
- package/stacks/react-native/template/.agents/skills/react-navigation/references/form-sheet.md +305 -0
- package/stacks/react-native/template/.agents/skills/react-navigation/references/header.md +270 -0
- package/stacks/react-native/template/.agents/skills/react-navigation/references/material-top-tabs.md +453 -0
- package/stacks/react-native/template/.agents/skills/react-navigation/references/native-bottom-tabs.md +365 -0
- package/stacks/react-native/template/.agents/skills/react-navigation/references/safe-areas.md +95 -0
- package/stacks/react-native/template/.agents/skills/react-navigation/references/stacks.md +392 -0
- package/stacks/react-native/template/.agents/skills/upgrading-react-native/SKILL.md +79 -0
- package/stacks/react-native/template/.agents/skills/upgrading-react-native/agents/openai.yaml +4 -0
- package/stacks/react-native/template/.agents/skills/upgrading-react-native/references/expo-sdk-upgrade.md +65 -0
- package/stacks/react-native/template/.agents/skills/upgrading-react-native/references/monorepo-singlerepo-targeting.md +34 -0
- package/stacks/react-native/template/.agents/skills/upgrading-react-native/references/react.md +42 -0
- package/stacks/react-native/template/.agents/skills/upgrading-react-native/references/upgrade-helper-core.md +122 -0
- package/stacks/react-native/template/.agents/skills/upgrading-react-native/references/upgrade-verification.md +53 -0
- package/stacks/react-native/template/.agents/skills/upgrading-react-native/references/upgrading-dependencies.md +41 -0
- package/stacks/react-native/template/.agents/skills/upgrading-react-native/references/upgrading-react-native.md +52 -0
- package/stacks/react-native/template/.githooks/pre-commit +49 -0
- package/stacks/react-native/template/.githooks/pre-push +5 -0
- package/stacks/react-native/template/.github/pull_request_template.md +19 -0
- package/stacks/react-native/template/.github/workflows/ci.yml +61 -0
- package/stacks/react-native/template/.github/workflows/ios.yml +43 -0
- package/stacks/react-native/template/.gitleaks.toml +12 -0
- package/stacks/react-native/template/.rulesync/hooks.jsonc +8 -0
- package/stacks/react-native/template/.rulesync/permissions.jsonc +36 -0
- package/stacks/react-native/template/.rulesync/subagents/m-reviewer.md +15 -0
- package/stacks/react-native/template/AGENTS.md +45 -0
- package/stacks/react-native/template/CLAUDE.md +1 -0
- package/stacks/react-native/template/docs/ai/conventions.md +8 -0
- package/stacks/react-native/template/docs/ai/decisions.md +6 -0
- package/stacks/react-native/template/docs/ai/known-issues.md +17 -0
- package/stacks/react-native/template/docs/ai/product.md +7 -0
- package/stacks/react-native/template/docs/ai/react-native.md +27 -0
- package/stacks/react-native/template/docs/ai/structure.md +7 -0
- package/stacks/react-native/template/docs/ai/team-process.md +9 -0
- package/stacks/react-native/template/docs/ai/tech.md +7 -0
- package/stacks/react-native/template/rulesync.jsonc +9 -0
- package/stacks/react-native/template/scripts/ai/guard.js +35 -0
- package/stacks/react-native/template/scripts/ai/handoff-check.js +28 -0
- package/stacks/react-native/template/scripts/ai/install-deps.sh +14 -0
- package/stacks/react-native/template/scripts/ai/ios-build.sh +11 -0
- package/stacks/react-native/template/scripts/ai/pm-run.sh +16 -0
- package/stacks/react-native/template/specs/_templates/design.md +15 -0
- package/stacks/react-native/template/specs/_templates/progress.md +14 -0
- package/stacks/react-native/template/specs/_templates/requirements.md +30 -0
- package/stacks/react-native/template/specs/_templates/tasks.md +6 -0
|
@@ -0,0 +1,474 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Drawer Navigator
|
|
3
|
+
impact: HIGH
|
|
4
|
+
tags: react-navigation, drawer, sidebar, master-detail, header, responsive-layout
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Skill: Drawer Navigator
|
|
8
|
+
|
|
9
|
+
## Description
|
|
10
|
+
|
|
11
|
+
Use `createDrawerNavigator` for a navigation drawer or sidebar that switches between app sections. If using a drawer for displaying content instead of navigation, use [`react-native-drawer-layout`](https://reactnavigation.org/docs/drawer-layout/) instead.
|
|
12
|
+
|
|
13
|
+
## When to Use
|
|
14
|
+
|
|
15
|
+
- Building app sections behind a drawer or sidebar
|
|
16
|
+
- Showing a permanent sidebar on larger screens and a drawer on smaller screens
|
|
17
|
+
- Using the drawer as the master pane in a master-detail layout
|
|
18
|
+
|
|
19
|
+
## Prerequisites
|
|
20
|
+
|
|
21
|
+
Install and configure `react-native-gesture-handler`, `react-native-reanimated`, and `react-native-worklets` for drawer navigator to work on native platforms.
|
|
22
|
+
|
|
23
|
+
## Basic Example
|
|
24
|
+
|
|
25
|
+
**Static API**
|
|
26
|
+
|
|
27
|
+
```tsx
|
|
28
|
+
import { createDrawerNavigator } from '@react-navigation/drawer';
|
|
29
|
+
|
|
30
|
+
const AppDrawer = createDrawerNavigator({
|
|
31
|
+
screens: {
|
|
32
|
+
Home: HomeScreen,
|
|
33
|
+
Profile: ProfileScreen,
|
|
34
|
+
},
|
|
35
|
+
});
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
**Dynamic API**
|
|
39
|
+
|
|
40
|
+
```tsx
|
|
41
|
+
import { createDrawerNavigator } from '@react-navigation/drawer';
|
|
42
|
+
|
|
43
|
+
const Drawer = createDrawerNavigator();
|
|
44
|
+
|
|
45
|
+
function AppDrawer() {
|
|
46
|
+
return (
|
|
47
|
+
<Drawer.Navigator>
|
|
48
|
+
<Drawer.Screen name="Home" component={HomeScreen} />
|
|
49
|
+
<Drawer.Screen name="Profile" component={ProfileScreen} />
|
|
50
|
+
</Drawer.Navigator>
|
|
51
|
+
);
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Opening and Closing the Drawer
|
|
56
|
+
|
|
57
|
+
Use `navigation.openDrawer()`, `navigation.closeDrawer()`, and `navigation.toggleDrawer()` inside drawer screens to open or close the drawer programmatically.
|
|
58
|
+
|
|
59
|
+
```tsx
|
|
60
|
+
import { Button, View } from 'react-native';
|
|
61
|
+
import { useNavigation } from '@react-navigation/native';
|
|
62
|
+
|
|
63
|
+
function HomeScreen() {
|
|
64
|
+
const navigation = useNavigation();
|
|
65
|
+
|
|
66
|
+
return (
|
|
67
|
+
<View>
|
|
68
|
+
<Button title="Open drawer" onPress={() => navigation.openDrawer()} />
|
|
69
|
+
<Button title="Close drawer" onPress={() => navigation.closeDrawer()} />
|
|
70
|
+
<Button title="Toggle drawer" onPress={() => navigation.toggleDrawer()} />
|
|
71
|
+
</View>
|
|
72
|
+
);
|
|
73
|
+
}
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## Nesting Drawers
|
|
77
|
+
|
|
78
|
+
When nesting a drawer inside another drawer, use [`react-native-drawer-layout`](https://reactnavigation.org/docs/drawer-layout/) for the outer drawer and keep Drawer navigator for the inner navigation drawer.
|
|
79
|
+
|
|
80
|
+
```tsx
|
|
81
|
+
import * as React from 'react';
|
|
82
|
+
import { Text } from 'react-native';
|
|
83
|
+
import { Drawer } from 'react-native-drawer-layout';
|
|
84
|
+
|
|
85
|
+
function App() {
|
|
86
|
+
const [rightDrawerOpen, setRightDrawerOpen] = React.useState(false);
|
|
87
|
+
|
|
88
|
+
return (
|
|
89
|
+
<Drawer
|
|
90
|
+
open={rightDrawerOpen}
|
|
91
|
+
onOpen={() => setRightDrawerOpen(true)}
|
|
92
|
+
onClose={() => setRightDrawerOpen(false)}
|
|
93
|
+
drawerPosition="right"
|
|
94
|
+
renderDrawerContent={() => <Text>Right drawer content</Text>}
|
|
95
|
+
>
|
|
96
|
+
<AppDrawer />
|
|
97
|
+
</Drawer>
|
|
98
|
+
);
|
|
99
|
+
}
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
Use React context to expose methods for opening or closing the outer drawer from nested screens.
|
|
103
|
+
|
|
104
|
+
## Common Features
|
|
105
|
+
|
|
106
|
+
### Displaying Icons
|
|
107
|
+
|
|
108
|
+
Use `drawerIcon` in `screenOptions` or per-screen `options`. `drawerActiveTintColor` and `drawerInactiveTintColor` control the color passed to the icon and label.
|
|
109
|
+
|
|
110
|
+
**Static API**
|
|
111
|
+
|
|
112
|
+
```tsx
|
|
113
|
+
import Ionicons from '@expo/vector-icons/Ionicons';
|
|
114
|
+
import { createDrawerNavigator } from '@react-navigation/drawer';
|
|
115
|
+
|
|
116
|
+
const AppDrawer = createDrawerNavigator({
|
|
117
|
+
screenOptions: ({ route }) => ({
|
|
118
|
+
drawerIcon: ({ color, size }) => {
|
|
119
|
+
let iconName;
|
|
120
|
+
|
|
121
|
+
switch (route.name) {
|
|
122
|
+
case 'Home':
|
|
123
|
+
iconName = 'home-outline';
|
|
124
|
+
break;
|
|
125
|
+
default:
|
|
126
|
+
iconName = 'person-outline';
|
|
127
|
+
break;
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
return <Ionicons name={iconName} size={size} color={color} />;
|
|
131
|
+
},
|
|
132
|
+
drawerActiveTintColor: 'tomato',
|
|
133
|
+
drawerInactiveTintColor: 'gray',
|
|
134
|
+
}),
|
|
135
|
+
screens: {
|
|
136
|
+
Home: HomeScreen,
|
|
137
|
+
Profile: ProfileScreen,
|
|
138
|
+
},
|
|
139
|
+
});
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
**Dynamic API**
|
|
143
|
+
|
|
144
|
+
```tsx
|
|
145
|
+
import Ionicons from '@expo/vector-icons/Ionicons';
|
|
146
|
+
import { createDrawerNavigator } from '@react-navigation/drawer';
|
|
147
|
+
|
|
148
|
+
const Drawer = createDrawerNavigator();
|
|
149
|
+
|
|
150
|
+
function AppDrawer() {
|
|
151
|
+
return (
|
|
152
|
+
<Drawer.Navigator
|
|
153
|
+
screenOptions={({ route }) => ({
|
|
154
|
+
drawerIcon: ({ color, size }) => {
|
|
155
|
+
let iconName;
|
|
156
|
+
|
|
157
|
+
switch (route.name) {
|
|
158
|
+
case 'Home':
|
|
159
|
+
iconName = 'home-outline';
|
|
160
|
+
break;
|
|
161
|
+
default:
|
|
162
|
+
iconName = 'person-outline';
|
|
163
|
+
break;
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
return <Ionicons name={iconName} size={size} color={color} />;
|
|
167
|
+
},
|
|
168
|
+
drawerActiveTintColor: 'tomato',
|
|
169
|
+
drawerInactiveTintColor: 'gray',
|
|
170
|
+
})}
|
|
171
|
+
>
|
|
172
|
+
<Drawer.Screen name="Home" component={HomeScreen} />
|
|
173
|
+
<Drawer.Screen name="Profile" component={ProfileScreen} />
|
|
174
|
+
</Drawer.Navigator>
|
|
175
|
+
);
|
|
176
|
+
}
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
The `drawerIcon` option can render any React element. Choose between the icon libraries that best fit the app's design and environment:
|
|
180
|
+
|
|
181
|
+
- `@expo/vector-icons` if Expo SDK is configured in the app
|
|
182
|
+
- `react-native-vector-icons` for an app using React Native Community CLI
|
|
183
|
+
- `<Image>` for local images
|
|
184
|
+
|
|
185
|
+
### Custom Drawer Content
|
|
186
|
+
|
|
187
|
+
Use `drawerContent` to customize the content of drawer, such as adding a header, footer, or custom actions, or replacing with a custom design.
|
|
188
|
+
|
|
189
|
+
Use `DrawerContentScrollView` to automatically adjust insets and `DrawerItemList` to keep default design. Use the `navigation` prop passed to the custom drawer content instead of `useNavigation`.
|
|
190
|
+
|
|
191
|
+
```tsx
|
|
192
|
+
import {
|
|
193
|
+
createDrawerNavigator,
|
|
194
|
+
DrawerContentScrollView,
|
|
195
|
+
DrawerItem,
|
|
196
|
+
DrawerItemList,
|
|
197
|
+
} from '@react-navigation/drawer';
|
|
198
|
+
|
|
199
|
+
function CustomDrawerContent(props) {
|
|
200
|
+
return (
|
|
201
|
+
<DrawerContentScrollView {...props}>
|
|
202
|
+
<DrawerItemList {...props} />
|
|
203
|
+
<DrawerItem
|
|
204
|
+
label="Help"
|
|
205
|
+
onPress={() => props.navigation.navigate('Help')}
|
|
206
|
+
/>
|
|
207
|
+
</DrawerContentScrollView>
|
|
208
|
+
);
|
|
209
|
+
}
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
Replace the content with own element if a different design is needed. Use the `state` prop to access the list of screens and `descriptors` to access the options for each screen.
|
|
213
|
+
|
|
214
|
+
**Static API**
|
|
215
|
+
|
|
216
|
+
```tsx
|
|
217
|
+
import { createDrawerNavigator } from '@react-navigation/drawer';
|
|
218
|
+
|
|
219
|
+
const AppDrawer = createDrawerNavigator({
|
|
220
|
+
drawerContent: (props) => <CustomDrawerContent {...props} />,
|
|
221
|
+
screens: {
|
|
222
|
+
Home: HomeScreen,
|
|
223
|
+
Profile: ProfileScreen,
|
|
224
|
+
Help: HelpScreen,
|
|
225
|
+
},
|
|
226
|
+
});
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
**Dynamic API**
|
|
230
|
+
|
|
231
|
+
```tsx
|
|
232
|
+
import { createDrawerNavigator } from '@react-navigation/drawer';
|
|
233
|
+
|
|
234
|
+
const Drawer = createDrawerNavigator();
|
|
235
|
+
|
|
236
|
+
function AppDrawer() {
|
|
237
|
+
return (
|
|
238
|
+
<Drawer.Navigator
|
|
239
|
+
drawerContent={(props) => <CustomDrawerContent {...props} />}
|
|
240
|
+
>
|
|
241
|
+
<Drawer.Screen name="Home" component={HomeScreen} />
|
|
242
|
+
<Drawer.Screen name="Profile" component={ProfileScreen} />
|
|
243
|
+
<Drawer.Screen name="Help" component={HelpScreen} />
|
|
244
|
+
</Drawer.Navigator>
|
|
245
|
+
);
|
|
246
|
+
}
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
### Types of Drawer
|
|
250
|
+
|
|
251
|
+
Use `drawerType` to choose how the drawer behaves.
|
|
252
|
+
|
|
253
|
+
Choose between `front`, `back`, and `slide` on smaller screens. Use `permanent` for a sidebar on larger screens. Use `useWindowDimensions` to conditionally set the type based on screen width for responsive layouts.
|
|
254
|
+
|
|
255
|
+
**Static API**
|
|
256
|
+
|
|
257
|
+
```tsx
|
|
258
|
+
import { useWindowDimensions } from 'react-native';
|
|
259
|
+
import { createDrawerNavigator } from '@react-navigation/drawer';
|
|
260
|
+
|
|
261
|
+
const AppDrawer = createDrawerNavigator({
|
|
262
|
+
screens: {
|
|
263
|
+
Home: HomeScreen,
|
|
264
|
+
Profile: ProfileScreen,
|
|
265
|
+
},
|
|
266
|
+
}).with(({ Navigator }) => {
|
|
267
|
+
const { width } = useWindowDimensions();
|
|
268
|
+
|
|
269
|
+
return (
|
|
270
|
+
<Navigator
|
|
271
|
+
screenOptions={{
|
|
272
|
+
drawerType: width >= 768 ? 'permanent' : 'front',
|
|
273
|
+
}}
|
|
274
|
+
/>
|
|
275
|
+
);
|
|
276
|
+
});
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
**Dynamic API**
|
|
280
|
+
|
|
281
|
+
```tsx
|
|
282
|
+
import { useWindowDimensions } from 'react-native';
|
|
283
|
+
import { createDrawerNavigator } from '@react-navigation/drawer';
|
|
284
|
+
|
|
285
|
+
const Drawer = createDrawerNavigator();
|
|
286
|
+
|
|
287
|
+
function AppDrawer() {
|
|
288
|
+
const { width } = useWindowDimensions();
|
|
289
|
+
|
|
290
|
+
return (
|
|
291
|
+
<Drawer.Navigator
|
|
292
|
+
screenOptions={{
|
|
293
|
+
drawerType: width >= 768 ? 'permanent' : 'front',
|
|
294
|
+
}}
|
|
295
|
+
>
|
|
296
|
+
<Drawer.Screen name="Home" component={HomeScreen} />
|
|
297
|
+
<Drawer.Screen name="Profile" component={ProfileScreen} />
|
|
298
|
+
</Drawer.Navigator>
|
|
299
|
+
);
|
|
300
|
+
}
|
|
301
|
+
```
|
|
302
|
+
|
|
303
|
+
### Drawer Position
|
|
304
|
+
|
|
305
|
+
Use `drawerPosition` to place the drawer on the left or right side. The default is `left` in LTR languages and `right` in RTL languages.
|
|
306
|
+
|
|
307
|
+
**Static API**
|
|
308
|
+
|
|
309
|
+
```tsx
|
|
310
|
+
import { createDrawerNavigator } from '@react-navigation/drawer';
|
|
311
|
+
|
|
312
|
+
const AppDrawer = createDrawerNavigator({
|
|
313
|
+
screenOptions: {
|
|
314
|
+
drawerPosition: 'right',
|
|
315
|
+
},
|
|
316
|
+
screens: {
|
|
317
|
+
Home: HomeScreen,
|
|
318
|
+
Profile: ProfileScreen,
|
|
319
|
+
},
|
|
320
|
+
});
|
|
321
|
+
```
|
|
322
|
+
|
|
323
|
+
**Dynamic API**
|
|
324
|
+
|
|
325
|
+
```tsx
|
|
326
|
+
import { createDrawerNavigator } from '@react-navigation/drawer';
|
|
327
|
+
|
|
328
|
+
const Drawer = createDrawerNavigator();
|
|
329
|
+
|
|
330
|
+
function AppDrawer() {
|
|
331
|
+
return (
|
|
332
|
+
<Drawer.Navigator
|
|
333
|
+
screenOptions={{
|
|
334
|
+
drawerPosition: 'right',
|
|
335
|
+
}}
|
|
336
|
+
>
|
|
337
|
+
<Drawer.Screen name="Home" component={HomeScreen} />
|
|
338
|
+
<Drawer.Screen name="Profile" component={ProfileScreen} />
|
|
339
|
+
</Drawer.Navigator>
|
|
340
|
+
);
|
|
341
|
+
}
|
|
342
|
+
```
|
|
343
|
+
|
|
344
|
+
### Master Detail Layout
|
|
345
|
+
|
|
346
|
+
Combine `defaultStatus: 'open'` with `drawerType: 'back'` when the drawer should start open and behave like the master pane behind the detail screen.
|
|
347
|
+
|
|
348
|
+
**Static API**
|
|
349
|
+
|
|
350
|
+
```tsx
|
|
351
|
+
import { createDrawerNavigator } from '@react-navigation/drawer';
|
|
352
|
+
|
|
353
|
+
const AppDrawer = createDrawerNavigator({
|
|
354
|
+
defaultStatus: 'open',
|
|
355
|
+
screenOptions: {
|
|
356
|
+
drawerType: 'back',
|
|
357
|
+
drawerStyle: { width: '100%' },
|
|
358
|
+
overlayColor: 'transparent',
|
|
359
|
+
},
|
|
360
|
+
screens: {
|
|
361
|
+
Inbox: InboxScreen,
|
|
362
|
+
Message: MessageScreen,
|
|
363
|
+
},
|
|
364
|
+
});
|
|
365
|
+
```
|
|
366
|
+
|
|
367
|
+
**Dynamic API**
|
|
368
|
+
|
|
369
|
+
```tsx
|
|
370
|
+
import { createDrawerNavigator } from '@react-navigation/drawer';
|
|
371
|
+
|
|
372
|
+
const Drawer = createDrawerNavigator();
|
|
373
|
+
|
|
374
|
+
function AppDrawer() {
|
|
375
|
+
return (
|
|
376
|
+
<Drawer.Navigator
|
|
377
|
+
defaultStatus="open"
|
|
378
|
+
screenOptions={{
|
|
379
|
+
drawerType: 'back',
|
|
380
|
+
drawerStyle: { width: '100%' },
|
|
381
|
+
overlayColor: 'transparent',
|
|
382
|
+
}}
|
|
383
|
+
>
|
|
384
|
+
<Drawer.Screen name="Inbox" component={InboxScreen} />
|
|
385
|
+
<Drawer.Screen name="Message" component={MessageScreen} />
|
|
386
|
+
</Drawer.Navigator>
|
|
387
|
+
);
|
|
388
|
+
}
|
|
389
|
+
```
|
|
390
|
+
|
|
391
|
+
With `defaultStatus: 'open'`, the drawer's default state is open. So if drawer is closed, the back button will open it.
|
|
392
|
+
|
|
393
|
+
### Customizing Header
|
|
394
|
+
|
|
395
|
+
Drawer screens show a header by default. Use [header.md](./header.md) for common customization patterns.
|
|
396
|
+
|
|
397
|
+
A custom header can be shown with the `header` option if a custom design is needed.
|
|
398
|
+
|
|
399
|
+
**Static API**
|
|
400
|
+
|
|
401
|
+
```tsx
|
|
402
|
+
import { getHeaderTitle } from '@react-navigation/elements';
|
|
403
|
+
import { createDrawerNavigator } from '@react-navigation/drawer';
|
|
404
|
+
|
|
405
|
+
const AppDrawer = createDrawerNavigator({
|
|
406
|
+
screens: {
|
|
407
|
+
Home: {
|
|
408
|
+
screen: HomeScreen,
|
|
409
|
+
options: {
|
|
410
|
+
headerStyle: {
|
|
411
|
+
height: 80,
|
|
412
|
+
},
|
|
413
|
+
header: ({ route, options }) => {
|
|
414
|
+
const title = getHeaderTitle(options, route.name);
|
|
415
|
+
|
|
416
|
+
return <MyHeader title={title} style={options.headerStyle} />;
|
|
417
|
+
},
|
|
418
|
+
},
|
|
419
|
+
},
|
|
420
|
+
},
|
|
421
|
+
});
|
|
422
|
+
```
|
|
423
|
+
|
|
424
|
+
**Dynamic API**
|
|
425
|
+
|
|
426
|
+
```tsx
|
|
427
|
+
import { getHeaderTitle } from '@react-navigation/elements';
|
|
428
|
+
import { createDrawerNavigator } from '@react-navigation/drawer';
|
|
429
|
+
|
|
430
|
+
const Drawer = createDrawerNavigator();
|
|
431
|
+
|
|
432
|
+
function AppDrawer() {
|
|
433
|
+
return (
|
|
434
|
+
<Drawer.Navigator>
|
|
435
|
+
<Drawer.Screen
|
|
436
|
+
name="Home"
|
|
437
|
+
component={HomeScreen}
|
|
438
|
+
options={{
|
|
439
|
+
headerStyle: {
|
|
440
|
+
height: 80,
|
|
441
|
+
},
|
|
442
|
+
header: ({ route, options }) => {
|
|
443
|
+
const title = getHeaderTitle(options, route.name);
|
|
444
|
+
|
|
445
|
+
return <MyHeader title={title} style={options.headerStyle} />;
|
|
446
|
+
},
|
|
447
|
+
}}
|
|
448
|
+
/>
|
|
449
|
+
</Drawer.Navigator>
|
|
450
|
+
);
|
|
451
|
+
}
|
|
452
|
+
```
|
|
453
|
+
|
|
454
|
+
- Set `headerShown: false` to hide the header.
|
|
455
|
+
- If a custom header uses a non-default height, set `headerStyle: { height: ... }` explicitly to avoid measurement glitches.
|
|
456
|
+
|
|
457
|
+
## Notes
|
|
458
|
+
|
|
459
|
+
- Swipe gestures and gesture-handler customization are not supported on web.
|
|
460
|
+
- If a drawer is nested under a stack or tab navigator, it renders below that parent navigator's header or tab bar.
|
|
461
|
+
|
|
462
|
+
## Canonical Docs
|
|
463
|
+
|
|
464
|
+
- [Drawer Navigator](https://reactnavigation.org/docs/drawer-navigator)
|
|
465
|
+
- [Multiple drawers](https://reactnavigation.org/docs/multiple-drawers)
|
|
466
|
+
- [Static configuration](https://reactnavigation.org/docs/static-configuration)
|
|
467
|
+
- [Configuring the header bar](https://reactnavigation.org/docs/headers)
|
|
468
|
+
|
|
469
|
+
## Related Skills
|
|
470
|
+
|
|
471
|
+
- [header.md](./header.md)
|
|
472
|
+
- [bottom-tabs.md](./bottom-tabs.md)
|
|
473
|
+
- [stacks.md](./stacks.md)
|
|
474
|
+
- [safe-areas.md](./safe-areas.md)
|