Package-level declarations

Types

Link copied to clipboard
@Pattern(value = "^[a-zA-Z0-9_]+(\.[a-zA-Z0-9_]+)*$")
@Target(allowedTargets = [AnnotationTarget.TYPE])
annotation class BundlePath
Link copied to clipboard
interface Colors

A class that contains all the colors used in the Surf system. This class is used to provide a uniform appearance across all Surf plugins. Simons dc post

Link copied to clipboard
Link copied to clipboard
class ComponentMessage(message: ComponentLike) : Message, ComponentLike
Link copied to clipboard
@Pattern(value = "[A-Z][a-zA-Z0-9]*")
@Target(allowedTargets = [AnnotationTarget.TYPE])
annotation class NoLowercase

Functions

Link copied to clipboard
fun <C : BuildableComponent<C, B>, B : ComponentBuilder<C, B>> ComponentBuilder<C, B>.appendNewline(amount: Int)
Link copied to clipboard
fun <C : BuildableComponent<C, B>, B : ComponentBuilder<C, B>> ComponentBuilder<C, B>.appendText(text: String, color: TextColor? = null): @NotNull B
fun <C : BuildableComponent<C, B>, B : ComponentBuilder<C, B>> ComponentBuilder<C, B>.appendText(text: String, color: TextColor? = null, block: TextComponent.Builder.() -> Unit): @NotNull B
Link copied to clipboard
inline fun buildText(block: SurfComponentBuilder.() -> Unit): TextComponent
Link copied to clipboard
fun <C : BuildableComponent<C, B>, B : ComponentBuilder<C, B>> ComponentBuilder<C, B>.clickOpensUrl(url: String): @NotNull B
Link copied to clipboard
fun <E> Iterable<E>.joinToComponent(formatter: (E) -> Component): Component
fun <K, V> Map<K, V>.joinToComponent(keyFormatter: (K) -> Component, valueFormatter: (V) -> Component, linePrefix: Component = PREFIX, keyValueSeparator: Component = MAP_KEY_VALUE_SEPARATOR): Component
Link copied to clipboard
fun <E> Iterable<E>.joinToComponentNewLine(linePrefix: Component = PREFIX, formatter: (E) -> Component): Component