kreuzberg
API
Generated with
kreuzberg/kreuzberg

kreuzberg

package kreuzberg

Members list

Type members

Classlikes

trait AssemblerContext extends ModelValueProvider, ServiceRepository

Provided context for assembling operations.

Provided context for assembling operations.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Empty
object AssemblerContext

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
case class Assembly(html: Html, handlers: Vector[EventBinding[_]], subscriptions: Vector[Subscribeable[_]], headless: Vector[HeadlessComponent])

Return result of an Component.assemble operation, will be built into the Tree

Return result of an Component.assemble operation, will be built into the Tree

Value parameters

handlers

Event Handlers

headless

Headless children

html

HTML Code with embedded Components

subscriptions

Component Subscriptions

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final class Channel[T]

A Channel is something where you can send data to and can subscribe in event bindings. They are allowed to be singletons. They are identified using their ID. There is only one channel of the same id allowed within an Engine.

A Channel is something where you can send data to and can subscribe in event bindings. They are allowed to be singletons. They are identified using their ID. There is only one channel of the same id allowed within an Engine.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object Channel

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
Channel.type
trait Component extends Identified

The base for all UI components.

The base for all UI components.

In practice you should use ComponentBase or SimpleComponentBase

Attributes

Supertypes
trait Identified
class Object
trait Matchable
class Any
Known subtypes
trait ComponentBase extends ComponentDsl, Component

Simple base trait for Components.

Simple base trait for Components.

Attributes

Supertypes
trait Component
trait Identified
trait ComponentDsl
trait ContextDsl
class Object
trait Matchable
class Any
Show all
trait ComponentDsl extends ContextDsl

Attributes

Supertypes
trait ContextDsl
class Object
trait Matchable
class Any
Known subtypes
Self type
trait ContextDsl

Common Methods for building Component-Implementations

Common Methods for building Component-Implementations

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait ComponentDsl
case class Effect[T](fn: ExecutionContext => Future[T])

Wraps an Effect so that it is lazy

Wraps an Effect so that it is lazy

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Effect

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Effect.type
case class EventBinding[E](source: EventSource[E], sink: EventSink[E])

An event binding.

An event binding.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class EventSink[E](f: (HandlerContext, E) => Unit)

A Sink of events

A Sink of events

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object EventSink

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
EventSink.type
sealed trait EventSource[+E]

A Source of an EventBinding.

A Source of an EventBinding.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Assembled
class ChannelSource[E]
class Js[E]
class OrSource[E]
class Timer
class Transformer[E, F]
Show all
object EventSource

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ExtensibleServiceRepository(instances: Map[String, Any]) extends ServiceRepository

Service Repository where it's possible to add services.

Service Repository where it's possible to add services.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
class FlatHtml(parts: Array[FlatHtmlElement])

Flattened HTML generated from a component for faster rerendering.

Flattened HTML generated from a component for faster rerendering.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object FlatHtml

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
FlatHtml.type
class FlatHtmlBuilder

Helper for Building FlatHtml instances

Helper for Building FlatHtml instances

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object FlatHtmlBuilder

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait FlatHtmlElement

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Part
class PlaceHolder
object FlatHtmlElement

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
trait HandlerContext extends ModelValueProvider, ServiceRepository, ExecutionContext

Context for imperative Event Handlers

Context for imperative Event Handlers

Attributes

Supertypes
trait ExecutionContext
class Object
trait Matchable
class Any
Show all
case class HeadlessAssembly(handlers: Vector[EventBinding[_]], subscriptions: Vector[Subscribeable[_]], children: Vector[HeadlessComponent])

Assembled service.

Assembled service.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
trait HeadlessComponent extends Identified

A Headless is like a component, but without an HTML-Representation. However it can define EventHandlers and Subscriptions.

A Headless is like a component, but without an HTML-Representation. However it can define EventHandlers and Subscriptions.

Attributes

Supertypes
trait Identified
class Object
trait Matchable
class Any
Known subtypes
trait HeadlessComponentBase extends HeadlessComponent, ContextDsl

Base trait for services.

Base trait for services.

Attributes

Supertypes
trait ContextDsl
trait Identified
class Object
trait Matchable
class Any
Show all
trait Html

Abstract HTML Code which can contain other HTML Snippets and embedded Components.

