Merge branch 'dependent-on-compose-web-material-snapshot'

Author: ShreckYe

README.md

@@ -1,16 +1,53 @@
 # Compose Multiplatform Material wrappers
 
-Some simple Compose Multiplatform Material Design component wrappers for desktop, Android, and web (mainly based on [KMDC](https://github.com/mpetuska/kmdc))
+[![Maven Central](https://img.shields.io/maven-central/v/com.huanshankeji/compose-multiplatform-material)](https://search.maven.org/artifact/com.huanshankeji/compose-multiplatform-material)
 
-We try to make the styles of the composable components follow those of the desktop and Android ones in `com.huanshankeji.compose.material`, meanwhile being compatible with the Web APIs. However, only a subset of the composable arguments is supported due to the API differences and limitations of the web composables this project depends on.
+Some simple Compose Multiplatform wrappers of common components, layouts, and Material Design components for desktop,
+Android, and web (mainly based on [KMDC](https://github.com/mpetuska/kmdc))
 
-Customizing styles (using `Modifier`s for desktop and Android, and `attrs: AttrBuilderContext<*>?` for web) is not supported yet.
+We try to make the function types of the composable components follow those of the desktop and Android ones
+in `androidx.compose.foundation` and `androidx.compose.material`, meanwhile being compatible with the Web APIs. However,
+only subsets of the composables and composable arguments are supported due to the API differences, limitations of the
+web composables this project depends on, and our limited effort.
 
 Visual consistency across different platforms is not guaranteed.
 
-There is no documentation for this project yet. Check out the demo project on how to use the components.
+This project is prototype and there is no documentation yet. Check out [the demo project](demo) on how to use the components.
 
-## Supported components
+<!--
+There is no plan to support Apple platforms until there is official support from [Compose Multiplatform](https://github.com/JetBrains/compose-jb). Check out <https://github.com/cl3m/multiplatform-compose> for some experiments and prototypes on supporting iOS with Compose Multiplatform.
+-->
+
+## Supported features
+
+### Components
+
+#### Common (Foundation) components
+
+- `BasicText`
+- `RawText`
+
+##### Layouts
+
+- `Box`
+- `Column` (via flexbox on web)
+- `Row` (via flexbox on web)
+
+#### Material components
 
 - `Button`
+- `Card`
+- `Icon`
+- `IconButton`
+- `ScrollableList`/`LazyColumn` (visually inconsistent for now)
+- `Text`/`MaterialText`
 - `TopAppBarScaffold`
+
+### styles
+
+- `height`
+- `margin`
+- `width`
+- `backgroundColor`
+- `border`
+- `outerBorder`

buildSrc/build.gradle.kts

@@ -10,7 +10,7 @@ repositories {
 
 dependencies {
     implementation(kotlin("gradle-plugin", "1.7.20"))
-    implementation("org.jetbrains.compose:compose-gradle-plugin:1.2.1")
+    implementation("org.jetbrains.compose:compose-gradle-plugin:1.2.2")
     implementation("com.huanshankeji.team:gradle-plugins:0.3.2") {
         exclude("org.jetbrains.kotlin")
     }

buildSrc/src/main/kotlin/VersionsAndDependencies.kt

@@ -0,0 +1,3 @@
+object DependencyVersions {
+    val huanshankejiComposeWeb = "0.2.0"
+}

buildSrc/src/main/kotlin/common-conventions.gradle.kts

@@ -4,6 +4,7 @@ plugins {
 }
 
 repositories {
+    mavenLocal()
     mavenCentral()
     maven("https://maven.pkg.jetbrains.space/public/p/compose/dev")
     google()

compose-multiplatform-common/build.gradle.kts

@@ -7,6 +7,7 @@ kotlin {
         named("commonMain") {
             dependencies {
                 implementation(compose.runtime)
+                //compileOnly(compose.foundation) // for KDoc element links only
             }
         }
         named("jvmMain") {
@@ -17,6 +18,8 @@ kotlin {
         named("jsMain") {
             dependencies {
                 implementation(compose.web.core)
+
+                api("com.huanshankeji:compose-web-common:${DependencyVersions.huanshankejiComposeWeb}")
             }
         }
     }

compose-multiplatform-common/src/commonMain/kotlin/com/huanshankeji/compose/BasicText.kt

@@ -1,6 +1,10 @@
 package com.huanshankeji.compose
 
 import androidx.compose.runtime.Composable
+import com.huanshankeji.compose.ui.Element
+import com.huanshankeji.compose.ui.ModifierOrAttrs
+
+expect abstract class BasicTextElement : Element
 
 @Composable
-expect fun BasicText(text: String)
+expect fun BasicText(text: String, modifierOrAttrs: ModifierOrAttrs<BasicTextElement> = null)

compose-multiplatform-common/src/commonMain/kotlin/com/huanshankeji/compose/RawText.kt

@@ -0,0 +1,7 @@
+package com.huanshankeji.compose
+
+import androidx.compose.runtime.Composable
+
+/** A raw text composable which doesn't add any element on web. */
+@Composable
+expect fun RawText(text: String)

…m/huanshankeji/compose/layout/Layouts.kt …n/com/huanshankeji/compose/layout/Box.ktcompose-multiplatform-common/src/commonMain/kotlin/com/huanshankeji/compose/layout/Layouts.kt renamed to compose-multiplatform-common/src/commonMain/kotlin/com/huanshankeji/compose/layout/Box.kt compose-multiplatform-common/src/commonMain/kotlin/com/huanshankeji/compose/layout/Layouts.kt renamed to compose-multiplatform-common/src/commonMain/kotlin/com/huanshankeji/compose/layout/Box.kt

@@ -0,0 +1,11 @@
+package com.huanshankeji.compose.layout
+
+import androidx.compose.runtime.Composable
+import com.huanshankeji.compose.ui.Element
+import com.huanshankeji.compose.ui.ModifierOrAttrs
+
+expect abstract class ColumnElement : Element
+expect interface ColumnScope
+
+@Composable
+expect fun Column(modifierOrAttrs: ModifierOrAttrs<ColumnElement> = null, content: @Composable ColumnScope.() -> Unit)

compose-multiplatform-common/src/commonMain/kotlin/com/huanshankeji/compose/layout/Column.kt

@@ -0,0 +1,11 @@
+package com.huanshankeji.compose.layout
+
+import androidx.compose.runtime.Composable
+import com.huanshankeji.compose.ui.Element
+import com.huanshankeji.compose.ui.ModifierOrAttrs
+
+expect abstract class RowElement : Element
+expect interface RowScope
+
+@Composable
+expect fun Row(modifierOrAttrs: ModifierOrAttrs<RowElement> = null, content: @Composable RowScope.() -> Unit)