From bfd5aa358e141d6c86d476d8bb66b104a80a3b96 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Thu, 21 May 2020 00:13:50 +0200 Subject: API documentation for KVision 3.10.0 --- .../-widget/after-destroy-hook.html | 1 + .../-widget/after-dispose-hook.html | 15 +++ .../-widget/after-insert-hook.html | 1 + api/pl.treksoft.kvision.core/-widget/animate.html | 24 ++++ api/pl.treksoft.kvision.core/-widget/fade-in.html | 24 ++++ api/pl.treksoft.kvision.core/-widget/fade-out.html | 24 ++++ .../-widget/hide-anim.html | 24 ++++ api/pl.treksoft.kvision.core/-widget/index.html | 136 ++++++++++++++++++--- .../-widget/show-anim.html | 24 ++++ .../-widget/slide-down.html | 24 ++++ api/pl.treksoft.kvision.core/-widget/slide-up.html | 24 ++++ 11 files changed, 306 insertions(+), 15 deletions(-) create mode 100644 api/pl.treksoft.kvision.core/-widget/after-dispose-hook.html create mode 100644 api/pl.treksoft.kvision.core/-widget/animate.html create mode 100644 api/pl.treksoft.kvision.core/-widget/fade-in.html create mode 100644 api/pl.treksoft.kvision.core/-widget/fade-out.html create mode 100644 api/pl.treksoft.kvision.core/-widget/hide-anim.html create mode 100644 api/pl.treksoft.kvision.core/-widget/show-anim.html create mode 100644 api/pl.treksoft.kvision.core/-widget/slide-down.html create mode 100644 api/pl.treksoft.kvision.core/-widget/slide-up.html (limited to 'api/pl.treksoft.kvision.core/-widget') diff --git a/api/pl.treksoft.kvision.core/-widget/after-destroy-hook.html b/api/pl.treksoft.kvision.core/-widget/after-destroy-hook.html index e489023d..b45493ee 100644 --- a/api/pl.treksoft.kvision.core/-widget/after-destroy-hook.html +++ b/api/pl.treksoft.kvision.core/-widget/after-destroy-hook.html @@ -10,5 +10,6 @@

afterDestroyHook

(js) var afterDestroyHook: (() -> Unit)? +

A function called after the widget is removed from the DOM.

diff --git a/api/pl.treksoft.kvision.core/-widget/after-dispose-hook.html b/api/pl.treksoft.kvision.core/-widget/after-dispose-hook.html new file mode 100644 index 00000000..82d0c8f5 --- /dev/null +++ b/api/pl.treksoft.kvision.core/-widget/after-dispose-hook.html @@ -0,0 +1,15 @@ + + + +Widget.afterDisposeHook - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / afterDisposeHook
+
+

afterDisposeHook

+(js) +var afterDisposeHook: (() -> Unit)? +

A function called after the widget is disposed.

+ + diff --git a/api/pl.treksoft.kvision.core/-widget/after-insert-hook.html b/api/pl.treksoft.kvision.core/-widget/after-insert-hook.html index a5530545..9a7dbfad 100644 --- a/api/pl.treksoft.kvision.core/-widget/after-insert-hook.html +++ b/api/pl.treksoft.kvision.core/-widget/after-insert-hook.html @@ -10,5 +10,6 @@

afterInsertHook

(js) var afterInsertHook: ((VNode) -> Unit)? +

A function called after the widget is inserted to the DOM.

diff --git a/api/pl.treksoft.kvision.core/-widget/animate.html b/api/pl.treksoft.kvision.core/-widget/animate.html new file mode 100644 index 00000000..ab776d39 --- /dev/null +++ b/api/pl.treksoft.kvision.core/-widget/animate.html @@ -0,0 +1,24 @@ + + + +Widget.animate - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / animate
+
+

animate

+(js) +

open fun animate(duration: Int = 400, easing: Easing = Easing.SWING, complete: (() -> Unit)? = null, styles: StyledComponent.() -> Unit): Unit

Animate the widget changing CSS properties.

Parameters

+duration - a duration of the animation

+easing - an easing function to use

+complete - a callback function called after the animation completes

+styles - changing properties values

+ + diff --git a/api/pl.treksoft.kvision.core/-widget/fade-in.html b/api/pl.treksoft.kvision.core/-widget/fade-in.html new file mode 100644 index 00000000..a00063c4 --- /dev/null +++ b/api/pl.treksoft.kvision.core/-widget/fade-in.html @@ -0,0 +1,24 @@ + + + +Widget.fadeIn - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / fadeIn
+
+

fadeIn

+(js) +open fun fadeIn(duration: Int = 400, easing: Easing = Easing.SWING, complete: (() -> Unit)? = null): Widget +

