https://github.com/try0/wicket-izitoast
Apache Wicket utilities for using iziToast. Display feedback message as toast.
https://github.com/try0/wicket-izitoast
feedback-message izitoast java toast web wicket
Last synced: 5 months ago
JSON representation
Apache Wicket utilities for using iziToast. Display feedback message as toast.
- Host: GitHub
- URL: https://github.com/try0/wicket-izitoast
- Owner: try0
- License: apache-2.0
- Created: 2019-04-09T11:03:17.000Z (about 7 years ago)
- Default Branch: wicket-10.x
- Last Pushed: 2024-07-18T15:20:23.000Z (almost 2 years ago)
- Last Synced: 2025-03-10T19:40:49.355Z (over 1 year ago)
- Topics: feedback-message, izitoast, java, toast, web, wicket
- Language: Java
- Homepage: https://try0.jp/app/wicket-izitoast-samples/
- Size: 288 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# wicket-iziToast
[Apache Wicket](https://wicket.apache.org/) utilities for using [iziToast](http://izitoast.marcelodolza.com/).
wicket-iziToast converts the feedback message to JavaScript to display the toast.
[](https://github.com/try0/wicket-iziToast/actions?query=workflow%3A%22Java+CI%22)
[](https://search.maven.org/search?q=g:%22jp.try0.wicket%22%20AND%20a:%22wicket-izitoast-core%22)
# Version
| Version | Wicket | iziToast |
| ---- | ---- | ---- |
| [3.0.0](https://search.maven.org/artifact/jp.try0.wicket/wicket-izitoast-core/3.0.0/jar) | 10.x | 1.4.0 |
| [2.1.0](https://search.maven.org/artifact/jp.try0.wicket/wicket-izitoast-core/2.1.0/jar) | 9.x | 1.4.0 |
| [1.1.0](https://search.maven.org/artifact/jp.try0.wicket/wicket-izitoast-core/1.1.0/jar) | 8.x | 1.4.0 |
# Demo
Deployed [wicket-izitoast-samples](https://try0.jp/app/wicket-izitoast-samples/) module.
# Usage
[Examples](https://github.com/try0/wicket-iziToast/wiki)
Add wicket-izitoast-core dependency.
Wicket 10.x
```xml
jp.try0.wicket
wicket-izitoast-core
3.0.0
```
Wicket 9.x
```xml
jp.try0.wicket
wicket-izitoast-core
2.1.0
```
Wicket 8.x
```xml
jp.try0.wicket
wicket-izitoast-core
1.1.0
```
### Initialize Settings
You can set default values, in the application initialize process(Application#init).
```java
IziToastSetting
.createInitializer(this)
.setAutoAppendBehavior(true)
.setGlobalOption(option) // default iziToast option. apply in client-side (execute iziToast.settings(option))
.setGlobalEachLevelOptions(perLevelOptions) // default option per levels. apply in server-side.
.setToastMessageCombiner(combiner) // combiner that combine same level feedback messages.
.initialize();
```
#### Properties
##### AutoAppendBehavior
if true add IziToastBehavior to page automatically.
##### GlobalOption
Default toast option. Execute iziToast.settings(option) on the client-side and apply the default option.
##### GlobalEachLevelOptions
Default toast option per levels.
```java
ToastOption defaultInfoOption = new ToastOption();
// TODO set option values
EachLevelToastOptions options = EachLevelToastOptions.builder()
.setInfoOption(defaultInfoOption)
.get();
// TODO setGlobalEachLevelOptions(options)
```
Option priority level
Default option per levels (GlobalEachLevelOptions) > Default option (GlobalOption)
##### ToastMessageCombiner
Combiner that combines messages for each toast level.
```java
ToastMessageCombiner combiner = new ToastMessageCombiner();
combiner.setPrefix("・");
// TODO setToastMessageCombiner(combiner)
```
If execute this Java code.
```java
error("message1");
error("message2");
```
Messages are combined and displayed in one toast.
### Display toast
add IziToastBehavior to page.
(If you set setAutoAppendBehavior to true when initializing settings, no need this code.)
```java
add(new IziToastBehavior());
```
IziToastBehavior converts feedback messages to JavaScript for displaying toast.
Success toast
* org.apache.wicket.Component#success(Serializable)
* org.apache.wicket.Session#success(Serializable)
Information toast
* org.apache.wicket.Component#info(Serializable)
* org.apache.wicket.Session#info(Serializable)
Warning toast
* org.apache.wicket.Component#warn(Serializable)
* org.apache.wicket.Session#warn(Serializable)
Error toast
* org.apache.wicket.Component#error(Serializable)
* org.apache.wicket.Session#error(Serializable)
* org.apache.wicket.Component#fatal(Serializable)
* org.apache.wicket.Session#fatal(Serializable)
### Display toast manually
In this case, need instance of class that implemented IHeaderResponse or AjaxRequestTarget.
```java
Toast.create(toastLevel, message)
.show(target);
```