aboutsummaryrefslogtreecommitdiff
path: root/src/main/kotlin/pl/treksoft/kvision/html/Button.kt
blob: 99f4ca1367b3321aa0b287e3bafadd1f1e06430f (plain)
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
/*
 * 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 org.w3c.dom.events.MouseEvent
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

/**
 * Button styles.
 */
enum class ButtonStyle(internal val className: String) {
    DEFAULT("btn-default"),
    PRIMARY("btn-primary"),
    SUCCESS("btn-success"),
    INFO("btn-info"),
    WARNING("btn-warning"),
    DANGER("btn-danger"),
    LINK("btn-link")
}

/**
 * Button sizes.
 */
enum class ButtonSize(internal val className: String) {
    LARGE("btn-lg"),
    SMALL("btn-sm"),
    XSMALL("btn-xs")
}

/**
 * Button types.
 */
enum class ButtonType(internal val buttonType: String) {
    BUTTON("button"),
    SUBMIT("submit"),
    RESET("reset")
}

/**
 * Button component.
 *
 * @constructor
 * @param text button label
 * @param icon button icon
 * @param style button style
 * @param disabled button state
 * @param classes a set of CSS class names
 */
open class Button(
    text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, type: ButtonType = ButtonType.BUTTON,
    disabled: Boolean = false, classes: Set<String> = setOf()
) : Widget(classes) {

    /**
     * Button label.
     */
    var text by refreshOnUpdate(text)
    /**
     * Button icon.
     */
    var icon by refreshOnUpdate(icon)
    /**
     * Button style.
     */
    var style by refreshOnUpdate(style)
    /**
     * Button types.
     */
    var type by refreshOnUpdate(type)
    /**
     * Determines if button is disabled.
     */
    var disabled by refreshOnUpdate(disabled)
    /**
     * Button image.
     */
    var image: ResString? by refreshOnUpdate()
    /**
     * Button size.
     */
    var size: ButtonSize? by refreshOnUpdate()
    /**
     * Determines if the button takes all the space horizontally.
     */
    var block by refreshOnUpdate(false)

    override fun render(): VNode {
        val t = createLabelWithIcon(text, icon, image)
        return render("button", t)
    }

    override fun getSnClass(): List<StringBoolPair> {
        val cl = super.getSnClass().toMutableList()
        cl.add("btn" to true)
        cl.add(style.className to true)
        size?.let {
            cl.add(it.className to true)
        }
        if (block) {
            cl.add("btn-block" to true)
        }
        if (disabled) {
            cl.add("disabled" to true)
        }
        return cl
    }

    override fun getSnAttrs(): List<StringPair> {
        return super.getSnAttrs() + ("type" to type.buttonType)
    }

    /**
     * A convenient helper for easy setting onClick event handler.
     */
    open fun onClick(handler: Button.(MouseEvent) -> Unit): Button {
        this.setEventListener<Button> {
            click = { e ->
                self.handler(e)
            }
        }
        return this
    }

    companion object {
        /**
         * DSL builder extension function.
         *
         * It takes the same parameters as the constructor of the built component.
         */
        fun Container.button(
            text: String,
            icon: String? = null,
            style: ButtonStyle = ButtonStyle.DEFAULT,
            type: ButtonType = ButtonType.BUTTON,
            disabled: Boolean = false,
            classes: Set<String> = setOf(),
            init: (Button.() -> Unit)? = null
        ): Button {
            val button = Button(text, icon, style, type, disabled, classes).apply { init?.invoke(this) }
            this.add(button)
            return button
        }
    }
}