1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
/*
* Copyright (c) 2017-present Robert Jaros
*
* 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.
*/
package pl.treksoft.kvision.html
import com.github.snabbdom.VNode
import pl.treksoft.kvision.core.Container
import pl.treksoft.kvision.core.ResString
import pl.treksoft.kvision.core.StringBoolPair
import pl.treksoft.kvision.core.StringPair
import pl.treksoft.kvision.core.Widget
import pl.treksoft.kvision.utils.set
/**
* Image shapes.
*/
enum class ImageShape(internal val className: String) {
ROUNDED("rounded"),
CIRCLE("rounded-circle"),
THUMBNAIL("img-thumbnail")
}
/**
* Image component.
*
* @constructor
* @param src image URL
* @param alt alternative text
* @param responsive determines if the image is rendered as responsive
* @param shape image shape
* @param centered determines if the image is rendered centered
* @param classes a set of CSS class names
*/
open class Image(
src: ResString?, alt: String? = null, responsive: Boolean = false, shape: ImageShape? = null,
centered: Boolean = false, classes: Set<String> = setOf()
) : Widget(classes) {
/**
* URL of the image.
*/
var src by refreshOnUpdate(src)
/**
* The alternative text of the image.
*/
var alt by refreshOnUpdate(alt)
/**
* Determines if the image is rendered as responsive.
*/
var responsive by refreshOnUpdate(responsive)
/**
* The shape of the image.
*/
var shape by refreshOnUpdate(shape)
/**
* Determines if the image is rendered as centered.
*/
var centered by refreshOnUpdate(centered)
override fun render(): VNode {
return render("img")
}
override fun getSnAttrs(): List<StringPair> {
val pr = super.getSnAttrs().toMutableList()
src?.let {
pr.add("src" to it)
}
alt?.let {
pr.add("alt" to translate(it))
}
return pr
}
override fun getSnClass(): List<StringBoolPair> {
val cl = super.getSnClass().toMutableList()
if (responsive) {
cl.add("img-fluid" to true)
}
if (centered) {
cl.add("center-block" to true)
}
shape?.let {
cl.add(it.className to true)
}
return cl
}
}
/**
* DSL builder extension function.
*
* It takes the same parameters as the constructor of the built component.
*/
fun Container.image(
src: ResString?, alt: String? = null, responsive: Boolean = false, shape: ImageShape? = null,
centered: Boolean = false,
classes: Set<String>? = null,
className: String? = null,
init: (Image.() -> Unit)? = null
): Image {
val image = Image(src, alt, responsive, shape, centered, classes ?: className.set).apply { init?.invoke(this) }
this.add(image)
return image
}
|
