README.md
1
2Android BasicImmersiveMode Sample
3===================================
4
5Sample demonstrating the use of immersive mode to hide the system and navigation bars for
6full screen applications.
7
8Introduction
9------------
10
11'Immersive Mode' is a new UI mode which improves 'hide full screen' and 'hide nav bar'
12modes, by letting users swipe the bars in and out.
13
14This sample demonstrates how to enable and disable immersive mode programmatically.
15
16Immersive mode was introduced in Android 4.4 (Api Level 19). It is toggled using the
17SYSTEM_UI_FLAG_IMMERSIVE system ui flag. When combined with the SYSTEM_UI_FLAG_HIDE_NAVIGATION and SYSTEM_UI_FLAG_FULLSCREEN flags, hides the navigation and status bars and lets your app capture all touch events on the screen.
18
19Pre-requisites
20--------------
21
22- Android SDK 28
23- Android Build Tools v28.0.3
24- Android Support Repository
25
26Screenshots
27-------------
28
29<img src="screenshots/1-activity.png" height="400" alt="Screenshot"/> <img src="screenshots/2-immersive.png" height="400" alt="Screenshot"/>
30
31Getting Started
32---------------
33
34This sample uses the Gradle build system. To build this project, use the
35"gradlew build" command or use "Import Project" in Android Studio.
36
37Support
38-------
39
40- Google+ Community: https://plus.google.com/communities/105153134372062985968
41- Stack Overflow: http://stackoverflow.com/questions/tagged/android
42
43If you've found an error in this sample, please file an issue:
44https://github.com/googlesamples/android-BasicImmersiveMode
45
46Patches are encouraged, and may be submitted by forking this project and
47submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
48
49License
50-------
51
52Copyright 2019 The Android Open Source Project, Inc.
53
54Licensed to the Apache Software Foundation (ASF) under one or more contributor
55license agreements. See the NOTICE file distributed with this work for
56additional information regarding copyright ownership. The ASF licenses this
57file to you under the Apache License, Version 2.0 (the "License"); you may not
58use this file except in compliance with the License. You may obtain a copy of
59the License at
60
61http://www.apache.org/licenses/LICENSE-2.0
62
63Unless required by applicable law or agreed to in writing, software
64distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
65WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
66License for the specific language governing permissions and limitations under
67the License.
68
