{"id":13902360,"url":"https://github.com/tusharhow/Shimmerfy","last_synced_at":"2025-07-18T00:31:25.430Z","repository":{"id":225517011,"uuid":"766189209","full_name":"tusharhow/Shimmerfy","owner":"tusharhow","description":"Shimmerfy is a lightweight and customizable library for integrating shimmer animations into your Jetpack Compose applications. It provides an easy way to create shimmering effects on UI components, such as cards, skeletons, and more.","archived":false,"fork":false,"pushed_at":"2024-03-09T18:08:17.000Z","size":8958,"stargazers_count":9,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-08-07T22:33:41.345Z","etag":null,"topics":["android","jetpack-compose","kotlin","shimmer","shimmer-effect","shimmer-loading"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tusharhow.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-03-02T15:26:41.000Z","updated_at":"2024-08-06T07:07:26.000Z","dependencies_parsed_at":"2024-03-09T18:49:09.676Z","dependency_job_id":null,"html_url":"https://github.com/tusharhow/Shimmerfy","commit_stats":null,"previous_names":["tusharhow/shimmerfy"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tusharhow%2FShimmerfy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tusharhow%2FShimmerfy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tusharhow%2FShimmerfy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tusharhow%2FShimmerfy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tusharhow","download_url":"https://codeload.github.com/tusharhow/Shimmerfy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226310582,"owners_count":17604605,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","jetpack-compose","kotlin","shimmer","shimmer-effect","shimmer-loading"],"created_at":"2024-08-06T22:01:07.056Z","updated_at":"2024-11-25T10:32:03.917Z","avatar_url":"https://github.com/tusharhow.png","language":"Kotlin","funding_links":[],"categories":["Kotlin"],"sub_categories":[],"readme":"# Shimmerfy\n\n![Shimmerfy](screenshot/header.png)\n\n🚀A Jetpack Compose utility library for  \n_Made with ❤️ for Android Developers and Composers_ \n\n \u003cimg src=\"screenshot/shimmer.gif\" width=\"250\" height=\"30%\"/\u003e\n\n\n## 💡Introduction \n\nShimmerfy is a lightweight library for Jetpack Compose that enables you to effortlessly integrate shimmer loading effects into your UI components. Enhance your app's user experience with smooth and appealing loading animations using Shimmerfy.\n\n## 🚀 Implementation\n\nYou can check [/app](/app) directory which includes example application for demonstration. \n\n### Gradle setup\n\nIn `build.gradle` of app module, include this dependency\n\n```gradle\ndependencies {\n    implementation (\"com.github.tusharhow:Shimmerfy:1.0.5\")\n}\n```\n\n_You can find latest version and changelogs in the [releases](https://github.com/tusharhow/Shimmerfy/releases)_.\n\n### Usage\n\n#### 1. Initialize Shimmer Animation in your Composable function:\n\n```kotlin\nLazyColumn {\n  items(6) {\n    // design your content skeleton with shimmerfy\n\n  }\n }\n```\n\n\n#### 2. Create a ShimmerItemRow\n\n\n```kotlin\nRow(){\n     ShimmerSkeleton(\n        modifier = Modifier\n            .width(100.dp)\n            .height(100.dp)\n            .clip(RoundedCornerShape(8)),\n    )\n}\n```\n\n#### 3. Dummy card\n\nFor the idea i've created a dummy shimmer card. \n\n```kotlin\n// Example: Created a dummy shimmer card\nRow(\n    modifier = Modifier\n        .padding(16.dp),\n) {\n    ShimmerSkeleton(\n        modifier = Modifier\n            .width(100.dp)\n            .height(100.dp)\n            .clip(RoundedCornerShape(8)),\n    )\n    Spacer(modifier = Modifier.width(16.dp))\n    Column {\n        ShimmerSkeleton(\n            modifier = Modifier\n                .width(200.dp)\n                .height(20.dp),\n        )\n        Spacer(modifier = Modifier.height(16.dp))\n        ShimmerSkeleton(\n            modifier = Modifier\n                .width(100.dp)\n                .height(20.dp),\n        )\n        Spacer(modifier = Modifier.height(8.dp))\n        ShimmerSkeleton(\n            modifier = Modifier\n                .width(150.dp)\n                .height(20.dp),\n        )\n    }\n}\n```\n\n## ShimmerSkeleton with Customization\n\nThe `ShimmerSkeleton` composable now supports additional customization options:\n\n- **Shimmer Colors:** You can set custom shimmer colors using the `shimmerColors` parameter. For example:\n\n    ```kotlin\n    shimmerColors = listOf(\n        Color.LightGray.copy(0.9f),\n        Color.LightGray.copy(0.2f),\n        Color.LightGray.copy(0.9f)\n    )\n    ```\n\n- **Easing Function:** Customize the easing function for the shimmer animation using the `easing` parameter. For example:\n\n    ```kotlin\n    easing = EaseIn\n    ```\n\n- **Animation Duration:** Adjust the duration of the shimmer animation with the `duration` parameter (in milliseconds). For example:\n\n    ```kotlin\n    duration = 1200\n    ```\n\n- **Repeat Mode:** Set the repeat mode for the shimmer animation using the `repeatMode` parameter. For example:\n\n    ```kotlin\n    repeatMode = RepeatMode.Reverse\n    ```\n\n### Example Usage\n\n```kotlin\n@Composable\nfun ShimmerItem(modifier: Modifier) {\n    ShimmerSkeleton(\n        modifier = modifier,\n        shimmerColors = listOf(\n            Color.LightGray.copy(0.9f),\n            Color.LightGray.copy(0.2f),\n            Color.LightGray.copy(0.9f)\n        ),\n        easing = EaseIn,\n        duration = 1200,\n        repeatMode = RepeatMode.Reverse\n    )\n}\n\n```\n\n\n## 📝 License\n\n```\nMIT License\n\nCopyright (c) 2024 Tushar Mahmud\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftusharhow%2FShimmerfy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftusharhow%2FShimmerfy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftusharhow%2FShimmerfy/lists"}