1.1.0

equinox-compose/com.tecknobit.equinoxcompose.utilities

Package-level declarations

Types

enum BorderToColor : Enum<BorderToColor>

BorderToColor list of positions for the border to color by the colorOneSideBorder method

CompactClassComponent

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.FILE])

annotation class CompactClassComponent

The CompactClassComponent annotation is useful to indicate the components which are shown on those devices which belong to the WindowWidthSizeClass.Compact class

ExpandedClassComponent

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.FILE])

annotation class ExpandedClassComponent

The ExpandedClassComponent annotation is useful to indicate the components which are shown on those devices which belong to the Expanded class

LayoutCoordinator

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class LayoutCoordinator(val classes: Array<ResponsiveClass> = [])

The LayoutCoordinator annotation is useful to indicate the components which are just coordinator of the specific components designed for the specific size classes

MediumClassComponent

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.FILE])

annotation class MediumClassComponent

The MediumClassComponent annotation is useful to indicate the components which are shown on those devices which belong to the Medium class

ResponsiveClass

enum ResponsiveClass : Enum<ResponsiveClass>

ResponsiveClass list of the available responsive content classes

ResponsiveClassComponent

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.FILE])

annotation class ResponsiveClassComponent(val classes: Array<ResponsiveClass>)

The ResponsiveClassComponent annotation is useful to indicate the components which are shown on those devices which belong to the specified classes. This annotation can include both the WindowWidthSizeClass and WindowHeightSizeClass categorizations

Functions

awaitNullItemLoaded

fun <T> awaitNullItemLoaded(itemToWait: T?, extras: (T) -> Boolean = { true }, loadedContent: @Composable (T) -> Unit)

Method used to wait asynchronously the change of the state of a null item to its non-null value.

calculateResponsiveClass

private fun calculateResponsiveClass(): ResponsiveClass

Method used to calculate the current ResponsiveClass based on the screen dimension

colorOneSideBorder

fun Modifier.colorOneSideBorder(borderToColor: BorderToColor = START, width: Dp, color: Color, shape: Shape = RectangleShape): Modifier

Method used to draw just one side of a component.

copyOnClipboard

actual fun copyOnClipboard(content: String, onCopy: () -> Unit?)

Method used to copy to the clipboard a content value

expect fun copyOnClipboard(content: String, onCopy: () -> Unit? = null)

Method used to copy to the clipboard a content value

actual fun copyOnClipboard(content: String, onCopy: () -> Unit?)

Method used to copy to the clipboard a content value

actual fun copyOnClipboard(content: String, onCopy: () -> Unit?)

Method used to copy to the clipboard a content value

actual fun copyOnClipboard(content: String, onCopy: () -> Unit?)

Method used to copy to the clipboard a content value

currentHeightClass

fun currentHeightClass(): WindowHeightSizeClass

Method used to get the current window height size class of the device

currentSizeClass

actual fun currentSizeClass(): WindowSizeClass

Method used to get the current window size class of the device

expect fun currentSizeClass(): WindowSizeClass

Method used to get the current window size class of the device

actual fun currentSizeClass(): WindowSizeClass

Method used to get the current window size class of the device

actual fun currentSizeClass(): WindowSizeClass

Method used to get the current window size class of the device

actual fun currentSizeClass(): WindowSizeClass

Method used to get the current window size class of the device

currentWidthClass

fun currentWidthClass(): WindowWidthSizeClass

Method used to get the current window width size class of the device

generateRandomColor

fun generateRandomColor(): Color

Method used to generate a random color for a collection

getCurrentLocaleLanguage

actual fun getCurrentLocaleLanguage(): String

Method used to get the current locale language set

expect fun getCurrentLocaleLanguage(): String

Method used to get the current locale language set

actual fun getCurrentLocaleLanguage(): String

Method used to get the current locale language set

actual fun getCurrentLocaleLanguage(): String

Method used to get the current locale language set

actual fun getCurrentLocaleLanguage(): String

Method used to get the current locale language set

responsiveAction

fun responsiveAction( onExpandedSizeClass: () -> Unit, onExpandedWidthMediumHeight: () -> Unit? = onExpandedSizeClass, onExpandedWidthCompactHeight: () -> Unit? = onExpandedSizeClass, onMediumSizeClass: () -> Unit, onMediumWidthExpandedHeight: () -> Unit? = onMediumSizeClass, onMediumWidthCompactHeight: () -> Unit? = onMediumSizeClass, onCompactSizeClass: () -> Unit, onCompactWidthExpandedHeight: () -> Unit? = onCompactSizeClass, onCompactWidthMediumHeight: () -> Unit? = onCompactSizeClass)

Executes an action based on the current ResponsiveClass of the window

responsiveAssignment

fun <T> responsiveAssignment( onExpandedSizeClass: () -> T, onExpandedWidthMediumHeight: () -> T = onExpandedSizeClass, onExpandedWidthCompactHeight: () -> T = onExpandedSizeClass, onMediumSizeClass: () -> T, onMediumWidthExpandedHeight: () -> T = onMediumSizeClass, onMediumWidthCompactHeight: () -> T = onMediumSizeClass, onCompactSizeClass: () -> T, onCompactWidthExpandedHeight: () -> T = onCompactSizeClass, onCompactWidthMediumHeight: () -> T = onCompactSizeClass): T

Assigns a specific value based on the current ResponsiveClass of the window

ResponsiveContent

fun ResponsiveContent( onExpandedSizeClass: @Composable () -> Unit, onExpandedWidthMediumHeight: @Composable () -> Unit? = onExpandedSizeClass, onExpandedWidthCompactHeight: @Composable () -> Unit? = onExpandedSizeClass, onMediumSizeClass: @Composable () -> Unit, onMediumWidthExpandedHeight: @Composable () -> Unit? = onMediumSizeClass, onMediumWidthCompactHeight: @Composable () -> Unit? = onMediumSizeClass, onCompactSizeClass: @Composable () -> Unit, onCompactWidthExpandedHeight: @Composable () -> Unit? = onCompactSizeClass, onCompactWidthMediumHeight: @Composable () -> Unit? = onCompactSizeClass)

Displays the correct content based on the current ResponsiveClass of the window

fun String.toColor(): Color

Method used to get the color from its hex code

fun Color.toHex(): String

Method used to transform a Color value in the corresponding hex code