Abstract HTML Code which can contain other HTML Snippets and embedded Components.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class SimpleHtml
object Html

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Html.type
trait Identified

Some object which has an identifier.

Some object which has an identifier.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Component
class Model[T]
Show all
object Identifier

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Identifier.type
trait IdentifierFactory

Builds identifiers.

Builds identifiers.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Default
object IdentifierFactory

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
case class JsEvent(componentId: Option[Identifier], name: String, capture: Boolean)

A JavaScript DOM Event

A JavaScript DOM Event

Value parameters

capture

if true, the event will be captured.

componentId

the component ID, if not given, it's a window event.

name

name of the event

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Logger

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Logger.type
final class Model[T] extends Subscribeable[T], Identified

A Model is something which holds a value and can be subscribed to. In contrast to channels, models carry a current value and are subscribed by components. They are allowed to be singletons. They are identified using their ID. There is only one model of the same id allowed within an Engine.

A Model is something which holds a value and can be subscribed to. In contrast to channels, models carry a current value and are subscribed by components. They are allowed to be singletons. They are identified using their ID. There is only one model of the same id allowed within an Engine.

Attributes

Companion
object
Supertypes
trait Identified
trait Subscribeable[T]
class Object
trait Matchable
class Any
object Model

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
Model.type
trait ModelValueProvider

Provides values for models.

Provides values for models.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Empty
sealed trait RuntimeState[S]

Encapsulates a runtime state field.

Encapsulates a runtime state field.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class And[S1, S2]
class Collect[S]
class Const[S]
trait JsRuntimeStateBase[D, S]
class JsProperty[D, S]
class JsRuntimeState[D, S]
class Mapping[S1, S2]
Show all
object RuntimeState

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
trait ServiceNameProvider[T]

A Type class which provides names for services.

A Type class which provides names for services.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Impl[T]
object ServiceNameProvider

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
case class ServiceNotFoundException(serviceName: String) extends RuntimeException

Exception thrown if a service is not found.

Exception thrown if a service is not found.

Attributes

Supertypes
trait Product
trait Equals
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
trait ServiceRepository

Contains unique services identified by their Name.

Contains unique services identified by their Name.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Empty
object ServiceRepository

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
abstract class SimpleComponentBase extends SimpleContextDsl, Component

A Component base which uses a more imperative AssemblerContext for collecting event handlers and model subscriptions.

A Component base which uses a more imperative AssemblerContext for collecting event handlers and model subscriptions.

Attributes

Supertypes
trait Component
trait Identified
trait ComponentDsl
trait ContextDsl
class Object
trait Matchable
class Any
Show all
class SimpleContext(underlying: AssemblerContext) extends AssemblerContext

A simple of AssemblerContext which also collects event bindings / event subscriptions

A simple of AssemblerContext which also collects event bindings / event subscriptions

Attributes

Supertypes
class Object
trait Matchable
class Any
Show all
trait SimpleContextDsl extends ComponentDsl

Helpers for building imperative Components using SimpleContext

Helpers for building imperative Components using SimpleContext

Attributes

Supertypes
trait ComponentDsl
trait ContextDsl
class Object
trait Matchable
class Any
Known subtypes
Self type
case class SimpleHtml(tag: String, attributes: Vector[(String, Option[String])], children: Vector[SimpleHtmlNode], comment: String) extends Html, SimpleHtmlNode

Trivial implementation of Html. Note: just implemented enough to get it barely working.

Trivial implementation of Html. Note: just implemented enough to get it barely working.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Html
class Object
trait Matchable
class Any
Show all
sealed trait SimpleHtmlNode

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class SimpleHtml
class Raw
class Text
class Wrapper
object SimpleHtmlNode

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait Subscribeable[+T]

Something which can be subscribed.

Something which can be subscribed.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Model[T]
class Constant[T]
class Mapped[U, T]
object Subscribeable

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait UpdateResult

Result of an update operation of a component.

Result of an update operation of a component.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Append
class Build
class Prepend
object UpdateResult

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type

Types

type HtmlEmbedding = Component | Html

Something which can be embedded into HTML.

Something which can be embedded into HTML.

Attributes

opaque type Identifier

Identifier for identifying things.

Identifier for identifying things.

Attributes

Generated with