Shows current widget with fade in effect.

Parameters

+duration - a duration of the animation

+easing - an easing function to use

+complete - a callback function called after the animation completes

Return
+current widget

+ + diff --git a/api/pl.treksoft.kvision.core/-widget/fade-out.html b/api/pl.treksoft.kvision.core/-widget/fade-out.html new file mode 100644 index 00000000..d138ca03 --- /dev/null +++ b/api/pl.treksoft.kvision.core/-widget/fade-out.html @@ -0,0 +1,24 @@ + + + +Widget.fadeOut - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / fadeOut
+
+

fadeOut

+(js) +open fun fadeOut(duration: Int = 400, easing: Easing = Easing.SWING, complete: (() -> Unit)? = null): Widget +

Hides current widget with fade out effect.

Parameters

+duration - a duration of the animation

+easing - an easing function to use

+complete - a callback function called after the animation completes

Return
+current widget

+ + diff --git a/api/pl.treksoft.kvision.core/-widget/hide-anim.html b/api/pl.treksoft.kvision.core/-widget/hide-anim.html new file mode 100644 index 00000000..bb1cfae2 --- /dev/null +++ b/api/pl.treksoft.kvision.core/-widget/hide-anim.html @@ -0,0 +1,24 @@ + + + +Widget.hideAnim - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / hideAnim
+
+

hideAnim

+(js) +open fun hideAnim(duration: Int = 400, easing: Easing = Easing.SWING, complete: (() -> Unit)? = null): Widget +

Hides current widget with animation effect.

Parameters

+duration - a duration of the animation

+easing - an easing function to use

+complete - a callback function called after the animation completes

Return
+current widget

+ + diff --git a/api/pl.treksoft.kvision.core/-widget/index.html b/api/pl.treksoft.kvision.core/-widget/index.html index 5451601e..b8a1b260 100644 --- a/api/pl.treksoft.kvision.core/-widget/index.html +++ b/api/pl.treksoft.kvision.core/-widget/index.html @@ -55,14 +55,25 @@

afterDestroyHook

A function called after the widget is removed from the DOM.

var afterDestroyHook: (() -> Unit)? (js) +

afterDisposeHook

+ + +

A function called after the widget is disposed.

+var afterDisposeHook: (() -> Unit)? + + + +(js)

afterInsertHook

A function called after the widget is inserted to the DOM.

var afterInsertHook: ((VNode) -> Unit)? @@ -247,6 +258,15 @@ (js) +

animate

+ + +

Animate the widget changing CSS properties.

open fun animate(duration: Int = 400, easing: Easing = Easing.SWING, complete: (() -> Unit)? = null, styles: StyledComponent.() -> Unit): Unit

+ + + +(js)

clearDragDropData

@@ -300,6 +320,24 @@ (js) +

fadeIn

+ + +

Shows current widget with fade in effect.

+open fun fadeIn(duration: Int = 400, easing: Easing = Easing.SWING, complete: (() -> Unit)? = null): Widget + + + +(js) +

fadeOut

+ + +

Hides current widget with fade out effect.

+open fun fadeOut(duration: Int = 400, easing: Easing = Easing.SWING, complete: (() -> Unit)? = null): Widget + + + +(js)

getAttribute

@@ -381,6 +419,15 @@ (js) +

hideAnim

+ + +

Hides current widget with animation effect.

+open fun hideAnim(duration: Int = 400, easing: Easing = Easing.SWING, complete: (() -> Unit)? = null): Widget + + + +(js)

hidePopover

@@ -537,6 +584,15 @@ (js) +

showAnim

+ + +

Shows current widget with animation effect.

+open fun showAnim(duration: Int = 400, easing: Easing = Easing.SWING, complete: (() -> Unit)? = null): Widget + + + +(js)

showPopover

@@ -563,6 +619,24 @@ (js) +

slideDown

+ + +

Shows current widget with slide down effect.

open fun slideDown(duration: Int = 400, easing: Easing = Easing.SWING, complete: (() -> Unit)? = null): Widget

+ + + +(js) +

slideUp

+ + +

Hides current widget with slide up effect.

+open fun slideUp(duration: Int = 400, easing: Easing = Easing.SWING, complete: (() -> Unit)? = null): Widget + + + +(js)

toggleVisible

@@ -589,6 +663,7 @@

changeFlow

Extension property returning Flow for a change event.

val <T : Widget> T.changeFlow: Flow<T> @@ -597,6 +672,7 @@

clickFlow

Extension property returning Flow for a click event.

val <T : Widget> T.clickFlow: Flow<T> @@ -605,6 +681,7 @@

inputFlow

Extension property returning Flow for an input event.

val <T : Widget> T.inputFlow: Flow<T> @@ -655,11 +732,20 @@ (js) +

