Karibu-DSL (Vaadin Kotlin Extensions)

This is a Kotlin extensions and DSL library for the Vaadin framework. Please visit Vaadin-on-Kotlin pages for the Getting Started guide.

This library:

• Allows you to create Vaadin UI designs in the structured code way; the idea behind the library is explained in the DSLs: Explained for Vaadin article (or for older Vaadin 8: DSLs: Explained for Vaadin 8). The general DSL idea is explained in Kotlin Type-Safe Builders.
• (Vaadin 8 only): Auto-discovery and auto-mapping of Views via a custom Navigator
• Additional useful methods which Vaadin lacks

The documentation differs for Vaadin 14 and for older Vaadin 8:

• Karibu-DSL Vaadin 13, 14, 15+ tutorial
• Karibu-DSL Vaadin 8 tutorial

The origins of the word Karibu: it's a term for North American subspecies of the reindeer; that connects to Vaadin (which is a Finnish word for a female reindeer). A nice connotation comes from Swahili where Karibu means welcome.

Note: For Groovy Vaadin DSL please see the Vaadin Groovy Builder library.

Why DSL?

Just compare the Kotlin-based CommonElementsView with the original Java CommonParts. Both render the Common UI Elements page, yet with Kotlin DSL:

• The UI structure is immediately visible
• The code is more readable and much shorter and concise
• You can more easily copy parts of the UI and paste it into your project

Supports:

• Vaadin 13/14/15+
• Older Vaadin 8 (including support for v7 compatibility package)

Example Projects

Vaadin 14:

• Simple one-page-one-button example app: karibu10-helloworld-application
• A simple database-backed one-page task list app: vaadin-kotlin-pwa
• Two-page app demoing grids and database: Beverage Buddy VoK

Vaadin 8:

• Simple one-page-one-button example app: karibu-helloworld-application
• Component palette: demoes all components and their usage: Component Palette

Upgrading

To upgrade to 1.0.0 from 0.x.y:

• Change the karibu-dsl-v10 dependency to just karibu-dsl.

License

Licensed under the MIT License.

Copyright (c) 2017-2020 Martin Vysny

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.