DOCSEARCHbyAlgolia
Submit Docs

Android Utils Reference

website·Indexed 30 days ago

https://jeovanimartinez.github.io/Android-Utils/docs/

API reference for Android Utils, providing utility classes for graphics (Padding, CornerRadius), watermarking (Watermark, WatermarkShadow), app reviews (RateApp, RateAppActivity), and base system integrations including Firebase Analytics and Crashlytics.

Tokens
40.5K
Snippets
302
Records
402
Agent score
70%

What's inside Android Utils

  1. Overview of Android-Utils Code Inspection Annotations

    Android-Utils provides annotations to guide developers on whether a property or variable should be assigned a specific data type or a corresponding Android resource ID. To support this flexibility, the expected data type for annotated parameters is typically Any. The library includes a Lint Check module that integrates with the IDE to verify these annotations and display warnings if an incorrect value is detected at compile time. If an invalid type is passed that cannot be detected during compilation, an exception is thrown at runtime.

  2. Overview of Android Utils library

    Android Utils is a free and open-source library (Apache License 2.0) written in 100% Kotlin. It provides a set of commonly used utilities and extension functions to facilitate the Android app development process. Key features include support for light and dark themes, English and Spanish language support, and compatibility with Android API 21+.

  5. Configure the AboutAppConfig properties

    The AboutAppConfig class allows developers to customize the content and appearance of the application's 'About' section. Available properties include:

    • showOpenSourceLicenses: A Boolean flag to determine if the open source licenses section should be displayed.
    • taskDescriptionConfig: An optional TaskDescriptionConfig object (defaults to null) used to configure the task description display.
    • termsAndPrivacyPolicyLink: An optional Any type value used to provide a link to the terms and privacy policy.
    • termsAndPrivacyPolicyTextColor: An optional Int (defaults to null) used to specify the color of the terms and privacy policy text.

  10. Configure the About activity using AboutAppConfig

    The AboutAppConfig data class is used to define the configuration for an 'About' activity. It allows developers to customize the visual appearance (colors, icons) and provide essential application information such as version, author, and company details.
    val config = AboutAppConfig(
    appName = "My App",
    appVersionName = "1.0.0",
    authorName = "Developer Name",
    companyName = "Company Inc",
    showOpenSourceLicenses = true
    // Other optional parameters
)

  11. Configure the About activity using AboutAppConfig

    The AboutAppConfig data class is used to define the visual and textual content of the About activity. It supports customization of colors, icons, and application/company details. Many fields accept either a direct value or a resource ID via @StringOrStringRes and @DrawableOrDrawableRes annotations.
    data class AboutAppConfig(
    @ColorInt val backgroundColor: Int? = null,
    @ColorInt val iconsColor: Int? = null,
    @DrawableOrDrawableRes val appIcon: Any?,
    @StringOrStringRes val appName: Any,
    @StringOrStringRes val appVersionName: Any,
    @StringOrStringRes val authorName: Any,
    @StringOrStringRes val authorLink: Any?,
    @DrawableOrDrawableRes val companyLogo: Any?,
    @StringOrStringRes val companyName: Any,
    @StringOrStringRes val companyLink: Any?,
    @StringOrStringRes val termsAndPrivacyPolicyLink: Any?,
    @ColorInt val termsAndPrivacyPolicyTextColor: Int? = null,
    val showOpenSourceLicenses: Boolean,
    val taskDescriptionConfig: TaskDescriptionConfig? = null
)