-
Notifications
You must be signed in to change notification settings - Fork 176
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Room List] Show offline indicator when the device is offline (#239)
* Implement the network status indicator. * Add `networkmonitor` feature.
- Loading branch information
1 parent
1b1475d
commit bfac069
Showing
33 changed files
with
511 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Add a `NetworkMonitor` component to track the network connection status |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
/* | ||
* Copyright (c) 2022 New Vector Ltd | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
// TODO: Remove once https://youtrack.jetbrains.com/issue/KTIJ-19369 is fixed | ||
@Suppress("DSL_SCOPE_VIOLATION") | ||
plugins { | ||
id("io.element.android-compose-library") | ||
} | ||
|
||
android { | ||
namespace = "io.element.android.features.networkmonitor.api" | ||
} | ||
|
||
dependencies { | ||
implementation(libs.coroutines.core) | ||
implementation(projects.libraries.designsystem) | ||
implementation(projects.libraries.uiStrings) | ||
} |
24 changes: 24 additions & 0 deletions
24
...itor/api/src/main/kotlin/io/element/android/features/networkmonitor/api/NetworkMonitor.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
/* | ||
* Copyright (c) 2023 New Vector Ltd | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package io.element.android.features.networkmonitor.api | ||
|
||
import kotlinx.coroutines.flow.Flow | ||
|
||
interface NetworkMonitor { | ||
val connectivity: Flow<NetworkStatus> | ||
val currentConnectivityStatus: NetworkStatus | ||
} |
22 changes: 22 additions & 0 deletions
22
...nitor/api/src/main/kotlin/io/element/android/features/networkmonitor/api/NetworkStatus.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
/* | ||
* Copyright (c) 2023 New Vector Ltd | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package io.element.android.features.networkmonitor.api | ||
|
||
enum class NetworkStatus { | ||
Online, | ||
Offline | ||
} |
125 changes: 125 additions & 0 deletions
125
...ain/kotlin/io/element/android/features/networkmonitor/api/ui/ConnectivityIndicatorView.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,125 @@ | ||
/* | ||
* Copyright (c) 2023 New Vector Ltd | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package io.element.android.features.networkmonitor.api.ui | ||
|
||
import androidx.compose.animation.AnimatedVisibility | ||
import androidx.compose.animation.core.MutableTransitionState | ||
import androidx.compose.animation.expandVertically | ||
import androidx.compose.animation.fadeIn | ||
import androidx.compose.animation.fadeOut | ||
import androidx.compose.animation.shrinkVertically | ||
import androidx.compose.foundation.Image | ||
import androidx.compose.foundation.background | ||
import androidx.compose.foundation.layout.Arrangement | ||
import androidx.compose.foundation.layout.Row | ||
import androidx.compose.foundation.layout.Spacer | ||
import androidx.compose.foundation.layout.fillMaxWidth | ||
import androidx.compose.foundation.layout.padding | ||
import androidx.compose.foundation.layout.size | ||
import androidx.compose.foundation.layout.statusBarsPadding | ||
import androidx.compose.foundation.layout.width | ||
import androidx.compose.material.Text | ||
import androidx.compose.material.icons.Icons | ||
import androidx.compose.material.icons.outlined.WifiOff | ||
import androidx.compose.material3.MaterialTheme | ||
import androidx.compose.runtime.Composable | ||
import androidx.compose.runtime.getValue | ||
import androidx.compose.runtime.mutableStateOf | ||
import androidx.compose.runtime.remember | ||
import androidx.compose.runtime.setValue | ||
import androidx.compose.ui.Alignment | ||
import androidx.compose.ui.Modifier | ||
import androidx.compose.ui.graphics.ColorFilter | ||
import androidx.compose.ui.res.stringResource | ||
import androidx.compose.ui.tooling.preview.Preview | ||
import androidx.compose.ui.unit.dp | ||
import io.element.android.libraries.designsystem.ElementTextStyles | ||
import io.element.android.libraries.designsystem.preview.ElementPreviewDark | ||
import io.element.android.libraries.designsystem.preview.ElementPreviewLight | ||
import io.element.android.libraries.designsystem.theme.LocalColors | ||
import io.element.android.libraries.ui.strings.R as StringR | ||
|
||
@Composable | ||
fun ConnectivityIndicatorView( | ||
isOnline: Boolean, | ||
modifier: Modifier = Modifier | ||
) { | ||
val isIndicatorVisible = remember { MutableTransitionState(!isOnline) }.apply { targetState = !isOnline } | ||
val isStatusBarPaddingVisible = remember { MutableTransitionState(isOnline) }.apply { targetState = isOnline } | ||
|
||
// Display the network indicator with an animation | ||
AnimatedVisibility( | ||
visibleState = isIndicatorVisible, | ||
enter = fadeIn() + expandVertically(), | ||
exit = fadeOut() + shrinkVertically(), | ||
) { | ||
Indicator(modifier) | ||
} | ||
|
||
// Show missing status bar padding when the indicator is not visible | ||
AnimatedVisibility( | ||
visibleState = isStatusBarPaddingVisible, | ||
enter = fadeIn() + expandVertically(), | ||
exit = fadeOut() + shrinkVertically(), | ||
) { | ||
StatusBarPaddingSpacer(modifier) | ||
} | ||
} | ||
|
||
@Composable | ||
private fun Indicator(modifier: Modifier = Modifier) { | ||
Row( | ||
modifier | ||
.fillMaxWidth() | ||
.background(LocalColors.current.gray400) | ||
.statusBarsPadding() | ||
.padding(vertical = 6.dp), | ||
horizontalArrangement = Arrangement.Center, | ||
verticalAlignment = Alignment.Bottom, | ||
) { | ||
val tint = MaterialTheme.colorScheme.primary | ||
Image( | ||
imageVector = Icons.Outlined.WifiOff, | ||
contentDescription = null, | ||
colorFilter = ColorFilter.tint(tint), | ||
modifier = Modifier.size(16.dp), | ||
) | ||
Spacer(modifier = Modifier.width(8.dp)) | ||
Text(text = stringResource(StringR.string.common_offline), style = ElementTextStyles.Regular.bodyMD, color = tint) | ||
} | ||
} | ||
|
||
@Composable | ||
private fun StatusBarPaddingSpacer(modifier: Modifier = Modifier) { | ||
Spacer(modifier = modifier.statusBarsPadding()) | ||
} | ||
|
||
@Preview | ||
@Composable | ||
internal fun PreviewLightConnectivityIndicatorView() { | ||
ElementPreviewLight { | ||
ConnectivityIndicatorView(isOnline = false) | ||
} | ||
} | ||
|
||
@Preview | ||
@Composable | ||
internal fun PreviewDarkConnectivityIndicatorView() { | ||
ElementPreviewDark { | ||
ConnectivityIndicatorView(isOnline = false) | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
/* | ||
* Copyright (c) 2022 New Vector Ltd | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
// TODO: Remove once https://youtrack.jetbrains.com/issue/KTIJ-19369 is fixed | ||
@Suppress("DSL_SCOPE_VIOLATION") | ||
plugins { | ||
id("io.element.android-library") | ||
alias(libs.plugins.anvil) | ||
} | ||
|
||
anvil { | ||
generateDaggerFactories.set(true) | ||
} | ||
|
||
android { | ||
namespace = "io.element.android.features.networkmonitor.impl" | ||
} | ||
|
||
dependencies { | ||
implementation(libs.coroutines.core) | ||
implementation(libs.dagger) | ||
implementation(projects.libraries.core) | ||
implementation(projects.libraries.di) | ||
api(projects.features.networkmonitor.api) | ||
} |
Oops, something went wrong.