{"id":22880251,"url":"https://github.com/re-ovo/compose-setting","last_synced_at":"2026-02-25T14:31:52.369Z","repository":{"id":50361914,"uuid":"483578788","full_name":"re-ovo/compose-setting","owner":"re-ovo","description":"A setting library for Jetpack Compose with Material You design","archived":false,"fork":false,"pushed_at":"2023-03-30T09:14:53.000Z","size":252,"stargazers_count":18,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-07T02:05:23.066Z","etag":null,"topics":["android","jetpack-compose","kotlin","material-you","setting"],"latest_commit_sha":null,"homepage":"","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/re-ovo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-04-20T08:54:37.000Z","updated_at":"2024-09-01T14:09:36.000Z","dependencies_parsed_at":"2023-01-18T04:45:15.610Z","dependency_job_id":null,"html_url":"https://github.com/re-ovo/compose-setting","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/re-ovo%2Fcompose-setting","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/re-ovo%2Fcompose-setting/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/re-ovo%2Fcompose-setting/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/re-ovo%2Fcompose-setting/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/re-ovo","download_url":"https://codeload.github.com/re-ovo/compose-setting/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252798855,"owners_count":21805887,"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","material-you","setting"],"created_at":"2024-12-13T17:16:54.599Z","updated_at":"2026-02-25T14:31:52.329Z","avatar_url":"https://github.com/re-ovo.png","language":"Kotlin","readme":"# ComposeSetting\n![](https://jitpack.io/v/re-ovo/compose-setting.svg?style=flat-square)\n![](https://img.shields.io/github/issues/re-ovo/compose-setting?style=flat-square)\n![](https://img.shields.io/github/forks/re-ovo/compose-setting?style=flat-square)\n![](https://img.shields.io/github/stars/re-ovo/compose-setting?style=flat-square)\n![](https://img.shields.io/github/pulls/re-ovo/compose-setting?style=flat-square)\n\nThis is a basic Compose setting library that provides a basic [Material3](https://m3.material.io) setting components\nIt also provides a persistent state system based on [MMKV](https://github.com/Tencent/MMKV). \nCompared with SharedPreference/DataStore, it can **support synchronous reading without loss of performance**\n\n## Features\n* Remember Preference\n* Material3 Setting Component\n* High Performance\n* Support Synchronous Reading/Writing\n\n## Screenshot\n![](art/screenshot.png)\n\n## Import to your project\n1. Import jitpack to your repository\n```groovy\nrepositories {\n    maven {\n        url 'https://jitpack.io'\n    }\n}\n```\n2. Import the library ![](https://jitpack.io/v/re-ovo/compose-setting.svg?style=flat-square)\n```groovy\nimplementation 'com.github.re-ovo:compose-setting:\u003clatest-version\u003e'\n```\n\n## Remember Preference\nYou should initialize the MMKV before using it.\n```kotlin\n// Call this function in your Application.onCreate()\ninitComposeSetting()\n```\n\nYou can use `rememberXXXPreference` function, which can **persist** remember a certain value in Compose\n\n```kotlin\nval booleanPreference by rememberBooleanPreference(\nkey = \"boolean_preference\",\ndefault = false\n)\n```\n\nOther types of preference can be used as well, such as\n* `rememberStringPreference`\n* `rememberIntPreference`\n* `rememberLongPreference`\n* `rememberFloatPreference`\n* `rememberDoublePreference`\n* `rememberStringPreference`\n* `rememberStringSetPreference`\n\nIf you want to read/write the preference synchronously without Compose context, you can use `mmkvPreference` \nto do that:\n```kotlin\nmmkvPreference.getBoolean(\"boolean_preference\", false)\nmmkvPreference.putBoolean(\"boolean_preference\", true)\n    ...\n```\n\n## Setting Components\nThis library provides several out-of-the-box setting item components\n\n### SettingBooleanItem\nThis component is used to display a setting item with a boolean value\n\n```kotlin\nval booleanPref = rememberBooleanPreference(\n    key = \"boolean_preference\",\n    defaultValue = false\n)\nSettingBooleanItem(\n    state = booleanPref,\n    title = {\n        Text(\"Network\")\n    },\n    text = {\n        Text(\"This is the description\")\n    },\n    icon = {\n        Icon(Icons.Outlined.Notifications, null)\n    }\n)\n```\n![](art/boolean_component.png)\n\n### SettingStringItem\nThis component is used to display a setting item with a string value\n\n```kotlin\nval stringPref = rememberStringPreference(\n    key = \"string_preference\",\n    defaultValue = \"default\"\n)\n// Pick Based\nSettingStringPickerItem(\n    state = stringPref,\n    title = {\n        Text(\"Set Phone Brand\")\n    },\n    text = {\n        Text(\"Select your phone brand\")\n    },\n    icon = {\n        Icon(Icons.Outlined.Phone, null)\n    },\n    stateRange = setOf(\n        \"Xiaomi\", \"Google\", \"Oppo\"\n    )\n)\n// Input Field Based\nSettingStringInputDialogItem(\n    state = stringPref,\n    title = {\n        Text(\"Set Phone Brand\")\n    },\n    icon = {\n        Icon(Icons.Outlined.Phone, null)\n    },\n    validator = { value -\u003e\n        value.length \u003e= 3\n    },\n    invalidMessage = {\n        Text(\"Invalid Phone Brand\")\n    },\n    confirmText = {\n        Text(\"Confirm\")\n    },\n    dismissText = {\n        Text(\"Dismiss\")\n    }\n)\n```\n![](art/string_component.png)\n\n### SettingLinkItem\nThis component is used to display a basic setting item\n\n```kotlin\nSettingLinkItem(\n    title = {\n        Text(\"Network\")\n    },\n    text = {\n        Text(\"This is the description\")\n    },\n    icon = {\n        Icon(Icons.Outlined.Notifications, null)\n    },\n    onClick = {\n        // do something by yourself\n    }\n)\n```\n\n### SettingItemCategory\nThis component is used to display a category of setting items\n\n```kotlin\n SettingItemCategory(\n    title = {\n        Text(text = \"Compose Yes\")\n    }\n) {\n    // Your Menu Items Here\n}\n```\n![](art/category.png)","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fre-ovo%2Fcompose-setting","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fre-ovo%2Fcompose-setting","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fre-ovo%2Fcompose-setting/lists"}