Skip to content

Commit 23ef943

Browse files
committed
Rename occurrences of "Compose for Web" and "compose-web" into "Compose HTML" and "compose-html" and move related code
1 parent 80512f2 commit 23ef943

File tree

21 files changed

+28
-20
lines changed

21 files changed

+28
-20
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,36 @@
11
# Compose HTML Material
22

3-
[![Maven Central](https://img.shields.io/maven-central/v/com.huanshankeji/compose-web-material)](https://search.maven.org/artifact/com.huanshankeji/compose-web-material)
4-
[![Gradle Plugin Portal](https://img.shields.io/gradle-plugin-portal/v/com.huanshankeji.compose-web-material-conventions)](https://plugins.gradle.org/plugin/com.huanshankeji.compose-web-material-conventions)
3+
[![Maven Central](https://img.shields.io/maven-central/v/com.huanshankeji/compose-html-material)](https://search.maven.org/artifact/com.huanshankeji/compose-html-material)
4+
[![Gradle Plugin Portal](https://img.shields.io/gradle-plugin-portal/v/com.huanshankeji.compose-html-material-conventions)](https://plugins.gradle.org/plugin/com.huanshankeji.compose-html-material-conventions)
55

66
Some Material components for Compose HTML, based on [Material Web (with Web Components) (or material-web, or `mwc`)](https://github.com/material-components/material-web) (preferred) and [Material Components for the web (or material-components-web, or `mdc`)](https://github.com/material-components/material-components-web) (fallback)
77

88
~~This project is in prototype and the components are not complete. More components will be added. It will probably go through huge refactors and API changes, too.~~
99

1010
**This project is not currently under active development. Here is a list of reasons and alternatives:**
1111

12-
1. The [material-web](https://github.com/material-components/material-web) team is working on Material You (Material Design 3) support and [the Material 2 branch (`mwc`)](https://github.com/material-components/material-web/tree/mwc) is no longer under active development. Existing Compose wrappers of their Material 2 components are still kept in [the `:compose-web-material` subproject](compose-web-material) but not updated.
12+
1. The [material-web](https://github.com/material-components/material-web) team is working on Material You (Material Design 3) support and [the Material 2 branch (`mwc`)](https://github.com/material-components/material-web/tree/mwc) is no longer under active development. Existing Compose wrappers of their Material 2 components are still kept in [the `:compose-html-material` subproject](compose-html-material) but not updated.
1313
1. [KMDC](https://github.com/mpetuska/kmdc) wrapping around [material-components-web (`mdc`)](https://github.com/material-components/material-components-web) provides a much more complete set of Material Design components for Compose HTML.
14-
1. We are currently focusing more on [compose-multiplatform-material](https://github.com/huanshankeji/compose-multiplatform-material) to provide multiplatform Compose Material wrappers, whose web portion depends on KMDC and [the `:compose-web-common` subproject](compose-web-common), which may be occasionally updated for the dependent project.
14+
1. We are currently focusing more on [compose-multiplatform-material](https://github.com/huanshankeji/compose-multiplatform-material) to provide multiplatform Compose Material wrappers, whose web portion depends on KMDC and [the `:compose-html-common` subproject](compose-html-common), which may be occasionally updated for the dependent project.
1515

1616
## Instructions on how to use
1717

1818
Some configurations are needed to use this library due to the immaturities of this project and Kotlin/JS.
1919

2020
### Add the dependency
2121

22+
Prior to v0.3.0:
23+
2224
```kotlin
2325
implementation("com.huanshankeji:compose-web-material:$version")
2426
```
2527

28+
Since v0.3.0:
29+
30+
```kotlin
31+
implementation("com.huanshankeji:compose-html-material:$version")
32+
```
33+
2634
### In code
2735

2836
Call `mwcRequires()` in your `main` function before calling any component Composable functions.
@@ -31,7 +39,7 @@ Call `mwcRequires()` in your `main` function before calling any component Compos
3139

3240
If you use this library in an app project with Webpack [which Kotlin/JS currently uses](https://kotlinlang.org/docs/js-project-setup.html), you might want to configure it as recommended by Material Web and Material Components for the web. Some instructions on how to do this simply are as below.
3341

34-
This plugin helps add the dependency to this project (if you do this you can skip the "Add the dependency" step above) and the `devNpm` dependencies:
42+
If you use a version prior to v0.3.0, this plugin helps add the dependency to this project (if you do this you can skip the "Add the dependency" step above) and the `devNpm` dependencies:
3543

3644
```kotlin
3745
plugins {

buildSrc/src/main/kotlin/VersionsAndDependencies.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import com.huanshankeji.CommonDependencies
22

3-
const val projectVersion = "0.2.2-SNAPSHOT"
3+
const val projectVersion = "0.3.0-SNAPSHOT"
44

55
object DependencyVersions {
66
val webcomponents = "2.6.0"

compose-web-common/build.gradle.kts renamed to compose-html-common/build.gradle.kts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ kotlin {
2020
publishing.publications.withType<MavenPublication> {
2121
pomForTeamDefaultOpenSource(
2222
project,
23-
"Huanshankeji Compose for Web common",
24-
"Huanshankeji's common code for Compose for Web"
23+
"Huanshankeji Compose HTML common",
24+
"Huanshankeji's common code for Compose HTML"
2525
) {
2626
`Shreck Ye`()
2727
}

0 commit comments

Comments
 (0)