Skip to content

Commit 98ed15a

Browse files
committed
Update README.md
1 parent 4558508 commit 98ed15a

File tree

1 file changed

+24
-26
lines changed

1 file changed

+24
-26
lines changed

README.md

Lines changed: 24 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,20 @@
55
# App Layout Add-on
66

77
Vaadin Flow Java integration of https://github.com/PolymerElements/app-layout
8-
This addon is particularly usefull if you want to create a new application with some initial support for responsiveness.
8+
This addon is particularly useful if you want to create a new application with some initial support for responsiveness.
99

1010
## Features
1111

12-
* Left side menu with hamburguer button, and now with support for sub-menus and icons
13-
* Toolbar icons
14-
* Paper-cards with icons
15-
12+
* Left side menu with hamburguer button
13+
* Hierarchical menus with icons
14+
* Application header with logo, title and toolbar icons.
15+
* Menu separator
16+
* Support for left, middle and right click listeners.
17+
* Menu items accepts arbitrary content (such as checkboxes, or buttons)
18+
1619
## Online demo
1720

18-
[Online demo here](http://addonsv10.flowingcode.com/applayout)
21+
[Online demo here](http://addonsv14.flowingcode.com/applayout)
1922

2023
## Download release
2124

@@ -40,9 +43,9 @@ To see the demo, navigate to http://localhost:8080/
4043
- **Version 1.0.7** Added abstract RouterLayout and style mouse pointer as a hand.
4144
- **Version 1.0.8** Deprecate methods for removal in future releases.
4245

43-
## Roadmap
44-
45-
* Support for app-grid
46+
- **Version 2.1.0**
47+
The `MenuItem` class in package `com.flowingcode.addons.applayout.menu` was replaced by a `MenuItem` component (in package `com.flowingcode.addons.applayout`), which renders an item in the lateral menu, and `ToolbarIconButton`, which is a clickable icon (without label) suitable for use in the AppToolbar part. Some custom CSS selectors that depended on the internal menu item structure may need to be rewritten.
48+
Classes and methods deprecated in version 2.0 have been removed.
4649

4750
## Issue tracking
4851

@@ -77,26 +80,21 @@ Adding menu items with sub-menus & icons:
7780
```
7881
app.setMenuItems(new MenuItem("Say hello", "star", () -> showContent("Hello!")),
7982
new MenuItem("About", "cloud", () -> showContent("About")),
80-
new MenuItem("SubMenu", "build",
83+
new MenuItem("SubMenu").setIcon("build").add(
8184
new MenuItem("Hello Again", "inbox",()->showContent("Hello Again!")),
8285
new MenuItem("And Again",()->showContent("And Again!")),
83-
new MenuItem("SubMenu",
86+
new MenuItem("SubMenu").add(
8487
new MenuItem("Hello Again",()->showContent("Hello Again!")),
85-
new MenuItem("And Again",()->showContent("And Again!")))
86-
));
88+
new MenuItem("And Again",()->showContent("And Again!"))
89+
)
90+
)
91+
);
8792
```
8893
Toolbar icons:
8994
```
90-
app.setToolbarIconButtons(new MenuItem("Delete", "delete", ()->Notification.show("Delete action")),
91-
new MenuItem("Search", "search", ()->Notification.show("Search action")),
92-
new MenuItem("Close", "close", ()->Notification.show("Close action"))
93-
);
94-
```
95-
Using paper-cards:
96-
```
97-
H3 label = new H3();
98-
label.setSizeFull();
99-
label.setText(content);
100-
PaperCard pc = new PaperCard(label,new MenuItem("Delete", "delete", ()->Notification.show("Delete action from card")));
101-
pc.setWidth("100%");
102-
```
95+
app.setToolbarIconButtons(
96+
new ToolbarIconButton("Delete", "delete", ()->Notification.show("Delete action")),
97+
new ToolbarIconButton("Search", "search", ()->Notification.show("Search action")),
98+
new ToolbarIconButton("Close", "close", ()->Notification.show("Close action"))
99+
);
100+
```

0 commit comments

Comments
 (0)