Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/turekbot/tributefx
A @mention system for JavaFX; uses the lovely Tribute written in JavaScript.
https://github.com/turekbot/tributefx
hashtags javafx-library mentions tags tributejs
Last synced: about 1 month ago
JSON representation
A @mention system for JavaFX; uses the lovely Tribute written in JavaScript.
- Host: GitHub
- URL: https://github.com/turekbot/tributefx
- Owner: TurekBot
- License: other
- Created: 2018-01-28T23:06:37.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-08-27T20:59:48.000Z (over 5 years ago)
- Last Synced: 2024-10-13T18:41:17.017Z (2 months ago)
- Topics: hashtags, javafx-library, mentions, tags, tributejs
- Language: Java
- Size: 135 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
# TributeFX
A `@mention` engine for JavaFX.
#### Motivation
I looked high and low for a JavaFX `@mention` engine—no luck.
I welcome the day that there *is* one, but until
then, here's a wrapper for the JavaScript, Native `@mention` engine, [Tribute.js][Tribute].
## Getting Started
* Coming Soon: Maven Central
Or
* Clone the repo from here
* In the root of the project run `mvn clean install`
* Either:
* Add the resulting jar (according to your IDE's instructions) as a dependency
* Include TributeFX as a dependency in your maven project
```
tech.ugma.customcomponents.tributefx
TributeFX
0.3.0
```
### Demo
[![Hunger Games Demo]][Hunger Games Demo]
### Quickstart Example
To just _try it out_, make a WebView and do:
TributeFX.tributifyWebView(webView);
TributeFX.addMentionables(TributeFX.createSampleMentionableList(), webView.getEngine());
See the [DemoWithDefaults] for such a working example.
### Adding Mentionables
If you're keeping it simple, use, [`SimpleMentionable`]
ArrayList mentionables = new ArrayList<>();
mentionables.add(new SimpleMentionable("key", "value"));
mentionables.add(new SimpleMentionable("John Sample", "jjSwample22"));
TributeFX.addMentionables(webView, mentionables);
To pass in more attributes, like an email, see [`Mentionable`]'s Documentation.
### [Customization][get custom with it]
Once you've cut your teeth on the basics, you can whip out some JavaScript and [get custom with it]:
InputStream customConfig = DemoWithCustomConfig.class.getResourceAsStream("customTributeConfiguration.js");
TributeFX.tributifyWebView(webView, customConfig);
WebEngine webEngine = webView.getEngine();
ArrayList mentionables = TributeFX.createSampleMentionableList();
TributeFX.addMentionables(mentionables, webEngine);
See [DemoWithCustomConfig] to really get jiggy with it.
### Possible Use Cases
* Mentioning people
* Hashtags
* Category tags
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository]
## Authors
* **Zurb** - *JavaScript @mention Engine* - [Tribute]
* **Bradley Turek** - *Initial Wrapping of Tribute*
See also the list of [contributors] who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
[Tribute]: https://github.com/zurb/tribute
[Hunger Games Demo]: https://i.imgur.com/yLadZRo.gif
[DemoWithDefaults]: src/main/java/tech/ugma/customcomponents/tributefx/demo/DemoWithDefaults.java
[get custom with it]: https://github.com/zurb/tribute#a-collection "See Tribute's website for all the configuration options."
[DemoWithCustomConfig]: src/main/java/tech/ugma/customcomponents/tributefx/demo/DemoWithCustomConfig.java
[`Mentionable`]: src/main/java/tech/ugma/customcomponents/tributefx/Mentionable.java
[`SimpleMentionable`]: src/main/java/tech/ugma/customcomponents/tributefx/SimpleMentionable.java
[tags on this repository]: https://github.com/TurekBot/TributeFX/tags
[contributors]: https://github.com/TurekBot/TributeFX/contributors