You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+41-5Lines changed: 41 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,6 +36,29 @@ Try the add-on demo at http://addonsv14.flowingcode.com/orgchart
36
36
37
37
Official releases at Vaadin Directory https://vaadin.com/directory/component/orgchart-add-on
38
38
39
+
### Maven install
40
+
41
+
Add the following dependencies in your pom.xml file:
42
+
43
+
```xml
44
+
<dependency>
45
+
<groupId>com.flowingcode.vaadin.addons</groupId>
46
+
<artifactId>orgchart-addon</artifactId>
47
+
<version>X.Y.Z</version>
48
+
</dependency>
49
+
```
50
+
<!-- the above dependency should be updated with latest released version information -->
51
+
52
+
```xml
53
+
<repository>
54
+
<id>vaadin-addons</id>
55
+
<url>https://maven.vaadin.com/vaadin-addons</url>
56
+
</repository>
57
+
```
58
+
59
+
For SNAPSHOT versions see [here](https://maven.flowingcode.com/snapshots/).
60
+
61
+
39
62
## Building and running demo
40
63
41
64
- git clone repository
@@ -76,14 +99,18 @@ The issues for this add-on are tracked on its github.com page. All bug reports a
76
99
77
100
## Contributions
78
101
79
-
Contributions are welcome, but there are no guarantees that they are accepted as such. Process for contributing is the following:
102
+
Contributions are welcome, but there are no guarantees that they are accepted as such.
103
+
104
+
As first step, please refer to our [Development Conventions](https://github.com/FlowingCode/DevelopmentConventions) page to find information about Conventional Commits & Code Style requeriments.
105
+
106
+
Then, follow these steps for creating a contibution:
80
107
81
-
- Fork this project
108
+
- Fork this project.
82
109
- Create an issue to this project about the contribution (bug or feature) if there is no such issue about it already. Try to keep the scope minimal.
83
110
- Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue.
84
-
-Refer to the fixed issue in commit
85
-
- Send a pull request for the original project
86
-
- Comment on the original issue that you have implemented a fix for it
111
+
-For commit message, use [Conventional Commits](https://github.com/FlowingCode/DevelopmentConventions/blob/main/conventional-commits.md) to describe your change.
112
+
- Send a pull request for the original project.
113
+
- Comment on the original issue that you have implemented a fix for it.
87
114
88
115
## License & Author
89
116
@@ -115,4 +142,13 @@ Here is a simple example on how to try out the add-on component:
115
142
layout.addComponent(orgChart);
116
143
```
117
144
145
+
## Special configuration when using Spring
146
+
147
+
By default, Vaadin Flow only includes ```com/vaadin/flow/component``` to be always scanned for UI components and views. For this reason, the addon might need to be whitelisted in order to display correctly.
148
+
149
+
To do so, just add ```com.flowingcode``` to the ```vaadin.whitelisted-packages``` property in ```src/main/resources/application.properties```, like:
More information on Spring whitelisted configuration [here](https://vaadin.com/docs/latest/integrations/spring/configuration/#configure-the-scanning-of-packages).
0 commit comments