[minor] adds multi-select checkbox controls

copper-leaf · Jul 16, 2022 · 60e880f · 60e880f
1 parent e8bfe23
commit 60e880f
Show file tree

Hide file tree

Showing 9 changed files with 205 additions and 11 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 - Adds code editor control
 - Connects rich text widget to form state
+- adds multi-select checkbox controls
 
 ## 0.2.0 - 2022-07-05
 

diff --git a/example/src/jvmMain/resources/kitchenSink/schema.json b/example/src/jvmMain/resources/kitchenSink/schema.json
@@ -62,6 +62,39 @@
                             "title": "FooBar"
                         }
                     ]
+                },
+
+                "checkboxesEnum": {
+                    "type": "array",
+                    "uniqueItems": true,
+                    "items": {
+                        "type": "string",
+                        "enum": [
+                            "foo",
+                            "bar",
+                            "foobar"
+                        ]
+                    }
+                },
+                "checkboxesOneOf": {
+                    "type": "array",
+                    "uniqueItems": true,
+                    "items": {
+                        "oneOf": [
+                            {
+                                "const": "foo",
+                                "title": "Foo"
+                            },
+                            {
+                                "const": "bar",
+                                "title": "Bar"
+                            },
+                            {
+                                "const": "foobar",
+                                "title": "FooBar"
+                            }
+                        ]
+                    }
                 }
             }
         },

