Skip to content

Commit

Permalink
refactor: Update the kDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
sirambd authored and KevinBoulongne committed Sep 25, 2024
1 parent b7c5b7c commit b8758e2
Showing 1 changed file with 6 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,17 @@
*/
package com.infomaniak.swisstransfer.ui.utils

import androidx.compose.material3.NavigationBar
import androidx.compose.material3.NavigationRail
import androidx.compose.material3.adaptive.WindowAdaptiveInfo
import androidx.window.core.layout.WindowHeightSizeClass
import androidx.window.core.layout.WindowWidthSizeClass

/**
* Determines if the current window is classified as a large window suitable for tablet devices.
*
* A window is considered large if its width size class is [WindowWidthSizeClass.EXPANDED]
* and its height size class is not [WindowHeightSizeClass.COMPACT]. This function can be used
* to adapt the UI layout for larger screens, ensuring a better user experience on tablet devices.
* This is typically used to adapt the UI, such as displaying a list-detail layout or using a [NavigationRail]
* vs a [NavigationBar] for navigation.
*
* @return `true` if the window is large (tablet), `false` otherwise.
*/
Expand All @@ -37,9 +38,8 @@ fun WindowAdaptiveInfo.isWindowLarge(): Boolean = with(windowSizeClass) {
/**
* Determines if the current window is classified as a small window suitable for mobile devices.
*
* A window is considered small if its width size class is not [WindowWidthSizeClass.EXPANDED]
* or its height size class is [WindowHeightSizeClass.COMPACT]. This function can be used
* to adapt the UI layout for smaller screens, ensuring a better user experience on mobile devices.
* This is typically used to adapt the UI, such as displaying a list-detail layout or using a [NavigationRail]
* vs a [NavigationBar] for navigation.
*
* @return `true` if the window is small (mobile), `false` otherwise.
*/
Expand Down

0 comments on commit b8758e2

Please sign in to comment.