https://github.com/edvin/tornadofx-kitchensink
TornadoFX Kitchensink Samples
https://github.com/edvin/tornadofx-kitchensink
Last synced: over 1 year ago
JSON representation
TornadoFX Kitchensink Samples
- Host: GitHub
- URL: https://github.com/edvin/tornadofx-kitchensink
- Owner: edvin
- Created: 2016-11-01T19:51:29.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2018-03-01T13:21:14.000Z (over 8 years ago)
- Last Synced: 2025-04-04T22:43:40.622Z (over 1 year ago)
- Language: Kotlin
- Size: 135 KB
- Stars: 8
- Watchers: 5
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TornadoFX Kitchen Sink Samples
This project contains samples and best practices for the TornadoFX project. Each sample is
self contained in it's own package structure to make it easy to extract a sample for use in your own project.
Every sample comes with a description to help you understand what's going on and will highlight relevant parts of the code you might want to direct special attention towards.
A [runnable jar](http://tornadofx.tornado.no/kitchensink/fxlauncher.jar) is available that will launcher the kitchen sink automatically.
We also have a native installer for [Windows](http://tornadofx.tornado.no/kitchensink/tornadofx-kitchensink-1.0.exe) and [Mac](http://tornadofx.tornado.no/kitchensink/tornadofx-kitchensink-1.0.dmg).
## Contributing samples
- Clone the project (git clone https://github.com/edvin/tornadofx-kitchensink)
- Add a package inside `tornadofx.kitchensink.samples` for your sample
- Depending on your sample, add the relevant packages and files inside your sample package:
- `controller` - For controllers
- `view` - For views, fragments and other UI components
- `model` - For model objects and view models
- `README.md`- Description and helpful information about the sample
- Describe your sample in the [samples.json](tree/master/src/main/resources/samples.json) descriptor
- Either pick an existing category or create a new under the `samples` node. Describe your sample like this:
```json
{
"name": "Person Editor",
"entrypoint": "tornadofx.kitchensink.samples.masterdetail.simple"
}
```
The `entrypoint` should point to the sample package. This is the package where you'll add the `README.md` along with the other sub packages described above.
### Minimal requirement for new samples
You must include a `view/MainView.kt` with a `MainView` class. This class must extend `View` or `Fragment`.
Finally, create a PR and we'll be happy to add your sample!