1 /*
2 * Copyright (C) 2024 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package com.google.jetpackcamera.permissions.ui
17
18 import androidx.compose.foundation.background
19 import androidx.compose.foundation.clickable
20 import androidx.compose.foundation.layout.Arrangement
21 import androidx.compose.foundation.layout.Box
22 import androidx.compose.foundation.layout.Column
23 import androidx.compose.foundation.layout.IntrinsicSize
24 import androidx.compose.foundation.layout.Spacer
25 import androidx.compose.foundation.layout.fillMaxHeight
26 import androidx.compose.foundation.layout.fillMaxSize
27 import androidx.compose.foundation.layout.fillMaxWidth
28 import androidx.compose.foundation.layout.height
29 import androidx.compose.foundation.layout.padding
30 import androidx.compose.foundation.layout.size
31 import androidx.compose.material3.Button
32 import androidx.compose.material3.ButtonDefaults
33 import androidx.compose.material3.Icon
34 import androidx.compose.material3.MaterialTheme
35 import androidx.compose.material3.Text
36 import androidx.compose.runtime.Composable
37 import androidx.compose.ui.Alignment
38 import androidx.compose.ui.Modifier
39 import androidx.compose.ui.graphics.Color
40 import androidx.compose.ui.graphics.vector.ImageVector
41 import androidx.compose.ui.res.stringResource
42 import androidx.compose.ui.text.font.FontWeight
43 import androidx.compose.ui.text.style.TextAlign
44 import androidx.compose.ui.tooling.preview.Preview
45 import androidx.compose.ui.unit.dp
46 import com.google.accompanist.permissions.ExperimentalPermissionsApi
47 import com.google.accompanist.permissions.PermissionState
48 import com.google.accompanist.permissions.shouldShowRationale
49 import com.google.jetpackcamera.permissions.PermissionEnum
50 import com.google.jetpackcamera.permissions.R
51
52 /**
53 * Template for a single page for the permissions Screen
54 *
55 * @param permissionEnum a [PermissionEnum] representing the target permission
56 * @param permissionState a [PermissionState] of the target permission
57 */
58 @OptIn(ExperimentalPermissionsApi::class)
59 @Composable
PermissionTemplatenull60 fun PermissionTemplate(
61 modifier: Modifier = Modifier,
62 permissionEnum: PermissionEnum,
63 permissionState: PermissionState,
64 onRequestPermission: () -> Unit,
65 onSkipPermission: (() -> Unit)? = null,
66 onOpenAppSettings: () -> Unit
67 ) {
68 PermissionTemplate(
69 modifier = modifier,
70 onRequestPermission = {
71 if (permissionState.status.shouldShowRationale) {
72 onOpenAppSettings()
73 } else {
74 onRequestPermission()
75 }
76 },
77 onSkipPermission = onSkipPermission,
78 imageVector = permissionEnum.getImageVector()!!,
79 iconAccessibilityText = stringResource(permissionEnum.getIconAccessibilityTextResId()),
80 title = stringResource(permissionEnum.getPermissionTitleResId()),
81
82 // if declined by user, must navigate to system app settings to enable permission
83 bodyText =
84 if (!permissionState.status.shouldShowRationale || permissionEnum.isOptional()) {
85 stringResource(id = permissionEnum.getPermissionBodyTextResId())
86 } else {
87 stringResource(id = permissionEnum.getRationaleBodyTextResId()!!)
88 },
89 requestButtonText =
90 if (!permissionState.status.shouldShowRationale || permissionEnum.isOptional()) {
91 stringResource(id = R.string.request_permission)
92 } else {
93 stringResource(id = R.string.navigate_to_settings)
94 }
95 )
96 }
97
98 /**
99 * Template for a Permission Screen page
100 */
101 @Composable
PermissionTemplatenull102 fun PermissionTemplate(
103 modifier: Modifier = Modifier,
104 onRequestPermission: () -> Unit,
105 onSkipPermission: (() -> Unit)? = null,
106 imageVector: ImageVector,
107 iconAccessibilityText: String,
108 title: String,
109 bodyText: String,
110 requestButtonText: String
111 ) {
112 Column(
113 modifier = modifier.background(MaterialTheme.colorScheme.primary),
114 verticalArrangement = Arrangement.Bottom
115 ) {
116 // permission image / top half
117 PermissionImage(
118 modifier = Modifier
119 .height(IntrinsicSize.Min)
120 .align(Alignment.CenterHorizontally),
121 imageVector = imageVector,
122 accessibilityText = iconAccessibilityText
123 )
124 Spacer(modifier = Modifier.fillMaxHeight(.1f))
125 // bottom half
126 Column(
127 modifier = Modifier
128 .align(Alignment.CenterHorizontally)
129 ) {
130 // text section
131 PermissionText(title = title, bodyText = bodyText)
132 Spacer(modifier = Modifier.fillMaxHeight(.1f))
133 // permission button section
134 PermissionButtonSection(
135 modifier = Modifier
136 .fillMaxWidth()
137 .align(Alignment.CenterHorizontally)
138 .height(IntrinsicSize.Min),
139 requestButtonText = requestButtonText,
140 onRequestPermission = onRequestPermission,
141 onSkipPermission = onSkipPermission
142 )
143 }
144 Spacer(modifier = Modifier.fillMaxHeight(.2f))
145 }
146 }
147
148 /*
149 Permission UI Previews
150 */
151 @Preview(backgroundColor = 0xFF000000, showBackground = true)
152 @Composable
Preview_Camera_Permission_Pagenull153 private fun Preview_Camera_Permission_Page() {
154 PermissionTemplate(
155 onRequestPermission = { /*TODO*/ },
156 imageVector = PermissionEnum.CAMERA.getImageVector()!!,
157 iconAccessibilityText = "",
158 title = stringResource(id = PermissionEnum.CAMERA.getPermissionTitleResId()),
159 bodyText = stringResource(id = PermissionEnum.CAMERA.getPermissionBodyTextResId()),
160 requestButtonText = stringResource(id = R.string.request_permission)
161 )
162 }
163
164 @Preview(backgroundColor = 0xFF000000, showBackground = true)
165 @Composable
Preview_Audio_Permission_Pagenull166 private fun Preview_Audio_Permission_Page() {
167 PermissionTemplate(
168 onRequestPermission = { /*TODO*/ },
169 imageVector = PermissionEnum.RECORD_AUDIO.getImageVector()!!,
170 iconAccessibilityText = "",
171 title = stringResource(id = PermissionEnum.RECORD_AUDIO.getPermissionTitleResId()),
172 bodyText = stringResource(id = PermissionEnum.RECORD_AUDIO.getPermissionBodyTextResId()),
173 requestButtonText = stringResource(id = R.string.request_permission)
174 )
175 }
176
177 /*
178 Permission UI Subcomponents
179 */
180 @Composable
PermissionImagenull181 fun PermissionImage(
182 modifier: Modifier = Modifier,
183 imageVector: ImageVector,
184 accessibilityText: String
185 ) {
186 Box(modifier = modifier) {
187 Icon(
188 modifier = Modifier
189 .size(300.dp)
190 .align(Alignment.BottomCenter),
191 imageVector = imageVector,
192 tint = MaterialTheme.colorScheme.onPrimary,
193 contentDescription = accessibilityText
194 )
195 }
196 }
197
198 @Composable
PermissionButtonSectionnull199 fun PermissionButtonSection(
200 modifier: Modifier = Modifier,
201 onRequestPermission: () -> Unit,
202 requestButtonText: String,
203 onSkipPermission: (() -> Unit)?
204 ) {
205 Box(modifier = modifier) {
206 // permission buttons
207 Column(
208 modifier = Modifier
209 .align(Alignment.Center)
210 ) {
211 PermissionButton(
212 onRequestPermission = { onRequestPermission() },
213 requestButtonText = requestButtonText
214 )
215 Spacer(modifier = Modifier.height(20.dp))
216 if (onSkipPermission != null) {
217 Text(
218 modifier = Modifier
219 .align(Alignment.CenterHorizontally)
220 .clickable { onSkipPermission() },
221 text = "Maybe Later",
222 textAlign = TextAlign.Center,
223 color = MaterialTheme.colorScheme.inversePrimary
224 )
225 }
226 }
227 }
228 }
229
230 @Composable
PermissionButtonnull231 fun PermissionButton(
232 modifier: Modifier = Modifier,
233 onRequestPermission: () -> Unit,
234 requestButtonText: String
235 ) {
236 Button(
237 modifier = modifier,
238 colors = ButtonDefaults.buttonColors(
239 containerColor = MaterialTheme.colorScheme.primaryContainer,
240 contentColor = MaterialTheme.colorScheme.onPrimaryContainer
241 ),
242 onClick = { onRequestPermission() }
243 ) {
244 Text(
245 modifier = Modifier.padding(10.dp),
246 style = MaterialTheme.typography.titleLarge,
247 fontWeight = FontWeight.SemiBold,
248 text = requestButtonText
249 )
250 }
251 }
252
253 @Composable
PermissionTextnull254 fun PermissionText(modifier: Modifier = Modifier, title: String, bodyText: String) {
255 Box(
256 modifier = modifier
257 .height(IntrinsicSize.Min)
258 ) {
259 Column(
260 modifier = Modifier
261 .fillMaxSize()
262 .align(Alignment.Center)
263 ) {
264 // permission title
265
266 PermissionTitleText(
267 modifier = Modifier
268 .align(Alignment.CenterHorizontally),
269 text = title,
270 color = MaterialTheme.colorScheme.onPrimary
271 )
272 Spacer(modifier = Modifier.height(10.dp))
273 // permission body text
274 PermissionBodyText(
275 modifier = Modifier
276 .align(Alignment.CenterHorizontally)
277 .padding(horizontal = 50.dp),
278 text = bodyText,
279 color = MaterialTheme.colorScheme.onPrimary
280 )
281 }
282 }
283 }
284
285 @Composable
PermissionTitleTextnull286 fun PermissionTitleText(modifier: Modifier = Modifier, text: String, color: Color) {
287 Text(
288 modifier = modifier,
289 color = color,
290 text = text,
291 style = MaterialTheme.typography.titleLarge,
292 fontWeight = FontWeight.Bold
293 )
294 }
295
296 @Composable
PermissionBodyTextnull297 fun PermissionBodyText(modifier: Modifier = Modifier, text: String, color: Color) {
298 Text(
299 modifier = modifier,
300 color = color,
301 text = text,
302 style = MaterialTheme.typography.bodyLarge,
303 textAlign = TextAlign.Center
304 )
305 }
306
307