Package-level declarations
Types
Occurs when Lens points to non-existing element.
Occurs when Lens tries to update a non-existing element.
Defines type for a handler for lifecycle-events
This adapter class just lifts the DOM API NodeList type into Kotlin's collection API.
An EmittingHandler is a special Handler that constitutes a new Flow by itself. You can emit values to this Flow from your code and connect it to other Handlers on this or on other Stores. This way inter-store-communication is done in fritz2.
A marker to separate the layers of calls in the type-safe-builder pattern.
function to derive a valid id for a given instance that does not change over time.
This object offers expressive access to predefined Shortcuts and ModifierShortcuts taken from the specification extended with Space as symbol for simple space.
Used by the fritz2 gradle-plugin to identify data classes it should generate Lenses for.
This interface models the modifier shortcuts, that enable combination of shortcuts like "STRG + F" or alike.
External interface to access the MountPoint where the lifecycle of Tags and subtrees is handled.
Occurs when the targeted html element is not present in document.
Used by the fritz2 gradle-plugin to identify properties in sealed classes or interfaces, that should get ignored by the lens generation.
This Flow implementation represents a flow that emits exactly one value during its lifetime.
Context for rendering static and dynamical content
RootInspector is the starting point for getting your data and corresponding paths from your deep nested model structure. Get this by calling the factory method inspectorOf.
Context for setting new entries to a Scope object.
Shortcut represents a grouping type upon the "key" and the modifier key properties of a KeyboardEvent. More info here
Implementation of HtmlTag to represent the JavaScript SVGElement to Kotlin
Represents a tag. Sorry for the name, but we needed to delimit it from the Element it is wrapping.
Definition of a css-transition (enter and/or leave) to be executed when a Tag is mounted to or removed from the DOM.
Base-interface for everything that represents a node in the DOM.
Contains all javascript event types. Take a look here.
Properties
Functions
Adds global css-rules to a fritz2-specific stylesheet added to the document when first called
Adds global css-rules to a fritz2-specific stylesheet added to the document when first called
Convenience method to register lifecycle handler for after a Tag is mounted
Creates a DomNodeList containing all HTMLElements from the DOM API based NodeList.
Convenience method to register lifecycle handler for before a Tag is unmounted
Extracts a FileList from the Event.target.
This factory function creates an OnlyOnceFlow.
on a Store of nullable data this creates a Store with a nullable parent and non-nullable value. It can be called using a Lens on a non-nullable parent (that can be created by using the @Lenses-annotation), but you have to ensure, that the resulting Store is never used, when it's parent's value is null. Otherwise, a NullPointerException is thrown.
Creates a new Inspector containing the element for the given element and idProvider from the original Inspector's List.
Allows to access the nearest MountPoint from any WithScope
collects the values of a given Flow one by one. Use this for data-types that represent a single (simple or complex) value.
Enables combination of ModifierShortcuts like "STRG + ALT + F":
Creates a RenderContext for Tags and mounts it to a constant element in the static html file which id matches the selector.
Creates a RenderContext for Tags and mounts it to a targetElement.
Extracts the HTMLSelectElement.selectedIndex from the Event.target.
Extracts the HTMLOptionElement.text from the selected HTMLOptionElement.
Extracts the HTMLOptionElement.value from the selected HTMLOptionElement.
The function generates a Shortcut object out of a KeyboardEvent.
Extracts the HTMLInputElement.checked state from the Event.target.
Applies a transition (enter and/or leave) to a Tag. The enter-transition will be executed right after the Tag is mounted to the DOM. The leave-transition will be executed right before the Tag is removed from the DOM. Further operation of the MountPoint rendering the Tag is suspended until the leave-animation is done.
Applies a transition (enter and/or leave) to a Tag whenever a new value appears on a Flow.
Extracts the HTMLInputElement.value from the Event.target.
Extracts the HTMLSelectElement.value from the Event.target.
Extracts the HTMLTextAreaElement.value from the Event.target.
wait for a running animation on the DOM-Node to finish.
This extension method takes a boolean Flow that controls the forwarding of the initial value: If it is true the value will be passed further on the result flow, if it is false a null will appear instead.
This extension method takes a boolean Flow that controls the forwarding of an initial flow: If it is true the current value will be passed further on the result flow, if it is false a null will appear instead.