Skip to content

Commit 9467a78

Browse files
authored
Update README.md
1 parent ed088b8 commit 9467a78

File tree

1 file changed

+23
-34
lines changed

1 file changed

+23
-34
lines changed

README.md

Lines changed: 23 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,14 @@ This addon is particularly useful if you want to create a new application with s
99

1010
## Features
1111

12-
* Left side menu with hamburguer button
13-
* Hierarchical menus with icons
12+
* Left side menu with hamburguer button and avatar image.
13+
* Header with toolbar icons.
14+
* Hierarchical menus with icons (infinite level of submenus).
1415
* Application header with logo, title and toolbar icons.
15-
* Menu separator
16+
* Menu separator.
1617
* Support for left, middle and right click listeners.
1718
* Menu items accepts arbitrary content (such as checkboxes, or buttons)
18-
19+
1920
## Online demo
2021

2122
[Online demo here](http://addonsv14.flowingcode.com/applayout)
@@ -33,19 +34,7 @@ To see the demo, navigate to http://localhost:8080/
3334

3435
## Release notes
3536

36-
- **Version 1.0.0** Initial Version
37-
- **Version 1.0.1** Fixed recursion problem
38-
- **Version 1.0.2** Added support for sub-menus and icons in the menus
39-
- **Version 1.0.3** Added support for changing the label and icon of a MenuItem dinamically.
40-
- **Version 1.0.4** Added support for: placing a logo in the application header, changing icons in the toolbar, setting a custom component to the menu header (such as logged-in user account details), setting visibility of side menu and button and dynamically clearing menu items.
41-
- **Version 1.0.5** Added support for: setting the header title and height, and configuring the header behavior on scroll, the drawer swipe-open behavior, and disabling menu items.
42-
- **Version 1.0.6** Added support for: making the menu list scrollable and support for image-based icons. API enhancements and fixes.
43-
- **Version 1.0.7** Added abstract RouterLayout and style mouse pointer as a hand.
44-
- **Version 1.0.8** Deprecate methods for removal in future releases.
45-
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.
37+
See [here](https://github.com/FlowingCode/AppLayoutAddon/releases)
4938

5039
## Issue tracking
5140

@@ -78,23 +67,23 @@ AppLayout app =new AppLayout("AppLayout Addon for Vaadin 10 Demo");
7867
```
7968
Adding menu items with sub-menus & icons:
8069
```
81-
app.setMenuItems(new MenuItem("Say hello", "star", () -> showContent("Hello!")),
82-
new MenuItem("About", "cloud", () -> showContent("About")),
83-
new MenuItem("SubMenu").setIcon("build").add(
84-
new MenuItem("Hello Again", "inbox",()->showContent("Hello Again!")),
85-
new MenuItem("And Again",()->showContent("And Again!")),
86-
new MenuItem("SubMenu").add(
87-
new MenuItem("Hello Again",()->showContent("Hello Again!")),
88-
new MenuItem("And Again",()->showContent("And Again!"))
89-
)
90-
)
91-
);
70+
app.setMenuItems(new MenuItem("Say hello", "star", () -> showContent("Hello!")),
71+
new MenuItem("About", "cloud", () -> showContent("About")),
72+
new MenuItem("SubMenu").setIcon("build").add(
73+
new MenuItem("Hello Again", "inbox",()->showContent("Hello Again!")),
74+
new MenuItem("And Again",()->showContent("And Again!")),
75+
new MenuItem("SubMenu").add(
76+
new MenuItem("Hello Again",()->showContent("Hello Again!")),
77+
new MenuItem("And Again",()->showContent("And Again!"))
78+
)
79+
)
80+
);
9281
```
9382
Toolbar icons:
9483
```
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-
```
84+
app.setToolbarIconButtons(
85+
new ToolbarIconButton("Delete", "delete", ()->Notification.show("Delete action")),
86+
new ToolbarIconButton("Search", "search", ()->Notification.show("Search action")),
87+
new ToolbarIconButton("Close", "close", ()->Notification.show("Close action"))
88+
);
89+
```

0 commit comments

Comments
 (0)