Skip to content

Commit a6264a6

Browse files
[issue-59] - doc
1 parent cb9d06c commit a6264a6

1 file changed

Lines changed: 10 additions & 62 deletions

File tree

README.md

Lines changed: 10 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ Take a look at [CraftD: Server Driven UI for All Platforms](https://medium.com/c
1818
## Features
1919
### 🔗 Compatibility
2020

21-
| Tech | Support |
22-
|---------------------------------|:--------------------:|
23-
| View System - Android |**Supported** |
24-
| Jetpack Compose - Android |**Supported** |
25-
| Widget - Flutter |**Supported** |
26-
| SwiftUi - iOS |**Supported** |
27-
| Jetpack Compose - Multiplatform | ⚒️ **In Progress** |
21+
| Tech | Support |
22+
|---------------------------------|:-------------------:|
23+
| View System - Android | **Supported** |
24+
| Jetpack Compose - Android | **Supported** |
25+
| Widget - Flutter | **Supported** |
26+
| SwiftUi - iOS | **Supported** |
27+
| Jetpack Compose - Multiplatform | **Supported** |
2828

2929
### Components that already exist in the library
3030

@@ -34,65 +34,13 @@ Take a look at [CraftD: Server Driven UI for All Platforms](https://medium.com/c
3434
| Text | X | X | X | X |
3535
| CheckBox | X | - | - | X |
3636

37-
### Create your custom component( android compose example )
38-
39-
```kotlin
40-
@JsonIgnoreProperties(ignoreUnknown = true)
41-
@Immutable
42-
@Stable
43-
data class CheckBoxProperties(
44-
@JsonProperty("text") val text: String? = null,
45-
... rest of your properties
46-
)
47-
48-
```
49-
50-
#### Add your Component json object in Dymanic.json
51-
```json
52-
{
53-
"key": "CraftDCheckBox",
54-
"value": {
55-
... place your properties
56-
}
57-
}
58-
59-
```
60-
61-
#### Create your Component
62-
```kotlin
63-
@Composable
64-
fun CraftDCheckBox(
65-
checkboxProperties: CheckBoxProperties,
66-
modifier: Modifier = Modifier,
67-
onChecked: (Boolean) -> Unit
68-
) {
69-
... place your code
70-
}
71-
```
72-
73-
#### Create your Component Builder
74-
```kotlin
75-
class CraftDCheckBoxBuilder(
76-
override val key: String = CraftDComponentKey.CHECK_BOX_COMPONENT.key
77-
) :
78-
CraftDBuilder {
79-
@Composable
80-
override fun craft(model: SimpleProperties, listener: CraftDViewListener) {
81-
val checkBoxProperties = model.value.convertToVO<CheckBoxProperties>()
82-
CraftDCheckBox(checkBoxProperties) {
83-
checkBoxProperties.actionProperties?.let { listener.invoke(it) }
84-
}
85-
}
86-
}
87-
```
88-
8937
More details check our [documentation](https://codandotv.gitbook.io/craftd)
9038

9139

9240
### Samples
93-
| [Android Compose](https://github.com/CodandoTV/CraftD/tree/main/android_kmp/app-sample/src/main/java/com/github/codandotv/craftd/app_sample/presentation/compose) | [Android View System](https://github.com/CodandoTV/CraftD/tree/main/android_kmp/app-sample/src/main/java/com/github/codandotv/craftd/app_sample/presentation/xml) | [iOS SwiftUI](https://github.com/CodandoTV/CraftD/tree/main/ios/sample/CraftDSample) | [Flutter](https://github.com/CodandoTV/CraftD/tree/main/flutter/sample/lib) |
94-
|----------|----------|----------|----------|
95-
| <img src="https://github.com/CodandoTV/CraftD/assets/7690931/aa31d0a2-a998-402c-b2c2-4de5088ee30f" width="200" height="400" /> | <img src="https://github.com/CodandoTV/CraftD/assets/7690931/aa31d0a2-a998-402c-b2c2-4de5088ee30f" width="200" height="400" /> | <img src="https://github.com/user-attachments/assets/c8c653b2-1289-4437-85f2-f940d5135f27" width="200" height="400" /> | <img src="https://github.com/CodandoTV/CraftD/assets/7690931/dfabfda7-6501-4763-b040-3ee9fbf2a2be" width="200" height="400" /> |
41+
| [Android Compose / Compose MultiPlatform](https://github.com/CodandoTV/CraftD/tree/main/android_kmp/app-sample/src/main/java/com/github/codandotv/craftd/app_sample/presentation/compose) | [Android View System](https://github.com/CodandoTV/CraftD/tree/main/android_kmp/app-sample/src/main/java/com/github/codandotv/craftd/app_sample/presentation/xml) | [iOS SwiftUI](https://github.com/CodandoTV/CraftD/tree/main/ios/sample/CraftDSample) | [Flutter](https://github.com/CodandoTV/CraftD/tree/main/flutter/sample/lib) |
42+
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|----------|----------|
43+
| <img src="https://github.com/CodandoTV/CraftD/assets/7690931/aa31d0a2-a998-402c-b2c2-4de5088ee30f" width="200" height="400" /> | <img src="https://github.com/CodandoTV/CraftD/assets/7690931/aa31d0a2-a998-402c-b2c2-4de5088ee30f" width="200" height="400" /> | <img src="https://github.com/user-attachments/assets/c8c653b2-1289-4437-85f2-f940d5135f27" width="200" height="400" /> | <img src="https://github.com/CodandoTV/CraftD/assets/7690931/dfabfda7-6501-4763-b040-3ee9fbf2a2be" width="200" height="400" /> |
9644

9745

9846
### Credits

0 commit comments

Comments
 (0)