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
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ body().add(page()
33
33
34
34
PatternFly Java aims to provide almost complete support for all components, charts, extensions, and layouts. To see it in action, head over to the [showcase](https://patternfly-java.github.io/). It demonstrates all currently supported components and layouts. To get all the details about using PatternFly Java, look at the [API documentation](https://patternfly-java.github.io/apidocs/).
35
35
36
-
# Get Started
36
+
# Get started
37
37
38
38
PatternFly Java is available on [Maven Central](https://central.sonatype.com/search?q=g%3Aorg.patternfly). The easiest way is to import its BOM
39
39
@@ -103,13 +103,13 @@ Here’s the dependency graph of these maven modules and its external dependenci
103
103
104
104
105
105
106
-
# API Design
106
+
# API design
107
107
108
108
PatternFly Java integrates with and builds upon Elemento's [builder API](https://github.com/hal/elemento#builder-api). Static factory methods are used to create the components, and public instances methods add child elements and modify the component.
109
109
110
110
In general the API for a component can be classified into these groups:
111
111
112
-
## Static Factory Methods
112
+
## Static factory methods
113
113
114
114
These methods are used to create a component. They are usually named after the component, are overloaded to accept required and optional arguments, and return an instance of the newly created component:
These methods add subcomponents to a main component. They are usually called `add<SubComponent>()` and return the main component so that the method call can be chained with other methods.
These methods modify the current component. They return the current component so that the method call can be chained with other methods.
137
137
@@ -142,7 +142,7 @@ Card card = card()
142
142
.large();
143
143
```
144
144
145
-
## ARIA Related Methods
145
+
## ARIA related methods
146
146
147
147
These methods set ARIA related attributes in the component. They're usually named `aria<Attribute>()` and return the component so that the method call can be chained with other methods.
These methods add event handlers for various event to the component. They are usually named `on<Event>()`, accept an event handler, and return the component so that the method call can be chained with other methods. PatternFly Java defines some [common event handlers](https://patternfly-java.github.io/apidocs/org/patternfly/handler/package-summary.html) that are reused in all components. In some cases, components also use specific event handlers that only apply to the component.
These methods do something with the component or return a value, a property or some other kind of information. They return either `void` or a value/property.
See also the PatternFly website about [icons](https://www.patternfly.org/design-foundations/icons#all-icons) to get an overview of the available icons.
221
221
222
-
# PatternFly Support
222
+
# PatternFly support
223
223
224
224
PatternFly Java aims to provide almost complete support for all components, charts, extensions, and layouts. The following issues show how many components, charts, extensions, and layouts have already been implemented.
225
225
@@ -228,7 +228,7 @@ PatternFly Java aims to provide almost complete support for all components, char
PatternFly Java is still under development. The API might change, and things might not work as expected. Please give it a try and share your feedback. Join the [chat](https://app.gitter.im/#/room/#pf4-java_core:gitter.im), enter the [discussions](https://github.com/orgs/patternfly-java/discussions) or use the GitHub [issues](https://github.com/patternfly-java/patternfly-java/issues) to report bugs or request new features.
Copy file name to clipboardExpand all lines: showcase/common/src/doc/get-involved.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Get Involved
1
+
# Get involved
2
2
3
3
PatternFly Java is still under development. The API might change, and things might not work as expected. Please give it a try and share your feedback. Join the [chat](https://app.gitter.im/#/room/#pf4-java_core:gitter.im), enter the [discussions](https://github.com/orgs/patternfly-java/discussions) or use the GitHub [issues](https://github.com/patternfly-java/patternfly-java/issues) to report bugs or request new features.
PatternFly Java integrates with and builds upon Elemento's [builder API](https://github.com/hal/elemento#builder-api). Static factory methods are used to create the components, and public instances methods add child elements and modify the component.
74
74
75
75
In general the API for a component can be classified into these groups:
76
76
77
-
## Static Factory Methods
77
+
## Static factory methods
78
78
79
79
These methods are used to create a component. They are usually named after the component, are overloaded to accept required and optional arguments, and return an instance of the newly created component:
These methods add subcomponents to a main component. They are usually called `add<SubComponent>()` and return the main component so that the method call can be chained with other methods.
89
89
@@ -96,7 +96,7 @@ Dropdown dropdown = dropdown()
96
96
.addItem(actionMenuItem("item-0", "Action"))))))
97
97
```
98
98
99
-
## Builder / Modifier Methods
99
+
## Builder / modifier methods
100
100
101
101
These methods modify the current component. They return the current component so that the method call can be chained with other methods.
102
102
@@ -107,7 +107,7 @@ Card card = card()
107
107
.large();
108
108
```
109
109
110
-
## ARIA Related Methods
110
+
## ARIA related methods
111
111
112
112
These methods set ARIA related attributes in the component. They're usually named `aria<Attribute>()` and return the component so that the method call can be chained with other methods.
These methods add event handlers for various event to the component. They are usually named `on<Event>()`, accept an event handler, and return the component so that the method call can be chained with other methods. PatternFly Java defines some [common event handlers](https://patternfly-java.github.io/apidocs/org/patternfly/handler/package-summary.html) that are reused in all components. In some cases, components also use specific event handlers that only apply to the component.
These methods do something with the component or return a value, a property or some other kind of information. They return either `void` or a value/property.
0 commit comments