Skip to content

Commit 2c7372d

Browse files
committed
Update docs
1 parent 83e236e commit 2c7372d

1 file changed

Lines changed: 20 additions & 1 deletion

File tree

doc/source/apis.rst

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Handling system bars and Edge-to-Edge enforcement
1212

1313
You can control the overall layout and system bars appearance in following ways::
1414

15-
from android.utils import update_system_ui
15+
from android.display_cutout import update_system_ui
1616
1717
update_system_ui(
1818
"#0f62fe", # status_bar_color: hex color code or rgba (tuple or list) values
@@ -22,6 +22,25 @@ You can control the overall layout and system bars appearance in following ways:
2222
True, # pad_nav: Adds a padding to bottom of content_view, Will take effect on Android 15+
2323
)
2424

25+
26+
Handling Immersive Mode
27+
~~~~~~~~~~~~~~~~~~~~~~~
28+
29+
Immersive mode allows your application to hide the system bars (status bar and navigation bar) for a true full-screen experience, commonly used in games or media players.
30+
31+
You can control the immersive mode behavior and how system bars reappear using the following way::
32+
33+
from android.display_cutout import set_immersive_mode
34+
35+
set_immersive_mode(
36+
True, # enable: True hides system bars, False restores normal system bar visibility
37+
"Sticky", # behavior: "Sticky" hides bars until swiped and auto-hides them after a delay, "Transient" allows temporary swipes, "Default" brings them back permanently on swipe. Literal["Default", "Transient", "Sticky"]
38+
False, # hide_status: True explicitly targets hiding the top status bar, False leaves it visible if allowed by behavior
39+
True, # hide_nav: True explicitly targets hiding the bottom navigation bar/gestural pill, False leaves it visible
40+
True, # remove_contrast: True disables the default system-enforced background scrim/contrast behind the bars, ensuring complete transparency when they peek
41+
)
42+
43+
2544
Storage paths
2645
-------------
2746

0 commit comments

Comments
 (0)