Skip to content

Commit

Permalink
update readme for 0.7.0
Browse files Browse the repository at this point in the history
  • Loading branch information
tschuehly committed Nov 1, 2023
1 parent 21df5ca commit 5955295
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
![image](https://user-images.githubusercontent.com/33346637/235085980-eb16eaa3-ec89-4293-9609-cf651a44f60e.png)

Spring ViewComponent allows you to create typesafe, reusable & encapsulated server rendered view components.
Spring ViewComponent allows you to create typesafe, reusable & encapsulated server rendered ui components.

##### Table of Contents
- [What’s a ViewComponent?](#whats-a-viewcomponent)
Expand Down Expand Up @@ -54,7 +54,7 @@ class SimpleViewComponent{
</details>

A ViewComponent always need a corresponding HTML Template.
We define the Template in the SimpleViewComponent.[html/jte/kte] in the same package as our ViewComponent Class.
We define the Template in the SimpleViewComponent.[html/jte/kte] in the same package as our ViewComponent class.

We can use [Thymeleaf](https://thymeleaf.org)

Expand All @@ -80,14 +80,10 @@ or [KTE](https://jte.gg/#5-minutes-example)
<div>${simpleView.helloWorld}</div>
</div>
```
[Installation with Gradle](#gradle-installation)

[Thymeleaf Example](https://github.com/tschuehly/spring-view-component/tree/master/examples/thymeleaf-demo)
[JTE Example](https://github.com/tschuehly/spring-view-component/tree/master/examples/jte-demo)

## Render a ViewComponent

We can then call the render method in our Controller
We can then call the render method in our controller to render the template.
<details open>
<summary>Java</summary>

Expand Down Expand Up @@ -126,7 +122,7 @@ class SimpleController(

## Examples

If you want to get started right away you can find examples for all possibilites here:
If you want to get started right away you can find examples for all possible language combinations here:
[Examples](/examples/)

## Nesting ViewComponents:
Expand Down Expand Up @@ -388,6 +384,8 @@ annotationProcessor("de.tschuehly:spring-view-component-core:LATEST_VERSION")



# Experimental stuff:

## Composing pages from components

**!!! Currently only supported in Thymeleaf !!!**
Expand Down

0 comments on commit 5955295

Please sign in to comment.