Skip to content

Commit 56ac70c

Browse files
Update README.md
1 parent 33492ae commit 56ac70c

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,29 @@ A Vaadin Flow implementation for editable labels
1010

1111
![demo](assets/demo.png)
1212

13+
This component provides a couple of elements that are displayed as simple read-only components, but can be edited with a
14+
simple click.
15+
Following components are available:
16+
17+
* [EditableLabelTextField](./vaadin-editable-label/src/main/java/software/xdev/vaadin/editable_label/predefined/EditableLabelTextField.java)
18+
* [EditableLabelTextArea](./vaadin-editable-label/src/main/java/software/xdev/vaadin/editable_label/predefined/EditableLabelTextArea.java)
19+
* [EditableLabelComboBox](./vaadin-editable-label/src/main/java/software/xdev/vaadin/editable_label/predefined/EditableLabelComboBox.java)
20+
* [EditableLabelDatePicker](./vaadin-editable-label/src/main/java/software/xdev/vaadin/editable_label/predefined/EditableLabelDatePicker.java)
21+
* [EditableLabelNumberField](./vaadin-editable-label/src/main/java/software/xdev/vaadin/editable_label/predefined/EditableLabelNumberField.java)
22+
* [EditableLabelBigDecimalField](./vaadin-editable-label/src/main/java/software/xdev/vaadin/editable_label/predefined/EditableLabelBigDecimalField.java)
23+
24+
It's also possible to create a custom element:
25+
26+
```java
27+
final EditableLabel<EmailField, String> emailLabel = new EditableLabel<>(new EmailField()).withValue(defaultValue);
28+
```
29+
1330
## Installation
1431

1532
[Installation guide for the latest release](https://github.com/xdev-software/vaadin-editable-label/releases/latest#Installation)
1633

1734
## Run the Demo
35+
1836
* Checkout the repo
1937
* Run ``mvn install && mvn -f vaadin-editable-label-demo spring-boot:run``
2038
* Open http://localhost:8080

0 commit comments

Comments
 (0)