{"id":19381853,"url":"https://github.com/pearxteam/okservable","last_synced_at":"2025-04-23T20:32:03.837Z","repository":{"id":57737575,"uuid":"235562801","full_name":"pearxteam/okservable","owner":"pearxteam","description":"👀 Multiplatform Kotlin library containing observable data structures, such as ObservableList, ObservableSet and ObservableMap. ","archived":false,"fork":false,"pushed_at":"2020-05-11T10:51:39.000Z","size":186,"stargazers_count":19,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-02T19:47:05.259Z","etag":null,"topics":["gradle-kotlin-dsl","kotlin","kotlin-library","kotlin-multiplatform","multiplatform-kotlin-library","observable","observable-collections","observablecollection","observablelist","observablemap","observableset"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pearxteam.png","metadata":{"files":{"readme":"README.MD","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.TXT","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-01-22T11:50:14.000Z","updated_at":"2025-01-21T20:35:47.000Z","dependencies_parsed_at":"2022-08-24T12:51:07.278Z","dependency_job_id":null,"html_url":"https://github.com/pearxteam/okservable","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pearxteam%2Fokservable","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pearxteam%2Fokservable/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pearxteam%2Fokservable/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pearxteam%2Fokservable/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pearxteam","download_url":"https://codeload.github.com/pearxteam/okservable/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250509743,"owners_count":21442486,"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":["gradle-kotlin-dsl","kotlin","kotlin-library","kotlin-multiplatform","multiplatform-kotlin-library","observable","observable-collections","observablecollection","observablelist","observablemap","observableset"],"created_at":"2024-11-10T09:18:38.193Z","updated_at":"2025-04-23T20:32:03.172Z","avatar_url":"https://github.com/pearxteam.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Okservable [![Maven Central](https://img.shields.io/maven-central/v/net.pearx.okservable/okservable-metadata.svg?label=common\u0026logo=kotlin\u0026logoColor=white)](https://search.maven.org/search?q=g:%22net.pearx.okservable%22%20AND%20a:%22okservable-metadata%22) [![Maven Central](https://img.shields.io/maven-central/v/net.pearx.okservable/okservable-jvm.svg?label=jvm\u0026logo=java\u0026logoColor=white)](https://search.maven.org/search?q=g:%22net.pearx.okservable%22%20AND%20a:%22okservable-jvm%22) [![Maven Central](https://img.shields.io/maven-central/v/net.pearx.okservable/okservable-js.svg?label=js\u0026logo=javascript\u0026logoColor=white)](https://search.maven.org/search?q=g:%22net.pearx.okservable%22%20AND%20a:%22okservable-js%22)\n[![License](https://img.shields.io/github/license/pearxteam/okservable.svg)](https://raw.githubusercontent.com/pearxteam/okservable/master/LICENSE.TXT)\n[![Discord](https://img.shields.io/discord/136085738151346176.svg?logo=discord\u0026logoColor=white)](https://discord.gg/q9cX9QE)\n[![Release Build Status](https://img.shields.io/jenkins/build/https/ci.pearx.net/job/pearxteam/job/okservable/job/master.svg?label=build%20%5Bmaster%5D\u0026logo=jenkins\u0026logoColor=white)](https://ci.pearx.net/job/pearxteam/job/okservable/job/master/)\n[![Develop Build Status](https://img.shields.io/jenkins/build/https/ci.pearx.net/job/pearxteam/job/okservable/job/develop.svg?label=build%20%5Bdevelop%5D\u0026logo=jenkins\u0026logoColor=white)](https://ci.pearx.net/job/pearxteam/job/okservable/job/develop/)\n\nMultiplatform Kotlin library containing observable data structures, such as ObservableList, ObservableSet and ObservableMap.\n\n# Setup\n1. Add the lib to your project's dependencies by copying one of the following lines depending on the platform: \n- Groovy (replace `$okservable_version` with the version you want):\n```groovy\n implementation \"net.pearx.okservable:okservable-metadata:$okservable_version\" // for Common\n // or\n implementation \"net.pearx.okservable:okservable-jvm:$okservable_version\" // for JVM\n // or\n implementation \"net.pearx.okservable:okservable-js:$okservable_version\" // for JS\n```\n- Kotlin (replace `$okservableVersion` with the version you want):\n```kotlin\n implementation(\"net.pearx.okservable:okservable-metadata:$okservableVersion\") // for Common\n // or\n implementation(\"net.pearx.okservable:okservable-jvm:$okservableVersion\") // for JVM\n // or\n implementation(\"net.pearx.okservable:okservable-js:$okservableVersion\") // for JS\n```\n\n2. Use the library and have fun!\n\n# Examples\n - Creating a simple observable list:\n```kotlin\n//             \\/ there may be anything extending MutableList\nval items = mutableListOf(\"pickaxe\", \"bow\").observableListSimple {\n    println(\"The list has modified!\")\n}\nitems += \"axe\"     // The list has modified!\nitems -= \"pickaxe\" // The list has modified!\nitems -= \"teapot\"  // This line won't print the message since the list wasn't modified\n```\n - Creating a simple observable set:\n```kotlin\n//             \\/ there may be anything extending MutableSet\nval items = mutableSetOf(\"pickaxe\", \"bow\").observableSetSimple {\n    println(\"The set has modified!\")\n}\nitems += \"axe\"     // The set has modified!\nitems += \"pickaxe\" // This line won't print the message since the set wasn't modified\n```\n- Creating a simple observable collection:\n```kotlin\n//             \\/ there may be anything extending MutableCollection\nval items = mutableListOf(\"pickaxe\", \"bow\").observableCollectionSimple {\n    println(\"The collection has modified!\")\n}\nitems += \"axe\"     // The collection has modified!\n```\n- Creating a simple observable map:\n```kotlin\n//             \\/ there may be anything extending MutableMap\nval items = mutableMapOf(\"pickaxe\" to \"diamond\", \"axe\" to \"iron\").observableMapSimple {\n    println(\"The map has modified!\")\n}\nitems[\"pickaxe\"] = \"stone\" // The map has modified!\nitems[\"bow\"] = \"wooden\"    // The map has modified!\n```\n- Creating an observable list:\n```kotlin\n//             \\/ there may be anything extending MutableList\nval items = mutableListOf(\"pickaxe\", \"bow\").observableList {\n    add { index, element -\u003e\n        println(\"add[$index]: $element\")\n    }\n    remove { index, element -\u003e\n        println(\"remove[$index]: $element\")\n    }\n    clear { elements -\u003e\n        println(\"clear: $elements\")\n    }\n    set { index, prevElement, newElement -\u003e\n        println(\"set[$index]: $prevElement to $newElement\")\n    }\n}\nitems += \"axe\"                    // add[2]: axe\nitems -= \"pickaxe\"                // remove[0]: pickaxe\nitems -= \"teapot\"                 // This line won't print any message since the list wasn't modified\nitems += setOf(\"shovel\", \"sword\") // add[2]: shovel\n                                  // add[3]: sword\nitems[2] = \"not_shovel\"           // set[2]: shovel to not_shovel\nitems.clear()                     // clear: [bow, axe, not_shovel, sword]\n```\n\n - Creating an observable set:\n```kotlin\n//             \\/ there may be anything extending MutableSet\nval items = mutableSetOf(\"pickaxe\", \"bow\").observableSet {\n    add { element -\u003e\n        println(\"add: $element\")\n    }\n    remove { element -\u003e\n        println(\"remove: $element\")\n    }\n    clear { elements -\u003e\n        println(\"clear: $elements\")\n    }\n}\nitems += \"axe\"     // add: axe\nitems += \"pickaxe\" // This line won't print any message since the set wasn't modified\nitems -= \"pickaxe\" // remove: pickaxe\nitems.clear()      // clear: [bow, axe]\n```\n- Creating an observable collection:\n```kotlin\n//             \\/ there may be anything extending MutableCollection\nval items = mutableListOf(\"pickaxe\", \"bow\").observableCollection {\n    add { element -\u003e\n        println(\"add: $element\")\n    }\n    remove { element -\u003e\n        println(\"remove: $element\")\n    }\n    clear { elements -\u003e\n        println(\"clear: $elements\")\n    }\n}\nitems += \"axe\"     // add: axe\nitems -= \"pickaxe\" // remove: pickaxe\nitems.clear()      // clear: [bow, axe]\n```\n- Creation an observable map:\n```kotlin\n//             \\/ there may be anything extending MutableMap\nval items = mutableMapOf(\"pickaxe\" to \"diamond\", \"axe\" to \"iron\").observableMap {\n    put { key, prevValue, value -\u003e\n        println(\"put[$key]: ${prevValue ?: \"\u003cnull\u003e\"} to $value\")\n    }\n    remove { key, value -\u003e\n        println(\"remove[$key]: $value\")\n    }\n    clear { elements -\u003e\n        println(\"clear: $elements\")\n    }\n}\nitems[\"pickaxe\"] = \"stone\" // put[pickaxe]: diamond to stone\nitems[\"bow\"] = \"wooden\"    // put[bow]: \u003cnull\u003e to wooden\nitems.remove(\"axe\")        // remove[axe]: iron\nitems.clear()              // clear: {pickaxe=stone, bow=wooden}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpearxteam%2Fokservable","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpearxteam%2Fokservable","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpearxteam%2Fokservable/lists"}