bind

+ + +

An extension function which binds the widget to the observable state.

+fun <S, W : Widget> W.bind(observableState: ObservableState<S>, factory: W.(S) -> Unit): W + + + +(js)

contextMenu

DSL builder extension function.

fun Widget.contextMenu(fixedPosition: Boolean = false, classes: Set<String> = setOf(), init: (ContextMenu.() -> Unit)? = null): ContextMenu

fun Widget.contextMenu(fixedPosition: Boolean = false, classes: Set<String>? = null, className: String? = null, init: (ContextMenu.() -> Unit)? = null): ContextMenu

@@ -667,14 +753,25 @@

eventFlow

Extension property returning Flow<Pair<Widget, Event>> for a given event

fun <T : Widget> T.eventFlow(event: String): Flow<Pair<T, Event>> (js) +

onClick

+ + +

An extension function for defining on click event handlers.

+fun <T : Widget> T.onClick(handler: T.(MouseEvent) -> Unit): Int + + + +(js)

onEvent

An extension function for defining event handlers.

fun <T : Widget> T.onEvent(block: SnOn<T>.() -> Unit): Int @@ -747,16 +844,7 @@

Base class for basic text components.

-abstract class AbstractTextInput : Widget, FormInput - - - -(js) -

Button

- - -

Button component.

-open class Button : Widget +abstract class AbstractTextInput : Widget, FormInput, ObservableState<String?> @@ -783,7 +871,7 @@

The basic input component rendered as HTML input type="checkbox" or input type="radio".

-abstract class CheckInput : Widget, FormInput +abstract class CheckInput : Widget, FormInput, ObservableState<Boolean> @@ -855,7 +943,16 @@

Range input component.

-open class RangeInput : Widget, FormInput +open class RangeInput : Widget, FormInput, ObservableState<Number?> + + + +(js) +

React

+ + +

React component for KVision with support for state holder.

+class React<S> : Widget, ObservableState<S> @@ -882,7 +979,7 @@

The basic component for spinner control.

-open class SpinnerInput : Widget, FormInput +open class SpinnerInput : Widget, FormInput, ObservableState<Number?> @@ -891,7 +988,7 @@

A class which binds the given container to the observable state.

-class StateBinding<S : Any, CONT : Container, CONTENT> : Widget +class StateBinding<S : Any, CONT : Container, CONTENT> : Widget @@ -905,6 +1002,15 @@ (js) +

TextNode

+ + +

Simple component for rendering text DOM node.

+open class TextNode : Widget + + + +(js)

UploadInput

diff --git a/api/pl.treksoft.kvision.core/-widget/show-anim.html b/api/pl.treksoft.kvision.core/-widget/show-anim.html new file mode 100644 index 00000000..4f8d0231 --- /dev/null +++ b/api/pl.treksoft.kvision.core/-widget/show-anim.html @@ -0,0 +1,24 @@ + + + +Widget.showAnim - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / showAnim
+
+

showAnim

+(js) +open fun showAnim(duration: Int = 400, easing: Easing = Easing.SWING, complete: (() -> Unit)? = null): Widget +

Shows current widget with animation effect.

Parameters

+duration - a duration of the animation

+easing - an easing function to use

+complete - a callback function called after the animation completes

Return
+current widget

+ + diff --git a/api/pl.treksoft.kvision.core/-widget/slide-down.html b/api/pl.treksoft.kvision.core/-widget/slide-down.html new file mode 100644 index 00000000..3cf703bc --- /dev/null +++ b/api/pl.treksoft.kvision.core/-widget/slide-down.html @@ -0,0 +1,24 @@ + + + +Widget.slideDown - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / slideDown
+
+

slideDown

+(js) +

open fun slideDown(duration: Int = 400, easing: Easing = Easing.SWING, complete: (() -> Unit)? = null): Widget

Shows current widget with slide down effect.

Parameters

+duration - a duration of the animation

+easing - an easing function to use

+complete - a callback function called after the animation completes

Return
+current widget

+ + diff --git a/api/pl.treksoft.kvision.core/-widget/slide-up.html b/api/pl.treksoft.kvision.core/-widget/slide-up.html new file mode 100644 index 00000000..298fac17 --- /dev/null +++ b/api/pl.treksoft.kvision.core/-widget/slide-up.html @@ -0,0 +1,24 @@ + + + +Widget.slideUp - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / slideUp
+
+

slideUp

+(js) +open fun slideUp(duration: Int = 400, easing: Easing = Easing.SWING, complete: (() -> Unit)? = null): Widget +

Hides current widget with slide up effect.

Parameters

+duration - a duration of the animation

+easing - an easing function to use

+complete - a callback function called after the animation completes

Return
+current widget

+ + -- cgit