diff --git a/example/src/jvmMain/resources/kitchenSink/uiSchema.json b/example/src/jvmMain/resources/kitchenSink/uiSchema.json
@@ -61,6 +61,14 @@
                     "type": "Category",
                     "label": "Multi-Select",
                     "elements": [
+                        {
+                            "type": "Control",
+                            "scope": "#/properties/strings/properties/checkboxesEnum"
+                        },
+                        {
+                            "type": "Control",
+                            "scope": "#/properties/strings/properties/checkboxesOneOf"
+                        }
                     ]
                 },
                 {

diff --git a/json-forms-compose/api/android/json-forms-compose.api b/json-forms-compose/api/android/json-forms-compose.api
@@ -16,6 +16,8 @@ public final class com/copperleaf/forms/compose/controls/ComposableSingletons$De
 	public static field lambda-15 Lkotlin/jvm/functions/Function3;
 	public static field lambda-16 Lkotlin/jvm/functions/Function3;
 	public static field lambda-17 Lkotlin/jvm/functions/Function3;
+	public static field lambda-18 Lkotlin/jvm/functions/Function3;
+	public static field lambda-19 Lkotlin/jvm/functions/Function3;
 	public static field lambda-2 Lkotlin/jvm/functions/Function3;
 	public static field lambda-3 Lkotlin/jvm/functions/Function3;
 	public static field lambda-4 Lkotlin/jvm/functions/Function3;
@@ -34,6 +36,8 @@ public final class com/copperleaf/forms/compose/controls/ComposableSingletons$De
 	public final fun getLambda-15$json_forms_compose_release ()Lkotlin/jvm/functions/Function3;
 	public final fun getLambda-16$json_forms_compose_release ()Lkotlin/jvm/functions/Function3;
 	public final fun getLambda-17$json_forms_compose_release ()Lkotlin/jvm/functions/Function3;
+	public final fun getLambda-18$json_forms_compose_release ()Lkotlin/jvm/functions/Function3;
+	public final fun getLambda-19$json_forms_compose_release ()Lkotlin/jvm/functions/Function3;
 	public final fun getLambda-2$json_forms_compose_release ()Lkotlin/jvm/functions/Function3;
 	public final fun getLambda-3$json_forms_compose_release ()Lkotlin/jvm/functions/Function3;
 	public final fun getLambda-4$json_forms_compose_release ()Lkotlin/jvm/functions/Function3;
@@ -84,6 +88,8 @@ public final class com/copperleaf/forms/compose/controls/ControlScope {
 
 public final class com/copperleaf/forms/compose/controls/DefaultControlsKt {
 	public static final fun checkbox (Lcom/copperleaf/forms/core/BooleanControl;)Lcom/copperleaf/forms/compose/form/Registered;
+	public static final fun checkboxesEnum (Lcom/copperleaf/forms/core/ArrayControl;)Lcom/copperleaf/forms/compose/form/Registered;
+	public static final fun checkboxesOneOf (Lcom/copperleaf/forms/core/ArrayControl;)Lcom/copperleaf/forms/compose/form/Registered;
 	public static final fun codeEditor (Lcom/copperleaf/forms/core/StringControl;)Lcom/copperleaf/forms/compose/form/Registered;
 	public static final fun control (Lcom/copperleaf/forms/core/ArrayControl;)Lcom/copperleaf/forms/compose/form/Registered;
 	public static final fun control (Lcom/copperleaf/forms/core/IntegerControl;)Lcom/copperleaf/forms/compose/form/Registered;
@@ -103,10 +109,14 @@ public final class com/copperleaf/forms/compose/controls/LayoutKt {
 }
 
 public final class com/copperleaf/forms/compose/controls/TestersKt {
+	public static final fun hasArrayItemProperty (Lcom/copperleaf/forms/core/ui/UiElement$Control;Ljava/lang/String;)Z
+	public static final fun hasArrayItemType (Lcom/copperleaf/forms/core/ui/UiElement$Control;Lcom/copperleaf/forms/core/StringControl;)Z
 	public static final fun hasSchemaProperty (Lcom/copperleaf/forms/core/ui/UiElement$Control;Ljava/lang/String;)Z
 	public static final fun matchesControlType (Lcom/copperleaf/forms/core/ui/UiElement$Control;Lcom/copperleaf/forms/core/ControlType;)Z
 	public static final fun optionFieldIs (Lcom/copperleaf/forms/core/ui/UiElement$Control;Ljava/lang/String;Ljava/lang/String;)Z
 	public static final fun optionIsEnabled (Lcom/copperleaf/forms/core/ui/UiElement$Control;Ljava/lang/String;)Z
+	public static final fun schemaPropertyIs (Lcom/copperleaf/forms/core/ui/UiElement$Control;Ljava/lang/String;Ljava/lang/String;)Z
+	public static final fun schemaPropertyIsEnabled (Lcom/copperleaf/forms/core/ui/UiElement$Control;Ljava/lang/String;)Z
 }
 
 public final class com/copperleaf/forms/compose/elements/ComposableSingletons$DefaultUiElementsKt {

diff --git a/json-forms-compose/api/jvm/json-forms-compose.api b/json-forms-compose/api/jvm/json-forms-compose.api
@@ -9,6 +9,8 @@ public final class com/copperleaf/forms/compose/controls/ComposableSingletons$De
 	public static field lambda-15 Lkotlin/jvm/functions/Function3;
 	public static field lambda-16 Lkotlin/jvm/functions/Function3;
 	public static field lambda-17 Lkotlin/jvm/functions/Function3;
+	public static field lambda-18 Lkotlin/jvm/functions/Function3;
+	public static field lambda-19 Lkotlin/jvm/functions/Function3;
 	public static field lambda-2 Lkotlin/jvm/functions/Function3;
 	public static field lambda-3 Lkotlin/jvm/functions/Function3;
 	public static field lambda-4 Lkotlin/jvm/functions/Function3;
@@ -27,6 +29,8 @@ public final class com/copperleaf/forms/compose/controls/ComposableSingletons$De
 	public final fun getLambda-15$json_forms_compose ()Lkotlin/jvm/functions/Function3;
 	public final fun getLambda-16$json_forms_compose ()Lkotlin/jvm/functions/Function3;
 	public final fun getLambda-17$json_forms_compose ()Lkotlin/jvm/functions/Function3;
+	public final fun getLambda-18$json_forms_compose ()Lkotlin/jvm/functions/Function3;
+	public final fun getLambda-19$json_forms_compose ()Lkotlin/jvm/functions/Function3;
 	public final fun getLambda-2$json_forms_compose ()Lkotlin/jvm/functions/Function3;
 	public final fun getLambda-3$json_forms_compose ()Lkotlin/jvm/functions/Function3;
 	public final fun getLambda-4$json_forms_compose ()Lkotlin/jvm/functions/Function3;
@@ -77,6 +81,8 @@ public final class com/copperleaf/forms/compose/controls/ControlScope {
 
 public final class com/copperleaf/forms/compose/controls/DefaultControlsKt {
 	public static final fun checkbox (Lcom/copperleaf/forms/core/BooleanControl;)Lcom/copperleaf/forms/compose/form/Registered;
+	public static final fun checkboxesEnum (Lcom/copperleaf/forms/core/ArrayControl;)Lcom/copperleaf/forms/compose/form/Registered;
+	public static final fun checkboxesOneOf (Lcom/copperleaf/forms/core/ArrayControl;)Lcom/copperleaf/forms/compose/form/Registered;
 	public static final fun codeEditor (Lcom/copperleaf/forms/core/StringControl;)Lcom/copperleaf/forms/compose/form/Registered;
 	public static final fun control (Lcom/copperleaf/forms/core/ArrayControl;)Lcom/copperleaf/forms/compose/form/Registered;
 	public static final fun control (Lcom/copperleaf/forms/core/IntegerControl;)Lcom/copperleaf/forms/compose/form/Registered;
@@ -96,10 +102,14 @@ public final class com/copperleaf/forms/compose/controls/LayoutKt {
 }
 
 public final class com/copperleaf/forms/compose/controls/TestersKt {
+	public static final fun hasArrayItemProperty (Lcom/copperleaf/forms/core/ui/UiElement$Control;Ljava/lang/String;)Z
+	public static final fun hasArrayItemType (Lcom/copperleaf/forms/core/ui/UiElement$Control;Lcom/copperleaf/forms/core/StringControl;)Z
 	public static final fun hasSchemaProperty (Lcom/copperleaf/forms/core/ui/UiElement$Control;Ljava/lang/String;)Z
 	public static final fun matchesControlType (Lcom/copperleaf/forms/core/ui/UiElement$Control;Lcom/copperleaf/forms/core/ControlType;)Z
 	public static final fun optionFieldIs (Lcom/copperleaf/forms/core/ui/UiElement$Control;Ljava/lang/String;Ljava/lang/String;)Z
 	public static final fun optionIsEnabled (Lcom/copperleaf/forms/core/ui/UiElement$Control;Ljava/lang/String;)Z
+	public static final fun schemaPropertyIs (Lcom/copperleaf/forms/core/ui/UiElement$Control;Ljava/lang/String;Ljava/lang/String;)Z
+	public static final fun schemaPropertyIsEnabled (Lcom/copperleaf/forms/core/ui/UiElement$Control;Ljava/lang/String;)Z
 }
 
 public final class com/copperleaf/forms/compose/elements/ComposableSingletons$DefaultUiElementsKt {

diff --git a/...-compose/src/androidMain/kotlin/com/copperleaf/forms/compose/form/registration.android.kt b/...-compose/src/androidMain/kotlin/com/copperleaf/forms/compose/form/registration.android.kt
@@ -2,6 +2,8 @@ package com.copperleaf.forms.compose.form
 
 import com.copperleaf.forms.compose.controls.ControlRenderer
 import com.copperleaf.forms.compose.controls.checkbox
+import com.copperleaf.forms.compose.controls.checkboxesEnum
+import com.copperleaf.forms.compose.controls.checkboxesOneOf
 import com.copperleaf.forms.compose.controls.codeEditor
 import com.copperleaf.forms.compose.controls.control
 import com.copperleaf.forms.compose.controls.dropdownEnum
@@ -31,21 +33,30 @@ import com.copperleaf.forms.core.ui.UiElement
 
 public actual fun UiElement.Control.Companion.defaults(): List<Registered<UiElement.Control, ControlRenderer>> =
     listOf(
+        // text fields
         StringControl.control(),
         StringControl.richText(),
         StringControl.codeEditor(),
 
+        // single-select
         StringControl.dropdownEnum(),
         StringControl.dropdownOneOf(),
         StringControl.radioButtonEnum(),
         StringControl.radioButtonOneOf(),
 
+        // multi-select
+        ArrayControl.checkboxesEnum(),
+        ArrayControl.checkboxesOneOf(),
+
+        // number controls
         IntegerControl.control(),
         NumberControl.control(),
 
+        // boolean controls
         BooleanControl.checkbox(),
         BooleanControl.switch(),
 
+        // composite controls
         ObjectControl.control(),
         ArrayControl.control(),
     )

diff --git a/...ms-compose/src/commonMain/kotlin/com/copperleaf/forms/compose/controls/defaultControls.kt b/...ms-compose/src/commonMain/kotlin/com/copperleaf/forms/compose/controls/defaultControls.kt
@@ -86,7 +86,7 @@ import kotlinx.serialization.json.jsonArray
 import kotlinx.serialization.json.jsonObject
 import kotlinx.serialization.json.jsonPrimitive
 
-// StringControls
+// Text Field Controls
 // ---------------------------------------------------------------------------------------------------------------------
 
 public fun StringControl.control(): Registered<UiElement.Control, ControlRenderer> = uiControl {
@@ -204,6 +204,9 @@ public fun StringControl.codeEditor(): Registered<UiElement.Control, ControlRend
     }
 }
 
+// Single-Select Controls
+// ---------------------------------------------------------------------------------------------------------------------
+
 public fun StringControl.dropdownEnum(): Registered<UiElement.Control, ControlRenderer> = uiControl(
     rank = 20,
     tester = { hasSchemaProperty("enum") }
@@ -220,7 +223,7 @@ public fun StringControl.dropdownEnum(): Registered<UiElement.Control, ControlRe
     )
 
     var dropdownIsVisible by remember { mutableStateOf(false) }
-    val allDropdownOptions: List<String> = remember {
+    val allOptions: List<String> = remember {
         control.schemaConfig.arrayAt("enum").map { it.jsonPrimitive.content }
     }
 
@@ -248,8 +251,8 @@ public fun StringControl.dropdownEnum(): Registered<UiElement.Control, ControlRe
             expanded = dropdownIsVisible && isEnabled,
             onDismissRequest = { dropdownIsVisible = false },
         ) {
-            if (allDropdownOptions.isNotEmpty()) {
-                allDropdownOptions.forEach { option ->
+            if (allOptions.isNotEmpty()) {
+                allOptions.forEach { option ->
                     DropdownMenuItem(
                         onClick = {
                             updateText(TextFieldValue(option))
@@ -283,7 +286,7 @@ public fun StringControl.dropdownOneOf(): Registered<UiElement.Control, ControlR
     )
 
     var dropdownIsVisible by remember { mutableStateOf(false) }
-    val allDropdownOptions: List<Pair<String, String>> = remember {
+    val allOptions: List<Pair<String, String>> = remember {
         control.schemaConfig.arrayAt("oneOf").map {
             it.jsonObject.string("const") to it.jsonObject.string("title")
         }
@@ -314,8 +317,8 @@ public fun StringControl.dropdownOneOf(): Registered<UiElement.Control, ControlR
             expanded = dropdownIsVisible && isEnabled,
             onDismissRequest = { dropdownIsVisible = false },
         ) {
-            if (allDropdownOptions.isNotEmpty()) {
-                allDropdownOptions.forEach { (const, title) ->
+            if (allOptions.isNotEmpty()) {
+                allOptions.forEach { (const, title) ->
                     DropdownMenuItem(
                         onClick = {
                             updateText(TextFieldValue(const))
@@ -341,12 +344,12 @@ public fun StringControl.radioButtonEnum(): Registered<UiElement.Control, Contro
         it.jsonPrimitive.content
     }
 
-    val allDropdownOptions: List<String> = remember {
+    val allOptions: List<String> = remember {
         control.schemaConfig.arrayAt("enum").map { it.jsonPrimitive.content }
     }
 
     Row(Modifier.fillMaxSize(), horizontalArrangement = Arrangement.spacedBy(12.dp)) {
-        allDropdownOptions.forEach {
+        allOptions.forEach {
             Row(Modifier.clickable { updateFormState(it) }) {
                 RadioButton(
                     selected = currentValue == it,
@@ -367,14 +370,14 @@ public fun StringControl.radioButtonOneOf(): Registered<UiElement.Control, Contr
         it.jsonPrimitive.content
     }
 
-    val allDropdownOptions: List<Pair<String, String>> = remember {
+    val allOptions: List<Pair<String, String>> = remember {
         control.schemaConfig.arrayAt("oneOf").map {
             it.jsonObject.string("const") to it.jsonObject.string("title")
         }
     }
 
     Row(Modifier.fillMaxSize(), horizontalArrangement = Arrangement.spacedBy(12.dp)) {
-        allDropdownOptions.forEach { (const, title) ->
+        allOptions.forEach { (const, title) ->
             Row(Modifier.clickable { updateFormState(const) }) {
                 RadioButton(
                     selected = currentValue == const,
@@ -387,6 +390,93 @@ public fun StringControl.radioButtonOneOf(): Registered<UiElement.Control, Contr
     }
 }
 
+// Multi-Select Controls
+// ---------------------------------------------------------------------------------------------------------------------
+
+public fun ArrayControl.checkboxesEnum(): Registered<UiElement.Control, ControlRenderer> = uiControl(
+    rank = 20,
+    tester = { hasSchemaProperty("uniqueItems") && hasArrayItemType(StringControl) && hasArrayItemProperty("enum") }
+) {
+    val selectedValues: List<String> = getTypedValue(emptyList()) {
+        if (it == JsonNull) {
+            emptyList()
+        } else {
+            it.jsonArray.map { it.jsonPrimitive.content }
+        }
+    }
+    val allOptions: List<String> = remember {
+        control.schemaConfig.objectAt("items").arrayAt("enum").map { it.jsonPrimitive.content }
+    }
+
+    Row(Modifier.fillMaxSize(), horizontalArrangement = Arrangement.spacedBy(12.dp)) {
+        allOptions.forEach { option ->
+            Row(Modifier.clickable {
+                if (option in selectedValues) {
+                    sendFormAction(
+                        pointer = dataPointer + "/${selectedValues.indexOf(option)}",
+                        action = JsonPointerAction.RemoveValue,
+                    )
+                } else {
+                    sendFormAction(
+                        pointer = dataPointer + "/${selectedValues.size}",
+                        action = JsonPointerAction.SetValue(option),
+                    )
+                }
+                markAsTouched()
+            }) {
+                Checkbox(
+                    checked = option in selectedValues,
+                    onCheckedChange = null,
+                    modifier = Modifier.padding(end = 8.dp)
+                )
+                Text(option)
+            }
+        }
+    }
+}
+
+public fun ArrayControl.checkboxesOneOf(): Registered<UiElement.Control, ControlRenderer> = uiControl(
+    rank = 21,
+    tester = { hasSchemaProperty("uniqueItems") && hasArrayItemProperty("oneOf") }
+) {
+    val selectedValues: List<String> = getTypedValue(emptyList()) {
+        if (it == JsonNull) {
+            emptyList()
+        } else {
+            it.jsonArray.map { it.jsonPrimitive.content }
+        }
+    }
+    val allOptions: List<Pair<String, String>> = remember {
+        control.schemaConfig.objectAt("items").arrayAt("oneOf").map { it.string("const") to it.string("title") }
+    }
+
+    Row(Modifier.fillMaxSize(), horizontalArrangement = Arrangement.spacedBy(12.dp)) {
+        allOptions.forEach { (const, title) ->
+            Row(Modifier.clickable {
+                if (const in selectedValues) {
+                    sendFormAction(
+                        pointer = dataPointer + "/${selectedValues.indexOf(const)}",
+                        action = JsonPointerAction.RemoveValue,
+                    )
+                } else {
+                    sendFormAction(
+                        pointer = dataPointer + "/${selectedValues.size}",
+                        action = JsonPointerAction.SetValue(const),
+                    )
+                }
+                markAsTouched()
+            }) {
+                Checkbox(
+                    checked = const in selectedValues,
+                    onCheckedChange = null,
+                    modifier = Modifier.padding(end = 8.dp)
+                )
+                Text(title)
+            }
+        }
+    }
+}
+
 // Number Controls
 // ---------------------------------------------------------------------------------------------------------------------