{"id":13608242,"url":"https://github.com/alorma/Compose-Settings","last_synced_at":"2025-04-12T14:32:27.420Z","repository":{"id":43636773,"uuid":"360568361","full_name":"alorma/Compose-Settings","owner":"alorma","description":"Compose Multiplatform #Compose Settings library","archived":false,"fork":false,"pushed_at":"2025-03-25T09:54:07.000Z","size":7060,"stargazers_count":498,"open_issues_count":0,"forks_count":30,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-07T00:09:49.704Z","etag":null,"topics":["android","android-library","compose","compose-multiplatform","settings"],"latest_commit_sha":null,"homepage":"https://alorma.github.io/Compose-Settings/","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alorma.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","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,"publiccode":null,"codemeta":null},"funding":{"github":["alorma"],"buy_me_a_coffee":"alorma"}},"created_at":"2021-04-22T15:33:05.000Z","updated_at":"2025-04-02T18:12:55.000Z","dependencies_parsed_at":"2023-02-08T19:15:58.033Z","dependency_job_id":"243fe86a-d48f-4681-b2b1-c08bad566d6f","html_url":"https://github.com/alorma/Compose-Settings","commit_stats":null,"previous_names":[],"tags_count":64,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alorma%2FCompose-Settings","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alorma%2FCompose-Settings/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alorma%2FCompose-Settings/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alorma%2FCompose-Settings/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alorma","download_url":"https://codeload.github.com/alorma/Compose-Settings/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248581320,"owners_count":21128147,"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","android-library","compose","compose-multiplatform","settings"],"created_at":"2024-08-01T19:01:25.471Z","updated_at":"2025-04-12T14:32:27.413Z","avatar_url":"https://github.com/alorma.png","language":"Kotlin","readme":"# Compose Settings - Multiplatform\n\n\u003cdiv\u003e\n \u003cimg src=\"https://img.shields.io/badge/Platform-Android-brightgreen.svg?logo=android\" alt=\"Badge Android\" /\u003e\n\n\u003cimg src=\"https://img.shields.io/badge/Platform-iOS%20%2F%20macOS-lightgrey.svg?logo=apple\" alt=\"Badge iOS\" /\u003e\n\n\u003cimg src=\"https://img.shields.io/badge/Platform-JVM-8A2BE2.svg?logo=openjdk\" alt=\"Badge JVM\" /\u003e\n\n\u003cimg src=\"https://img.shields.io/badge/Platform-WASM%20%2F%20JS-yellow.svg?logo=javascript\" alt=\"Badge wasm/JS\" /\u003e\n\n\u003c/div\u003e\n\n[![Build](https://github.com/alorma/Compose-Settings/actions/workflows/main.yml/badge.svg)](https://github.com/alorma/Compose-Settings/actions/workflows/main.yml)\n[![Maven Central](https://img.shields.io/maven-central/v/com.github.alorma.compose-settings/ui-tiles.svg)](https://central.sonatype.com/namespace/com.github.alorma.compose-settings)\n\n[![Dokka](https://img.shields.io/badge/Documentation-blue)](https://alorma.github.io/Compose-Settings/dokka)\n\n\u003ca href=\"https://www.buymeacoffee.com/alorma\" target=\"_blank\"\u003e\u003cimg src=\"https://cdn.buymeacoffee.com/buttons/default-orange.png\" alt=\"Buy Me A Coffee\" height=\"41\" width=\"174\"\u003e\u003c/a\u003e\n\n\n### Preview\n\nThis library provides a set of **Settings** like composable items to help android *Jetpack Compose*\ndevelopers build complex settings screens without all the boilerplate.\n\n**Ui tiles**\n\n| Component                                             | Screenshot                                                                       |\n|-------------------------------------------------------|----------------------------------------------------------------------------------|\n| [SettingsMenuLink](#SettingsMenuLink)                 | \u003cimg width=\"200\" alt=\"menu.png\" src=\"docs/art/menu-link.png\" /\u003e                  |\n| [SettingsCheckbox](#SettingsCheckbox)                 | \u003cimg width=\"200\" alt=\"checkbox.png\" src=\"docs/art/checkbox.png\" /\u003e               |\n| [SettingsTriStateCheckbox](#SettingsTriStateCheckbox) | \u003cimg width=\"200\" alt=\"triState-checkbox\" src=\"docs/art/triState-checkbox.png\" /\u003e |\n| [SettingsRadioButton](#SettingsRadioButton)           | \u003cimg width=\"200\" alt=\"radiobutton.png\" src=\"docs/art/radiobutton.png\" /\u003e         |\n| [SettingsSwitch](#SettingsSwitch)                     | \u003cimg width=\"200\" alt=\"switch.png\" src=\"docs/art/switch.png\" /\u003e                   |\n| [SettingsGroup](#SettingsGroup)                      | \u003cimg width=\"200\" alt=\"group.png\" src=\"docs/art/group.png\" /\u003e                     |\n\n**Ui tiles expanded**\n\n| Component                         | Screenshot                                                     |\n|-----------------------------------|----------------------------------------------------------------|\n| [SettingsSlider](#SettingsSlider) | \u003cimg width=\"200\" alt=\"slider.png\" src=\"docs/art/slider.png\" /\u003e |\n\n## Install\n\n```\n##// groovy\nimplementation 'com.github.alorma.compose-settings:ui-tiles:$version'\nimplementation 'com.github.alorma.compose-settings:ui-tiles-extended:$version'\n\n[...]\n\n// kotlin DSL\n\nimplementation(\"com.github.alorma.compose-settings:ui-tiles:$version\")\nimplementation(\"com.github.alorma.compose-settings:ui-tiles-extended:$version\")\n\n[...]\n\n// Catalog versions:\n\n[versions]\ncompose-settings = \"{{libVersion}}\"\n\n[libraries]\ncomposeSettings-ui = { group = \"com.github.alorma.compose-settings\", name = \"ui-tiles\", version.ref = \"compose-settings\" }\ncomposeSettings-ui-extended = { group = \"com.github.alorma.compose-settings\", name = \"ui-tiles-extended\", version.ref = \"compose-settings\" }\n```\n\n## Usage\n\n##### SettingsMenuLink:\n\n```kotlin\nSettingsMenuLink(\n  title = { Text(text = \"Setting title\") },\n  subtitle = { Text(text = \"Setting subtitle\") },\n  modifier = Modifier,\n  enabled = false / true,\n  icon = { Icon(...) },\n  action = { IconButton() },\n  onClick = { ... },\n)\n```\n\n\u003cimg width=\"300\" alt=\"menu.png\" src=\"docs/art/menu-link.png\" /\u003e\n\n##### SettingsCheckbox:\n\n```kotlin\nSettingsCheckbox(\n  state = false / true,\n  title = { Text(text = \"Setting title\") },\n  subtitle = { Text(text = \"Setting subtitle\") },\n  modifier = Modifier,\n  enabled = false / true,\n  icon = { Icon(...) },\n  onCheckedChange = { newState: Boolean -\u003e },\n)\n```\n\n\u003cimg width=\"300\" alt=\"checkbox.png\" src=\"docs/art/checkbox.png\" /\u003e\n\n##### SettingsTriStateCheckbox:\n\n```kotlin\nSettingsTriStateCheckbox(\n  state = false / true / null,\n  title = { Text(text = \"Setting title\") },\n  subtitle = { Text(text = \"Setting subtitle\") },\n  modifier = Modifier,\n  enabled = false / true,\n  icon = { Icon(...) },\n  onCheckedChange = { newState: Boolean -\u003e },\n)\n```\n\n\u003cimg width=\"300\" alt=\"triState-checkbox.png\" src=\"docs/art/triState-checkbox.png\" /\u003e\n\n##### SettingsRadioButton:\n\n```kotlin\nSettingsRadioButton(\n  state = false / true,\n  title = { Text(text = \"Setting title\") },\n  subtitle = { Text(text = \"Setting subtitle\") },\n  modifier = Modifier,\n  enabled = false / true,\n  icon = { Icon(...) },\n  onClick = { },\n)\n```\n\n\u003cimg width=\"300\" alt=\"radiobutton.png\" src=\"docs/art/radiobutton.png\" /\u003e\n\n##### SettingsSwitch:\n\n```kotlin\nSettingsSwitch(\n  state = false / true,\n  title = { Text(text = \"Setting title\") },\n  subtitle = { Text(text = \"Setting subtitle\") },\n  modifier = Modifier,\n  enabled = false / true,\n  icon = { Icon(...) },\n  onCheckedChange = { newState: Boolean -\u003e },\n)\n```\n\n\u003cimg width=\"300\" alt=\"switch.png\" src=\"docs/art/switch.png\" /\u003e\n\n##### SettingsSlider:\n\n```kotlin\nSettingsSlider(\n  value = x.xf,\n  valueRange = X.f..Y.f,\n  steps = X,\n  title = { Text(text = \"Setting title\") },\n  subtitle = { Text(text = \"Setting subtitle\") },\n  modifier = Modifier,\n  enabled = false / true,\n  icon = { Icon(...) },\n  onValueChange = { newValue: Float -\u003e },\n)\n```\n\n\u003cimg width=\"300\" alt=\"slider.png\" src=\"docs/art/slider.png\" /\u003e\n\n##### SettingsGroup\n\n\u003e Updates on `enabled` will be reflected on it's internal components unless you change their `enabled` state manually.\n\n```kotlin\nSettingsGroup(\n  modifier = Modifier,\n  enabled = false / true,\n  title = { Text(text = \"SettingsGroup\") },\n  contentPadding = PaddingValues(16.dp),\n) {\n    SettingsMenuLink(...)\n    SettingsCheckbox(...)\n    SettingsSwitch(...)\n    ...\n}\n```\n\n\u003cimg width=\"300\" alt=\"group.png\" src=\"docs/art/group.png\" /\u003e\n","funding_links":["https://github.com/sponsors/alorma","https://buymeacoffee.com/alorma","https://www.buymeacoffee.com/alorma"],"categories":["Kotlin","Uncategorized"],"sub_categories":["Uncategorized"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falorma%2FCompose-Settings","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falorma%2FCompose-Settings","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falorma%2FCompose-Settings/lists"}