Add some documentation

This commit is contained in:
2022-10-14 20:09:43 +02:00
parent 4954382f96
commit a1f1f3bb38
5 changed files with 7 additions and 4 deletions

View File

@@ -56,7 +56,7 @@ fun greet() = "world"
Replace the code in the file with the following for a simple click app: Replace the code in the file with the following for a simple click app:
```koltin ```kotlin
import kotlinx.browser.document import kotlinx.browser.document
import kotlinx.html.button import kotlinx.html.button
import kotlinx.html.div import kotlinx.html.div
@@ -144,4 +144,4 @@ the data changes, that would look like this:
In that case you can remove the requestUpdate call from the onClickFunction. In that case you can remove the requestUpdate call from the onClickFunction.
You can find a working repository of this example here: [example]() You can find a working repository of this example here: [kotlin-komponent-start](https://github.com/rnentjes/kotlin-komponent-start)

View File

@@ -3,3 +3,4 @@
* [Home](home.md) * [Home](home.md)
* [Getting started](getting-started.md) * [Getting started](getting-started.md)
* [How it works](how-it-works.md) * [How it works](how-it-works.md)

View File

@@ -15,8 +15,8 @@ This way there will not be double updates of the same komponent.
The render call will be invoked and every html builder function (div, span etc.) will call the The render call will be invoked and every html builder function (div, span etc.) will call the
different HtmlBuilder functions like onTagStart, onTagAttributeChange etc. different HtmlBuilder functions like onTagStart, onTagAttributeChange etc.
In these functions the HtmlBuilder will compare the dom against the call being made and it will update the DOM In these functions the HtmlBuilder will compare the dom against the call being made, and it will update the DOM
if needed. as needed.

View File

Before

Width:  |  Height:  |  Size: 184 KiB

After

Width:  |  Height:  |  Size: 184 KiB

View File

@@ -9,3 +9,5 @@ See the komp-todo repository for a basic example here: [komp-todo](https://githu
For a more complete example take a look at the simple-password-manager repository: [simple-password-manager](https://github.com/rnentjes/simple-password-manager) For a more complete example take a look at the simple-password-manager repository: [simple-password-manager](https://github.com/rnentjes/simple-password-manager)
Available on maven central: "nl.astraeus:kotlin-komponent-js:1.0.0" Available on maven central: "nl.astraeus:kotlin-komponent-js:1.0.0"
Some getting started documentation can be found [here](docs/getting-started.md)