Skip to content

Commit

Permalink
README typos
Browse files Browse the repository at this point in the history
  • Loading branch information
mpetuska committed Dec 29, 2021
1 parent eb9d895 commit c990c3f
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
# Kompose Material Design Components (KMDC)

A set of kotlin wrappers
over [[email protected]](https://github.com/material-components/material-components-web/tree/v13.0.0)
over [[email protected]][material-components-web]
library providing Jetbrains Compose DSL for building beautiful WEB UIs. The API surface is identical to JS version,
except for few places where slight adjustments are made to make it more fluid for compose.

## Setup

KMDC wraps each MDC module 1:1 and as such allows you to pick and choose which exact components you'd like to use. This
is recommended approach as it helps in reducing bundle size. However, for the lazy ones out there, a "shortcut" module
is also available, which bring in all KMDC mopdules as transitive dependencies under a single dependency.
is also available, which brings in all KMDC modules as transitive dependencies under a single dependency.

Either approach can be installed by declaring relevant dependencies in your `jsMain` sourceSet.

Expand All @@ -28,10 +28,12 @@ kotlin {
dependencies {
// Be lazy and use the shortcut
implementation("dev.petuska:kmdc:_")
implementation("dev.petuska:kmdcx:_")

// Do some work and see dem gains
implementation("dev.petuska:kmdc-button:_")
implementation("dev.petuska:kmdc-radio:_")
implementation("dev.petuska:kmdcx-icons:_")
}
}
}
Expand All @@ -45,7 +47,7 @@ naming convention to make its components more discoverable as well. The conventi
is `MDC[UpperCamelCaseMDCComponentName]` (e.g. `MDCTopAppBar`). Most of the components also follow the same argument
order schema:

1. `opts: (MDCComponentOpth.() -> Unit)? = null` - MDC-specific option overrides
1. `opts: (MDCComponentOpts.() -> Unit)? = null` - MDC-specific options overrides
2. `attrs: (ArrtsBuilder<out HTMLElement>.() -> Unit)? = null` - compose attributes builder for the underlying HTML
element
3. `content: (ElementBuilder<out HTMLElement>.() -> Unit)? = null` - compose inner content builder for the underlying
Expand All @@ -71,7 +73,7 @@ fun Sample() {

### Progress

Here's a tracker list of currently completed *material-components-web* modules (25/49):
Here's a tracker list of currently completed [material-components-web] modules (25/49):

- [ ] mdc-animation (SASS)
- [x] mdc-auto-init (won't wrap)
Expand Down Expand Up @@ -157,3 +159,5 @@ KMDC project modules can be categorised into three groups:
browser. It takes a few seconds after you save your changes, so be patient.

> Further details can be found in [Contributing Guidelines](./docs/CONTRIBUTING.md#what-should-i-know-before-i-get-started)
[material-components-web]: https://github.com/material-components/material-components-web/tree/v13.0.0

0 comments on commit c990c3f

Please sign in to comment.