Overview

v1.1.8

Utilities for Compose Multiplatform applications such components, APIs for all supported platforms

Implementation

Version catalog

• libs.version.toml

[versions]
equinox = "1.1.8"

[libraries]
equinox-compose = { module = "io.github.n7ghtm4r3:equinox-compose", version.ref = "equinox" }
equinox-core = { module = "io.github.n7ghtm4r3:equinox-core", version.ref = "equinox" }

• build.gradle.kts

dependencies {

    // implement the compose utilities
    implementation(libs.equinox.compose)

    // implement the core utilities
    implementation(libs.equinox.core)
}

Gradle (Kotlin)

dependencies {

    // implement the compose utilities
    implementation("io.github.n7ghtm4r3:equinox-compose:1.1.8")

    // implement the core utilities
    implementation("io.github.n7ghtm4r3:equinox-core:1.1.8")
}

Gradle Groovy

dependencies {

    // implement the compose utilities
    implementation 'io.github.n7ghtm4r3:equinox-compose:1.1.8'

    // implement the core utilities
    implementation 'io.github.n7ghtm4r3:equinox-core:1.1.8'
}

APIs available

• EquinoxViewModel provides:

  • EquinoxAuthViewModel
    Prebuilt viewmodel to authenticate the user in the system

  • EquinoxProfileViewModel
    Prebuilt viewmodel to manage the user account settings and preferences

• EquinoxScreens
  APIs used to create screens with lifecycle management similar to Android activities

• EquinoxWindowKit
  APIs useful to handle the responsive layouts

• EquinoxLocalUser
  Helper for managing a local user session in client applications

Components available

Texts

• TextDivider
  Allows to divide sections with a representative text

• SplitText
  Allows the user to insert a split text such OTP codes, PIN or any other texts of this type

• ExpandableText
  Allows to dynamically display a long expanded text initially collapsed

• ChameleonText
  Allows to change the text color dynamically based on the background of the container where the text is above

• BadgeText
  Allows to display a customizable badge in your UI

Inputs

• EquinoxInputs
  Wrapper components of the official TextField and OutlinedTextField provided by Material which provides same extra features such input validation or onValue callback behavior defined by default

• DebouncedInputs
  Allow to implement a debounce routine handled when the user stop to typing in the inputs fields

Feedback & Status

• EquinoxDialogs
  Wrapper components of the official AlertDialog provided by Material with the EquinoxViewModel lifecycle handling

• EquinoxUIs
  Are prebuilt UIs to display a representative scenario like errors, loadings, etc

• ProgressBars
  Allow to display progress values on bars

• InformativeIcon
  Provides the possibility to display an informative text when the user interact with an icon

Interactive

• TabSelector
  Custom tab selector allows to select the tab to display

• Tile
  Allows users to quickly understand options and interact with them and can group related actions or information

• Stepper
  Allows to create a dynamic interaction with the user dividing for example a long procedure such item creation, customization, etc... in different specific steps where the user can interact

• QuantityPicker
  Allows to pick a numerical quantity value

Containers

• SessionFlowContainer
  Allows to dynamically display the correct content based on the session status

Annotations available

This module provides a set of annotations that can be used to improve code readability and maintainability. You can explore them here