Skip to content
scalive
Menu
ConnectingLiveReconnectingOffline
p

scalive

package object scalive extends HtmlTags with HtmlAttrs with ComplexHtmlKeys with Components

Defined by scalive. View source (scalive/api/src/scalive/Scalive.scala:1-1)

Core API36

component

def component[Props, Msg, Model, Output](value: LiveComponent.WithOutput[Props, Msg, Model, Output], id: String): LiveComponentOutputInstance[Props, Msg, Model, Output]

Defined by scalive.component. View source (scalive/api/src/scalive/Scalive.scala:25-29)

def component[Props, Msg, Model](value: LiveComponent[Props, Msg, Model], id: String): LiveComponentInstance[Props, Msg, Model]

Defined by scalive.component. View source (scalive/api/src/scalive/Scalive.scala:20-23)

ConsumeDecision

def ConsumeDecision: upload.api.ConsumeDecision.type

Exported from scalive.ConsumeDecision. View source (scalive/api/src/scalive/Scalive.scala:13-13)

dropTarget

extension def dropTarget[R](upload: Signal[LiveUpload[R]]): Mod.Attr[Nothing]

Defined by scalive.dropTarget. View source (scalive/api/src/scalive/Scalive.scala:317-317)

extension def dropTarget[R](upload: LiveUpload[R]): Mod.Attr[Nothing]

Defined by scalive.dropTarget. View source (scalive/api/src/scalive/Scalive.scala:312-312)

ExternalUploadClientConfig

def ExternalUploadClientConfig: upload.api.ExternalUploadClientConfig.type

Exported from scalive.ExternalUploadClientConfig. View source (scalive/api/src/scalive/Scalive.scala:13-13)

field

extension def field[Owner, A](form: Signal[RootedForm[Owner, A]])[B](definition: RootedFormField[Owner, B]): Signal[FormFieldView[B]]

Returns a signal-backed value for a field owned by this rooted form.

Defined by scalive.field. View source (scalive/api/src/scalive/forms/FormDefinition.scala:556-557)

htmlElementToMod

def htmlElementToMod[Msg](value: HtmlElement[Msg]): Mod[Msg]

Defined by scalive.htmlElementToMod. View source (scalive/api/src/scalive/Scalive.scala:324-324)

liveComponent

def liveComponent[Props, Msg, Model, Output, OwnerMsg](value: LiveComponent.WithOutput[Props, Msg, Model, Output], id: String, props: Props, onOutput: Output => OwnerMsg): Mod[OwnerMsg]

Defined by scalive.liveComponent. View source (scalive/api/src/scalive/Scalive.scala:55-61)

def liveComponent[Props, Msg, Model, Output, OwnerMsg](value: LiveComponent.WithOutput[Props, Msg, Model, Output], id: String, props: Signal[Props], onOutput: Output => OwnerMsg): Mod[OwnerMsg]

Defined by scalive.liveComponent. View source (scalive/api/src/scalive/Scalive.scala:63-69)

def liveComponent[Props, Msg, Model, Output, OwnerMsg](value: LiveComponent.WithOutput[Props, Msg, Model, Output], id: Signal[String], props: Signal[Props], onOutput: Output => OwnerMsg): Mod[OwnerMsg]

Defined by scalive.liveComponent. View source (scalive/api/src/scalive/Scalive.scala:71-77)

def liveComponent[Props, Msg, Model](value: LiveComponent[Props, Msg, Model], id: String, props: Props): Mod[Nothing]

Defined by scalive.liveComponent. View source (scalive/api/src/scalive/Scalive.scala:31-35)

def liveComponent[Props, Msg, Model](value: LiveComponent[Props, Msg, Model], id: String, props: Signal[Props]): Mod[Nothing]

Defined by scalive.liveComponent. View source (scalive/api/src/scalive/Scalive.scala:37-41)

def liveComponent[Props, Msg, Model](value: LiveComponent[Props, Msg, Model], id: Signal[String], props: Props): Mod[Nothing]

Defined by scalive.liveComponent. View source (scalive/api/src/scalive/Scalive.scala:49-53)

def liveComponent[Props, Msg, Model](value: LiveComponent[Props, Msg, Model], id: Signal[String], props: Signal[Props]): Mod[Nothing]

Defined by scalive.liveComponent. View source (scalive/api/src/scalive/Scalive.scala:43-47)

LiveExternalUploadResult

def LiveExternalUploadResult: upload.api.LiveExternalUploadResult.type

Exported from scalive.LiveExternalUploadResult. View source (scalive/api/src/scalive/Scalive.scala:13-13)

LiveStream

def LiveStream: streams.LiveStream$

Exported from scalive.LiveStream. View source (scalive/api/src/scalive/Scalive.scala:12-12)

LiveStreamDef

def LiveStreamDef: streams.api.LiveStreamDef.type

Exported from scalive.LiveStreamDef. View source (scalive/api/src/scalive/Scalive.scala:12-12)

liveTitle

def liveTitle(pageTitle: Option[String], default: String, prefix: String = ..., suffix: String = ...): HtmlElement[Nothing]

Defined by scalive.liveTitle. View source (scalive/api/src/scalive/Scalive.scala:145-157)

def liveTitle(pageTitle: Signal[Option[String]], default: String): HtmlElement[Nothing]

Defined by scalive.liveTitle. View source (scalive/api/src/scalive/Scalive.scala:172-173)

def liveTitle(pageTitle: Signal[Option[String]], default: String, prefix: String, suffix: String): HtmlElement[Nothing]

Defined by scalive.liveTitle. View source (scalive/api/src/scalive/Scalive.scala:159-170)

LiveUploadAbortReason

def LiveUploadAbortReason: upload.api.LiveUploadAbortReason.type

Exported from scalive.LiveUploadAbortReason. View source (scalive/api/src/scalive/Scalive.scala:13-13)

LiveUploadAccept

def LiveUploadAccept: upload.api.LiveUploadAccept.type

Exported from scalive.LiveUploadAccept. View source (scalive/api/src/scalive/Scalive.scala:13-13)

LiveUploadDef

def LiveUploadDef: upload.api.LiveUploadDef.type

Exported from scalive.LiveUploadDef. View source (scalive/api/src/scalive/Scalive.scala:13-13)

LiveUploadDestination

def LiveUploadDestination: upload.api.LiveUploadDestination.type

Exported from scalive.LiveUploadDestination. View source (scalive/api/src/scalive/Scalive.scala:13-13)

LiveUploadEntryStatus

def LiveUploadEntryStatus: upload.api.LiveUploadEntryStatus.type

Exported from scalive.LiveUploadEntryStatus. View source (scalive/api/src/scalive/Scalive.scala:13-13)

LiveUploadError

def LiveUploadError: upload.api.LiveUploadError.type

Exported from scalive.LiveUploadError. View source (scalive/api/src/scalive/Scalive.scala:13-13)

LiveUploadOperationError

def LiveUploadOperationError: upload.api.LiveUploadOperationError.type

Exported from scalive.LiveUploadOperationError. View source (scalive/api/src/scalive/Scalive.scala:13-13)

liveView

def liveView[A, Msg, Model](id: String, value: Signal[A])(factory: A => LiveView[Msg, Model]): Mod[Nothing]

Defined by scalive.liveView. View source (scalive/api/src/scalive/Scalive.scala:99-104)

def liveView[A, Msg, Model](id: String, value: Signal[A], sticky: Boolean, linkParentOnCrash: A => Boolean)(factory: A => LiveView[Msg, Model]): Mod[Nothing]

Defined by scalive.liveView. View source (scalive/api/src/scalive/Scalive.scala:87-97)

def liveView[Msg, Model](id: String, value: => LiveView[Msg, Model], sticky: Boolean = ..., linkParentOnCrash: Boolean = ...): Mod[Nothing]

Defined by scalive.liveView. View source (scalive/api/src/scalive/Scalive.scala:79-85)

onProgress

extension def onProgress[R](upload: Signal[LiveUpload[R]])[Msg](f: Map[String, String] => Msg): Mod.Attr[Msg]

Defined by scalive.onProgress. View source (scalive/api/src/scalive/Scalive.scala:319-319)

extension def onProgress[R](upload: Signal[LiveUpload[R]])[Msg](message: Msg): Mod.Attr[Msg]

Defined by scalive.onProgress. View source (scalive/api/src/scalive/Scalive.scala:318-318)

extension def onProgress[R](upload: LiveUpload[R])[Msg](f: Map[String, String] => Msg): Mod.Attr[Msg]

Defined by scalive.onProgress. View source (scalive/api/src/scalive/Scalive.scala:314-314)

extension def onProgress[R](upload: LiveUpload[R])[Msg](message: Msg): Mod.Attr[Msg]

Defined by scalive.onProgress. View source (scalive/api/src/scalive/Scalive.scala:313-313)

portal

def portal[Msg](id: String, target: DomSelector, container: String = ..., wrapperClass: Option[String] = ...)(mods: |[Mod[Msg], IterableOnce[Mod[Msg]]]*): HtmlElement[Msg]

Defined by scalive.portal. View source (scalive/api/src/scalive/Scalive.scala:109-134)

rawHtml

def rawHtml(html: String): Mod[Nothing]

Defined by scalive.rawHtml. View source (scalive/api/src/scalive/Scalive.scala:17-17)

def rawHtml(html: Signal[String]): Mod[Nothing]

Defined by scalive.rawHtml. View source (scalive/api/src/scalive/Scalive.scala:18-18)

renderIn

extension def renderIn[A](stream: Signal[streams.LiveStream[A]])[Msg](container: HtmlTag, mods: Mod[Msg]*)(project: Signal[A] => HtmlElement[Msg]): HtmlElement[Msg]

Declares a signal-backed stream container finalized by the renderer.

Defined by scalive.renderIn. View source (scalive/api/src/scalive/CollectionOps.scala:63-81)

extension def renderIn[A](stream: streams.LiveStream[A])[Msg](container: HtmlTag, mods: Mod[Msg]*)(project: A => HtmlElement[Msg]): HtmlElement[Msg]

Declares a stream container whose IDs and patch mode are finalized by the renderer.

Defined by scalive.renderIn. View source (scalive/api/src/scalive/CollectionOps.scala:38-55)

signalStringToMod

def signalStringToMod(value: Signal[String]): Mod[Nothing]

Defined by scalive.signalStringToMod. View source (scalive/api/src/scalive/Scalive.scala:322-323)

splitBy

extension def splitBy[A, Items <: Iterable[A]](items: Signal[Items])[Key, Msg](key: A => Key)(project: (Key, Signal[A]) => HtmlElement[Msg]): Mod[Msg]

Declares retained keyed rows projected from a collection signal.

Defined by scalive.splitBy. View source (scalive/api/src/scalive/CollectionOps.scala:21-26)

extension def splitBy[A](items: IterableOnce[A])[Key, Msg](key: A => Key)(project: (Key, A) => HtmlElement[Msg]): Mod[Msg]

Declares keyed child content using exact domain-key equality.

Defined by scalive.splitBy. View source (scalive/api/src/scalive/CollectionOps.scala:5-10)

splitByIndex

extension def splitByIndex[A, Items <: Iterable[A]](items: Signal[Items])[Msg](project: (Int, Signal[A]) => HtmlElement[Msg]): Mod[Msg]

Declares retained rows whose identity is their current index.

Defined by scalive.splitByIndex. View source (scalive/api/src/scalive/CollectionOps.scala:29-30)

extension def splitByIndex[A](items: IterableOnce[A])[Msg](project: (Int, A) => HtmlElement[Msg]): Mod[Msg]

Declares positionally keyed child content.

Defined by scalive.splitByIndex. View source (scalive/api/src/scalive/CollectionOps.scala:13-17)

stream

extension def stream[A](stream: Signal[streams.LiveStream[A]])[Msg](project: (String, Signal[A]) => HtmlElement[Msg]): Mod[Msg]

Declares signal-backed streamed rows.

Defined by scalive.stream. View source (scalive/api/src/scalive/CollectionOps.scala:59-60)

extension def stream[A](stream: streams.LiveStream[A])[Msg](project: (String, A) => HtmlElement[Msg]): Mod[Msg]

Declares streamed rows without exposing stream runtime state.

Defined by scalive.stream. View source (scalive/api/src/scalive/CollectionOps.scala:34-35)

StreamAt

def StreamAt: streams.api.StreamAt.type

Exported from scalive.StreamAt. View source (scalive/api/src/scalive/Scalive.scala:12-12)

StreamLimit

def StreamLimit: streams.api.StreamLimit.type

Exported from scalive.StreamLimit. View source (scalive/api/src/scalive/Scalive.scala:12-12)

stringToMod

def stringToMod(value: String): Mod[Nothing]

Defined by scalive.stringToMod. View source (scalive/api/src/scalive/Scalive.scala:321-321)

UploadEntryRef

def UploadEntryRef: upload.api.UploadEntryRef.type

Exported from scalive.UploadEntryRef. View source (scalive/api/src/scalive/Scalive.scala:13-13)

UploadRef

def UploadRef: upload.api.UploadRef.type

Exported from scalive.UploadRef. View source (scalive/api/src/scalive/Scalive.scala:13-13)

value

extension def value(ref: upload.UploadEntryRef): String

Exported from scalive.value. View source (scalive/api/src/scalive/Scalive.scala:13-13)

extension def value(ref: upload.UploadRef): String

Exported from scalive.value. View source (scalive/api/src/scalive/Scalive.scala:13-13)

defer

lazy val defer: HtmlAttr[Boolean]

Defined by scalive.defer. View source (scalive/api/src/scalive/Scalive.scala:15-15)

JS

val JS: JSCommands.JSCommand[Nothing]

The empty JSCommand from which client commands are composed.

Each extension appends one operation and returns a new command. Chained operations execute in call order. Client-only operations do not wait for an earlier server operation to be acknowledged before starting.

Defined by scalive.JS. View source (scalive/api/src/scalive/JS.scala:12-12)

live

val live: LiveRouteSeed[Unit]

Defined by scalive.live. View source (scalive/api/src/scalive/routing/LiveRouting.scala:913-913)

Components3

focusWrap

def focusWrap[Msg](id: String, mods: Mod[Msg]*)(content: Mod[Msg]*): HtmlElement[Msg]

Renders a keyboard-focus boundary using Phoenix's Phoenix.FocusWrap hook.

The returned wrapper receives id and the supplied mods, and surrounds content with focusable, assistive-technology-hidden sentinels named ${id}-start and ${id}-end. Keep id stable and unique in the document so the hook and sentinels retain their DOM identity. Do not supply another id or phx-hook in mods; those attributes belong to this helper's protocol structure. Supply only attributes and bindings in mods: content there is placed before the start sentinel and breaks the hook's expected structure.

Parameters

id

stable DOM ID used by the wrapper and its two sentinels

mods

additional wrapper attributes and bindings, not child content

content

content whose focus should wrap at the boundaries

Inherited from scalive.defs.components.Components.focusWrap. View source (scalive/api/src/scalive/defs/components/Components.scala:27-37)

liveFileInput

def liveFileInput[Msg, R](upload: Signal[LiveUpload[R]], mods: Mod[Msg]*): HtmlElement[Msg]

Renders a signal-backed upload input from the committed upload snapshot.

Inherited from scalive.defs.components.Components.liveFileInput. View source (scalive/api/src/scalive/defs/components/Components.scala:95-130)

def liveFileInput[Msg, R](upload: LiveUpload[R], mods: Mod[Msg]*): HtmlElement[Msg]

Renders the file input required by the LiveView upload protocol.

The helper derives the input id, name, accept, and multiple state from the current LiveUpload snapshot. It also owns the Phoenix.LiveFileUpload hook and the data-phx-upload-ref, data-phx-active-refs, data-phx-done-refs, and data-phx-preflighted-refs protocol attributes. data-phx-auto-upload is present only for automatic uploads. These attributes allow the browser client to correlate selections and progress with server-side entries; do not remove or hand-edit them. Refresh the upload snapshot after upload events before rendering it again. Supply only attributes and bindings in mods; an input is a void element and cannot contain child content.

Validation and transfer failures are not rendered by the input. Read them with uploadErrors and present them explicitly.

Parameters

upload

the currently allowed upload snapshot to bind to this input

mods

additional input attributes and bindings, commonly an upload progress binding; do not pass content or duplicate the protocol attributes owned by this helper

Inherited from scalive.defs.components.Components.liveFileInput. View source (scalive/api/src/scalive/defs/components/Components.scala:61-92)

uploadErrors

def uploadErrors[R](entry: Signal[LiveUploadEntry[R]]): Signal[List[LiveUploadError]]

Returns entry errors from a signal-backed upload-entry value.

Inherited from scalive.defs.components.Components.uploadErrors. View source (scalive/api/src/scalive/defs/components/Components.scala:157-159)

def uploadErrors[R](entry: LiveUploadEntry[R]): List[LiveUploadError]

Returns validation or transfer errors attached to this upload entry.

An entry that is not in the invalid state has no errors and returns Nil.

Inherited from scalive.defs.components.Components.uploadErrors. View source (scalive/api/src/scalive/defs/components/Components.scala:154-154)

def uploadErrors[R](upload: Signal[LiveUpload[R]]): Signal[List[LiveUploadError]]

Returns upload-wide errors from a signal-backed upload value.

Inherited from scalive.defs.components.Components.uploadErrors. View source (scalive/api/src/scalive/defs/components/Components.scala:139-140)

def uploadErrors[R](upload: LiveUpload[R]): List[LiveUploadError]

Returns upload-wide errors, such as selecting more files than the definition permits.

Entry-specific validation or transfer errors are available from an entry overload.

Inherited from scalive.defs.components.Components.uploadErrors. View source (scalive/api/src/scalive/defs/components/Components.scala:136-136)

def uploadErrors[R](upload: LiveUpload[R], entry: LiveUploadEntry[R]): List[LiveUploadError]

Returns current errors for entry as recorded in upload.

Matching is by upload entry reference. Nil is returned when the reference is absent from this upload snapshot, including after that entry has been removed.

Inherited from scalive.defs.components.Components.uploadErrors. View source (scalive/api/src/scalive/defs/components/Components.scala:147-148)

HTML elements113

htmlTag

def htmlTag(name: String, void: Boolean = ...): HtmlTag

Creates a reusable HTML tag definition.

The name is validated by HtmlTag. Applying the returned tag creates an element. Set void only for tags that must be serialized without a closing tag; callers must still avoid supplying children.

Parameters

name

tag name, for example div or mwc-input

void

whether elements created by this tag are serialized without a closing tag

Inherited from scalive.defs.tags.HtmlTags.htmlTag. View source (Generated from Scala DOM Types 19.0.0)

a

lazy val a: HtmlTag

Represents a hyperlink, linking to another resource.

Inherited from scalive.defs.tags.HtmlTags.a. View source (Generated from Scala DOM Types 19.0.0)

abbr

lazy val abbr: HtmlTag

An abbreviation or acronym; the expansion of the abbreviation can be represented in the title attribute.

abbr @ MDN

Inherited from scalive.defs.tags.HtmlTags.abbr. View source (Generated from Scala DOM Types 19.0.0)

addressTag

lazy val addressTag: HtmlTag

Defines a section containing contact information.

address @ MDN

Inherited from scalive.defs.tags.HtmlTags.addressTag. View source (Generated from Scala DOM Types 19.0.0)

areaTag

lazy val areaTag: HtmlTag

In conjunction with map, defines an image map

Inherited from scalive.defs.tags.HtmlTags.areaTag. View source (Generated from Scala DOM Types 19.0.0)

articleTag

lazy val articleTag: HtmlTag

Defines self-contained content that could exist independently of the rest of the content.

article @ MDN

Inherited from scalive.defs.tags.HtmlTags.articleTag. View source (Generated from Scala DOM Types 19.0.0)

asideTag

lazy val asideTag: HtmlTag

Defines some content loosely related to the page content. If it is removed, the remaining content still makes sense.

aside @ MDN

Inherited from scalive.defs.tags.HtmlTags.asideTag. View source (Generated from Scala DOM Types 19.0.0)

audioTag

lazy val audioTag: HtmlTag

Represents a sound or an audio stream.

Inherited from scalive.defs.tags.HtmlTags.audioTag. View source (Generated from Scala DOM Types 19.0.0)

b

lazy val b: HtmlTag

Bold text.

b @ MDN

Inherited from scalive.defs.tags.HtmlTags.b. View source (Generated from Scala DOM Types 19.0.0)

baseTag

lazy val baseTag: HtmlTag

Defines the base URL for relative URLs in the page.

Inherited from scalive.defs.tags.HtmlTags.baseTag. View source (Generated from Scala DOM Types 19.0.0)

bdi

lazy val bdi: HtmlTag

Represents text that must be isolated from its surrounding for bidirectional text formatting. It allows embedding a span of text with a different, or unknown, directionality.

bdi @ MDN

Inherited from scalive.defs.tags.HtmlTags.bdi. View source (Generated from Scala DOM Types 19.0.0)

bdo

lazy val bdo: HtmlTag

Represents the directionality of its children, in order to explicitly override the Unicode bidirectional algorithm.

bdo @ MDN

Inherited from scalive.defs.tags.HtmlTags.bdo. View source (Generated from Scala DOM Types 19.0.0)

blockQuote

lazy val blockQuote: HtmlTag

Represents a content that is quoted from another source.

Inherited from scalive.defs.tags.HtmlTags.blockQuote. View source (Generated from Scala DOM Types 19.0.0)

bodyTag

lazy val bodyTag: HtmlTag

Represents the content of an HTML document. There is only one body element in a document.

Inherited from scalive.defs.tags.HtmlTags.bodyTag. View source (Generated from Scala DOM Types 19.0.0)

br

lazy val br: HtmlTag

Represents a line break.

Inherited from scalive.defs.tags.HtmlTags.br. View source (Generated from Scala DOM Types 19.0.0)

button

lazy val button: HtmlTag

A button

Inherited from scalive.defs.tags.HtmlTags.button. View source (Generated from Scala DOM Types 19.0.0)

canvasTag

lazy val canvasTag: HtmlTag

Represents a bitmap area that scripts can use to render graphics like graphs, games or any visual images on the fly.

Inherited from scalive.defs.tags.HtmlTags.canvasTag. View source (Generated from Scala DOM Types 19.0.0)

caption

lazy val caption: HtmlTag

The title of a table.

Inherited from scalive.defs.tags.HtmlTags.caption. View source (Generated from Scala DOM Types 19.0.0)

cite

lazy val cite: HtmlTag

Represents the title of a work being cited.

cite @ MDN

Inherited from scalive.defs.tags.HtmlTags.cite. View source (Generated from Scala DOM Types 19.0.0)

code

lazy val code: HtmlTag

Represents computer code.

code @ MDN

Inherited from scalive.defs.tags.HtmlTags.code. View source (Generated from Scala DOM Types 19.0.0)

col

lazy val col: HtmlTag

A single column.

Inherited from scalive.defs.tags.HtmlTags.col. View source (Generated from Scala DOM Types 19.0.0)

colGroup

lazy val colGroup: HtmlTag

A set of columns.

Inherited from scalive.defs.tags.HtmlTags.colGroup. View source (Generated from Scala DOM Types 19.0.0)

commandTag

lazy val commandTag: HtmlTag

A command that the user can invoke.

the-command-element.html @ W3C

Inherited from scalive.defs.tags.HtmlTags.commandTag. View source (Generated from Scala DOM Types 19.0.0)

dataList

lazy val dataList: HtmlTag

A set of predefined options for other controls.

Inherited from scalive.defs.tags.HtmlTags.dataList. View source (Generated from Scala DOM Types 19.0.0)

dataTag

lazy val dataTag: HtmlTag

Associates to its content a machine-readable equivalent.

data @ MDN

Inherited from scalive.defs.tags.HtmlTags.dataTag. View source (Generated from Scala DOM Types 19.0.0)

dd

lazy val dd: HtmlTag

Represents the definition of the terms immediately listed before it.

dd @ MDN

Inherited from scalive.defs.tags.HtmlTags.dd. View source (Generated from Scala DOM Types 19.0.0)

del

lazy val del: HtmlTag

Represents content removed from the document.

Inherited from scalive.defs.tags.HtmlTags.del. View source (Generated from Scala DOM Types 19.0.0)

detailsTag

lazy val detailsTag: HtmlTag

A widget from which the user can obtain additional information or controls.

details @ MDN

Inherited from scalive.defs.tags.HtmlTags.detailsTag. View source (Generated from Scala DOM Types 19.0.0)

dfn

lazy val dfn: HtmlTag

Represents a term whose definition is contained in its nearest ancestor content.

dfn @ MDN

Inherited from scalive.defs.tags.HtmlTags.dfn. View source (Generated from Scala DOM Types 19.0.0)

dialogTag

lazy val dialogTag: HtmlTag

Dialog box or other interactive component, such as a dismissible alert, inspector, or subwindow.

Note: The tabindex attribute must not be used on the <dialog> element

Inherited from scalive.defs.tags.HtmlTags.dialogTag. View source (Generated from Scala DOM Types 19.0.0)

div

lazy val div: HtmlTag

Represents a generic container with no special meaning.

Inherited from scalive.defs.tags.HtmlTags.div. View source (Generated from Scala DOM Types 19.0.0)

dl

lazy val dl: HtmlTag

Defines a definition list; a list of terms and their associated definitions.

Inherited from scalive.defs.tags.HtmlTags.dl. View source (Generated from Scala DOM Types 19.0.0)

dt

lazy val dt: HtmlTag

Represents a term defined by the next dd

dt @ MDN

Inherited from scalive.defs.tags.HtmlTags.dt. View source (Generated from Scala DOM Types 19.0.0)

em

lazy val em: HtmlTag

Represents emphasized text.

em @ MDN

Inherited from scalive.defs.tags.HtmlTags.em. View source (Generated from Scala DOM Types 19.0.0)

embedTag

lazy val embedTag: HtmlTag

Represents a integration point for an external, often non-HTML, application or interactive content.

Inherited from scalive.defs.tags.HtmlTags.embedTag. View source (Generated from Scala DOM Types 19.0.0)

fieldSet

lazy val fieldSet: HtmlTag

A set of fields.

Inherited from scalive.defs.tags.HtmlTags.fieldSet. View source (Generated from Scala DOM Types 19.0.0)

figCaption

lazy val figCaption: HtmlTag

Represents the legend of a figure.

figcaption @ MDN

Inherited from scalive.defs.tags.HtmlTags.figCaption. View source (Generated from Scala DOM Types 19.0.0)

figure

lazy val figure: HtmlTag

Represents a figure illustrated as part of the document.

figure @ MDN

Inherited from scalive.defs.tags.HtmlTags.figure. View source (Generated from Scala DOM Types 19.0.0)

form

lazy val form: HtmlTag

Represents a form, consisting of controls, that can be submitted to a server for processing.

Inherited from scalive.defs.tags.HtmlTags.form. View source (Generated from Scala DOM Types 19.0.0)

h1

lazy val h1: HtmlTag

Heading level 1

Inherited from scalive.defs.tags.HtmlTags.h1. View source (Generated from Scala DOM Types 19.0.0)

h2

lazy val h2: HtmlTag

Heading level 2

Inherited from scalive.defs.tags.HtmlTags.h2. View source (Generated from Scala DOM Types 19.0.0)

h3

lazy val h3: HtmlTag

Heading level 3

Inherited from scalive.defs.tags.HtmlTags.h3. View source (Generated from Scala DOM Types 19.0.0)

h4

lazy val h4: HtmlTag

Heading level 4

Inherited from scalive.defs.tags.HtmlTags.h4. View source (Generated from Scala DOM Types 19.0.0)

h5

lazy val h5: HtmlTag

Heading level 5

Inherited from scalive.defs.tags.HtmlTags.h5. View source (Generated from Scala DOM Types 19.0.0)

h6

lazy val h6: HtmlTag

Heading level 6

Inherited from scalive.defs.tags.HtmlTags.h6. View source (Generated from Scala DOM Types 19.0.0)

headerTag

lazy val headerTag: HtmlTag

Defines the header of a page or section. It often contains a logo, the title of the Web site, and a navigational table of content.

header @ MDN

Inherited from scalive.defs.tags.HtmlTags.headerTag. View source (Generated from Scala DOM Types 19.0.0)

headTag

lazy val headTag: HtmlTag

Represents a collection of metadata about the document, including links to, or definitions of, scripts and style sheets.

Inherited from scalive.defs.tags.HtmlTags.headTag. View source (Generated from Scala DOM Types 19.0.0)

hr

lazy val hr: HtmlTag

Represents a thematic break between paragraphs of a section or article or any longer content.

Inherited from scalive.defs.tags.HtmlTags.hr. View source (Generated from Scala DOM Types 19.0.0)

htmlRootTag

lazy val htmlRootTag: HtmlTag

Represents the root of an HTML or XHTML document. All other elements must be descendants of this element.

Inherited from scalive.defs.tags.HtmlTags.htmlRootTag. View source (Generated from Scala DOM Types 19.0.0)

i

lazy val i: HtmlTag

Italicized text.

i @ MDN

Inherited from scalive.defs.tags.HtmlTags.i. View source (Generated from Scala DOM Types 19.0.0)

iframe

lazy val iframe: HtmlTag

Represents a nested browsing context, that is an embedded HTML document.

Inherited from scalive.defs.tags.HtmlTags.iframe. View source (Generated from Scala DOM Types 19.0.0)

img

lazy val img: HtmlTag

Represents an image.

Inherited from scalive.defs.tags.HtmlTags.img. View source (Generated from Scala DOM Types 19.0.0)

input

lazy val input: HtmlTag

A typed data field allowing the user to input data.

Inherited from scalive.defs.tags.HtmlTags.input. View source (Generated from Scala DOM Types 19.0.0)

ins

lazy val ins: HtmlTag

Defines an addition to the document.

Inherited from scalive.defs.tags.HtmlTags.ins. View source (Generated from Scala DOM Types 19.0.0)

kbd

lazy val kbd: HtmlTag

Represents user input, often from a keyboard, but not necessarily.

kbd @ MDN

Inherited from scalive.defs.tags.HtmlTags.kbd. View source (Generated from Scala DOM Types 19.0.0)

keyGenTag

lazy val keyGenTag: HtmlTag

Defines the obsolete <keygen> element. Current browsers do not support this element; it remains available only for source compatibility.

Inherited from scalive.defs.tags.HtmlTags.keyGenTag. View source (Generated from Scala DOM Types 19.0.0)

label

lazy val label: HtmlTag

The caption of a single field

Inherited from scalive.defs.tags.HtmlTags.label. View source (Generated from Scala DOM Types 19.0.0)

legend

lazy val legend: HtmlTag

The caption for a fieldset.

Inherited from scalive.defs.tags.HtmlTags.legend. View source (Generated from Scala DOM Types 19.0.0)

li

lazy val li: HtmlTag

Defines an item of an list.

Inherited from scalive.defs.tags.HtmlTags.li. View source (Generated from Scala DOM Types 19.0.0)

mainTag

lazy val mainTag: HtmlTag

Defines the main or important content in the document. There is only one main element in the document.

main @ MDN

Inherited from scalive.defs.tags.HtmlTags.mainTag. View source (Generated from Scala DOM Types 19.0.0)

mapTag

lazy val mapTag: HtmlTag

In conjunction with area, defines an image map.

Inherited from scalive.defs.tags.HtmlTags.mapTag. View source (Generated from Scala DOM Types 19.0.0)

mark

lazy val mark: HtmlTag

Represents text highlighted for reference purposes, that is for its relevance in another context.

mark @ MDN

Inherited from scalive.defs.tags.HtmlTags.mark. View source (Generated from Scala DOM Types 19.0.0)

mathTag

lazy val mathTag: HtmlTag

The top-level element in MathML, representing a mathematical expression.

math @ MDN

Inherited from scalive.defs.tags.HtmlTags.mathTag. View source (Generated from Scala DOM Types 19.0.0)

metaTag

lazy val metaTag: HtmlTag

Defines metadata that can't be defined using another HTML element.

Inherited from scalive.defs.tags.HtmlTags.metaTag. View source (Generated from Scala DOM Types 19.0.0)

meterTag

lazy val meterTag: HtmlTag

A scalar measurement within a known range.

meter @ MDN

Inherited from scalive.defs.tags.HtmlTags.meterTag. View source (Generated from Scala DOM Types 19.0.0)

noScriptTag

lazy val noScriptTag: HtmlTag

Defines alternative content to display when the browser doesn't support scripting.

noscript @ MDN

Inherited from scalive.defs.tags.HtmlTags.noScriptTag. View source (Generated from Scala DOM Types 19.0.0)

objectTag

lazy val objectTag: HtmlTag

Represents an external resource, which is treated as an image, an HTML sub-document, or an external resource to be processed by a plug-in.

Inherited from scalive.defs.tags.HtmlTags.objectTag. View source (Generated from Scala DOM Types 19.0.0)

ol

lazy val ol: HtmlTag

Defines an ordered list of items.

Inherited from scalive.defs.tags.HtmlTags.ol. View source (Generated from Scala DOM Types 19.0.0)

optGroup

lazy val optGroup: HtmlTag

A set of options, logically grouped.

Inherited from scalive.defs.tags.HtmlTags.optGroup. View source (Generated from Scala DOM Types 19.0.0)

option

lazy val option: HtmlTag

An option in a select element.

Inherited from scalive.defs.tags.HtmlTags.option. View source (Generated from Scala DOM Types 19.0.0)

outputTag

lazy val outputTag: HtmlTag

The result of a calculation

output @ MDN

Inherited from scalive.defs.tags.HtmlTags.outputTag. View source (Generated from Scala DOM Types 19.0.0)

p

lazy val p: HtmlTag

Defines a portion that should be displayed as a paragraph.

Inherited from scalive.defs.tags.HtmlTags.p. View source (Generated from Scala DOM Types 19.0.0)

paramTag

lazy val paramTag: HtmlTag

Defines parameters for use by plug-ins invoked by object elements.

Inherited from scalive.defs.tags.HtmlTags.paramTag. View source (Generated from Scala DOM Types 19.0.0)

pre

lazy val pre: HtmlTag

Indicates that its content is preformatted and that this format must be preserved.

Inherited from scalive.defs.tags.HtmlTags.pre. View source (Generated from Scala DOM Types 19.0.0)

progressTag

lazy val progressTag: HtmlTag

A progress completion bar

Inherited from scalive.defs.tags.HtmlTags.progressTag. View source (Generated from Scala DOM Types 19.0.0)

q

lazy val q: HtmlTag

An inline quotation.

Inherited from scalive.defs.tags.HtmlTags.q. View source (Generated from Scala DOM Types 19.0.0)

rp

lazy val rp: HtmlTag

Represents parenthesis around a ruby annotation, used to display the annotation in an alternate way by browsers not supporting the standard display for annotations.

rp @ MDN

Inherited from scalive.defs.tags.HtmlTags.rp. View source (Generated from Scala DOM Types 19.0.0)

rt

lazy val rt: HtmlTag

Represents the text of a ruby annotation.

rt @ MDN

Inherited from scalive.defs.tags.HtmlTags.rt. View source (Generated from Scala DOM Types 19.0.0)

ruby

lazy val ruby: HtmlTag

Represents content to be marked with ruby annotations, short runs of text presented alongside the text. This is often used in conjunction with East Asian language where the annotations act as a guide for pronunciation, like the Japanese furigana .

ruby @ MDN

Inherited from scalive.defs.tags.HtmlTags.ruby. View source (Generated from Scala DOM Types 19.0.0)

s

lazy val s: HtmlTag

Strikethrough element, used for that is no longer accurate or relevant.

s @ MDN

Inherited from scalive.defs.tags.HtmlTags.s. View source (Generated from Scala DOM Types 19.0.0)

samp

lazy val samp: HtmlTag

Represents the output of a program or a computer.

samp @ MDN

Inherited from scalive.defs.tags.HtmlTags.samp. View source (Generated from Scala DOM Types 19.0.0)

scriptTag

lazy val scriptTag: HtmlTag

Defines either an internal script or a link to an external script. The script language is JavaScript.

Inherited from scalive.defs.tags.HtmlTags.scriptTag. View source (Generated from Scala DOM Types 19.0.0)

sectionTag

lazy val sectionTag: HtmlTag

Represents a generic section of a document, i.e., a thematic grouping of content, typically with a heading.

section @ MDN

Inherited from scalive.defs.tags.HtmlTags.sectionTag. View source (Generated from Scala DOM Types 19.0.0)

select

lazy val select: HtmlTag

A control that allows the user to select one of a set of options.

Inherited from scalive.defs.tags.HtmlTags.select. View source (Generated from Scala DOM Types 19.0.0)

slotTag

lazy val slotTag: HtmlTag

Placeholder element inside a web component that you can fill with your own markup.

Inherited from scalive.defs.tags.HtmlTags.slotTag. View source (Generated from Scala DOM Types 19.0.0)

small

lazy val small: HtmlTag

Represents a side comment; text like a disclaimer or copyright, which is not essential to the comprehension of the document.

small @ MDN

Inherited from scalive.defs.tags.HtmlTags.small. View source (Generated from Scala DOM Types 19.0.0)

sourceTag

lazy val sourceTag: HtmlTag

Allows the authors to specify alternate media resources for media elements like video or audio

Inherited from scalive.defs.tags.HtmlTags.sourceTag. View source (Generated from Scala DOM Types 19.0.0)

span

lazy val span: HtmlTag

Represents text with no specific meaning. This has to be used when no other text-semantic element conveys an adequate meaning, which, in this case, is often brought by global attributes like class, lang, or dir.

Inherited from scalive.defs.tags.HtmlTags.span. View source (Generated from Scala DOM Types 19.0.0)

strong

lazy val strong: HtmlTag

Represents especially important text.

strong @ MDN

Inherited from scalive.defs.tags.HtmlTags.strong. View source (Generated from Scala DOM Types 19.0.0)

styleTag

lazy val styleTag: HtmlTag

Used to write inline CSS.

Inherited from scalive.defs.tags.HtmlTags.styleTag. View source (Generated from Scala DOM Types 19.0.0)

sub

lazy val sub: HtmlTag

Subscript tag

sub @ MDN

Inherited from scalive.defs.tags.HtmlTags.sub. View source (Generated from Scala DOM Types 19.0.0)

summaryTag

lazy val summaryTag: HtmlTag

A summary, caption, or legend for a given details.

summary @ MDN

Inherited from scalive.defs.tags.HtmlTags.summaryTag. View source (Generated from Scala DOM Types 19.0.0)

sup

lazy val sup: HtmlTag

Superscript tag.

sup @ MDN

Inherited from scalive.defs.tags.HtmlTags.sup. View source (Generated from Scala DOM Types 19.0.0)

table

lazy val table: HtmlTag

Represents data with more than one dimension.

Inherited from scalive.defs.tags.HtmlTags.table. View source (Generated from Scala DOM Types 19.0.0)

tbody

lazy val tbody: HtmlTag

The table body.

Inherited from scalive.defs.tags.HtmlTags.tbody. View source (Generated from Scala DOM Types 19.0.0)

td

lazy val td: HtmlTag

A single cell in a table.

Inherited from scalive.defs.tags.HtmlTags.td. View source (Generated from Scala DOM Types 19.0.0)

textArea

lazy val textArea: HtmlTag

A multiline text edit control.

Inherited from scalive.defs.tags.HtmlTags.textArea. View source (Generated from Scala DOM Types 19.0.0)

tfoot

lazy val tfoot: HtmlTag

The table footer.

Inherited from scalive.defs.tags.HtmlTags.tfoot. View source (Generated from Scala DOM Types 19.0.0)

th

lazy val th: HtmlTag

A header cell in a table.

Inherited from scalive.defs.tags.HtmlTags.th. View source (Generated from Scala DOM Types 19.0.0)

thead

lazy val thead: HtmlTag

The table headers.

Inherited from scalive.defs.tags.HtmlTags.thead. View source (Generated from Scala DOM Types 19.0.0)

timeTag

lazy val timeTag: HtmlTag

Represents a date and time value; the machine-readable equivalent can be represented in the datetime attribute

time @ MDN

Inherited from scalive.defs.tags.HtmlTags.timeTag. View source (Generated from Scala DOM Types 19.0.0)

titleTag

lazy val titleTag: HtmlTag

Defines the title of the document, shown in a browser's title bar or on the page's tab. It can only contain text and any contained tags are not interpreted.

Inherited from scalive.defs.tags.HtmlTags.titleTag. View source (Generated from Scala DOM Types 19.0.0)

tr

lazy val tr: HtmlTag

A single row in a table.

Inherited from scalive.defs.tags.HtmlTags.tr. View source (Generated from Scala DOM Types 19.0.0)

trackTag

lazy val trackTag: HtmlTag

Allows authors to specify timed text track for media elements like video or audio

Inherited from scalive.defs.tags.HtmlTags.trackTag. View source (Generated from Scala DOM Types 19.0.0)

u

lazy val u: HtmlTag

Underlined text.

u @ MDN

Inherited from scalive.defs.tags.HtmlTags.u. View source (Generated from Scala DOM Types 19.0.0)

ul

lazy val ul: HtmlTag

Defines an unordered list of items.

Inherited from scalive.defs.tags.HtmlTags.ul. View source (Generated from Scala DOM Types 19.0.0)

varTag

lazy val varTag: HtmlTag

Represents a variable.

var @ MDN

Inherited from scalive.defs.tags.HtmlTags.varTag. View source (Generated from Scala DOM Types 19.0.0)

videoTag

lazy val videoTag: HtmlTag

Represents a video, and its associated audio files and captions, with the necessary interface to play it.

Inherited from scalive.defs.tags.HtmlTags.videoTag. View source (Generated from Scala DOM Types 19.0.0)

wbr

lazy val wbr: HtmlTag

Represents a line break opportunity, that is a suggested point for wrapping text in order to improve readability of text split on several lines.

wbr @ MDN

Inherited from scalive.defs.tags.HtmlTags.wbr. View source (Generated from Scala DOM Types 19.0.0)

HTML attributes75

htmlAttr

def htmlAttr[V](name: String, encoder: codecs.Encoder[V, String]): HtmlAttr[V]

Creates a typed HTML attribute definition.

The name is validated by HtmlAttr. Values assigned with := are encoded before rendering.

Parameters

name

attribute name, for example value

encoder

encoder from V to the rendered attribute string

Type parameters

V

Scala value type accepted by this attribute

Inherited from scalive.defs.attrs.HtmlAttrs.htmlAttr. View source (Generated from Scala DOM Types 19.0.0)

accept

lazy val accept: HtmlAttr[String]

If the value of the type attribute is file, this attribute indicates the types of files that the server accepts; otherwise it is ignored.

accept @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.accept. View source (Generated from Scala DOM Types 19.0.0)

accessKey

lazy val accessKey: HtmlAttr[String]

Specifies a shortcut key to activate/focus an element

accesskey @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.accessKey. View source (Generated from Scala DOM Types 19.0.0)

action

lazy val action: HtmlAttr[String]

The URI of a program that processes the information submitted via the form. This value can be overridden by a formAction attribute on a button or input element.

Only applies to the <form> element

action @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.action. View source (Generated from Scala DOM Types 19.0.0)

alt

lazy val alt: HtmlAttr[String]

This attribute defines the alternative text describing the image. Users will see this displayed if the image URL is wrong, the image is not in one of the supported formats, or until the image is downloaded.

alt @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.alt. View source (Generated from Scala DOM Types 19.0.0)

autoCapitalize

lazy val autoCapitalize: HtmlAttr[String]

This is a nonstandard attribute used by Chrome and iOS Safari Mobile, which controls whether and how the text value should be automatically capitalized as it is entered/edited by the user.

Possible values: "none" | "sentences" | "words" | "characters"

autocapitalize @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.autoCapitalize. View source (Generated from Scala DOM Types 19.0.0)

autoComplete

lazy val autoComplete: HtmlAttr[String]

This attribute indicates whether the value of the control can be automatically completed by the browser. This attribute is ignored if the value of the type attribute is hidden, checkbox, radio, file, or a button type (button, submit, reset, image).

autocomplete @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.autoComplete. View source (Generated from Scala DOM Types 19.0.0)

autoFocus

lazy val autoFocus: HtmlAttr[Boolean]

This Boolean attribute lets you specify that a form control should have input focus when the page loads, unless the user overrides it, for example by typing in a different control. Only one form element in a document can have the autofocus attribute, which is a Boolean. It cannot be applied if the type attribute is set to hidden (that is, you cannot automatically set focus to a hidden control).

autofocus @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.autoFocus. View source (Generated from Scala DOM Types 19.0.0)

charset

lazy val charset: HtmlAttr[String]

Declares the character encoding of the page or script. Used on meta and script elements.

Inherited from scalive.defs.attrs.HtmlAttrs.charset. View source (Generated from Scala DOM Types 19.0.0)

checked

lazy val checked: HtmlAttr[Boolean]

When the value of the type attribute is "radio" or "checkbox", the presence of this Boolean attribute indicates that the control is selected by default; otherwise it is ignored.

Scalive emits the reflected checked HTML attribute.

checkbox#attr-checked @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.checked. View source (Generated from Scala DOM Types 19.0.0)

cols

lazy val cols: HtmlAttr[Int]

The visible width of text input or <textArea>, in average character widths. If it is specified, it must be a positive integer. If it is not specified, the default value is 20 (HTML5).

textarea#attr-cols @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.cols. View source (Generated from Scala DOM Types 19.0.0)

colSpan

lazy val colSpan: HtmlAttr[Int]

This attribute contains a non-negative integer value that indicates for how many columns the cell extends. Its default value is 1; if its value is set to 0, it extends until the end of the <colgroup>, even if implicitly defined, that the cell belongs to. Values higher than 1000 will be considered as incorrect and will be set to the default value (1).

td#attr-colspan @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.colSpan. View source (Generated from Scala DOM Types 19.0.0)

contentAttr

lazy val contentAttr: HtmlAttr[String]

This attribute gives the value associated with the nameAttr or httpEquiv attribute, of a <meta> element, depending on which of those attributes is defined on that element.

meta#attr-content @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.contentAttr. View source (Generated from Scala DOM Types 19.0.0)

contentEditable

lazy val contentEditable: HtmlAttr[Boolean]

Indicates whether the element should be editable by the user. If so, the browser modifies its widget to allow editing.

contentEditable @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.contentEditable. View source (Generated from Scala DOM Types 19.0.0)

contextMenuId

lazy val contextMenuId: HtmlAttr[String]

Specifies a context menu for an element by its element id. The context menu appears when a user right-clicks on the element

contextmenu @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.contextMenuId. View source (Generated from Scala DOM Types 19.0.0)

crossOrigin

lazy val crossOrigin: HtmlAttr[String]

This attribute specifies how the browser should handle cross-origin requests for the associated resource. It controls whether the resource can be loaded when requested from a different domain, and how to handle potential security issues, like CORS (Cross-Origin Resource Sharing) policies. The value of this attribute determines whether the browser will allow or block loading of the resource, helping to enhance web security.

Allowed values: "anonymous" | "use-credentials" | "" (same as "anonymous")

crossorigin @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.crossOrigin. View source (Generated from Scala DOM Types 19.0.0)

dir

lazy val dir: HtmlAttr[String]

Specifies the text direction for the content in an element. The valid values are:

  • ltr Default. Left-to-right text direction

  • rtl Right-to-left text direction

  • auto Let the browser figure out the text direction, based on the content, (only recommended if the text direction is unknown)

dir @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.dir. View source (Generated from Scala DOM Types 19.0.0)

disabled

lazy val disabled: HtmlAttr[Boolean]

This Boolean attribute indicates that the form control is not available for interaction. In particular, the click event will not be dispatched on disabled controls. Also, a disabled control's value isn't submitted with the form.

This attribute is ignored if the value of the type attribute is hidden.

disabled @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.disabled. View source (Generated from Scala DOM Types 19.0.0)

download

lazy val download: HtmlAttr[String]

Prompts the user to save the linked URL instead of navigating to it. Can be used with or without a value:

  • Without a value, the browser will suggest a filename/extension, generated from various sources:

  • The Content-Disposition HTTP header

  • The final segment in the URL path

  • The media type (from the Content-Type header, the start of a data: URL, or Blob.type for a blob: URL)

  • Defining a value suggests it as the filename. / and \ characters are converted to underscores (_). Filesystems may forbid other characters in filenames, so browsers will adjust the suggested name if necessary.

a#attr-download @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.download. View source (Generated from Scala DOM Types 19.0.0)

draggable

lazy val draggable: HtmlAttr[Boolean]

Specifies whether an element is draggable or not

draggable @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.draggable. View source (Generated from Scala DOM Types 19.0.0)

dropZone

lazy val dropZone: HtmlAttr[String]

Specifies whether the dragged data is copied, moved, or linked, when dropped Acceptable values: copy | move | link

Inherited from scalive.defs.attrs.HtmlAttrs.dropZone. View source (Generated from Scala DOM Types 19.0.0)

encType

lazy val encType: HtmlAttr[String]

The enctype attribute provides the encoding type of the form when it is submitted (for forms with a method of "POST").

Only applies to the <form> element

form#attr-enctype @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.encType. View source (Generated from Scala DOM Types 19.0.0)

forId

lazy val forId: HtmlAttr[String]

Describes an element which belongs to this one. Used on labels and output elements.

for @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.forId. View source (Generated from Scala DOM Types 19.0.0)

formAction

lazy val formAction: HtmlAttr[String]

The formaction attribute provides the URL that will process the input control when the form is submitted and overrides the default action attribute of the form element. This should be used only with input elements of type submit or image.

input#formaction @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.formAction. View source (Generated from Scala DOM Types 19.0.0)

formEncType

lazy val formEncType: HtmlAttr[String]

The formenctype attribute provides the encoding type of the form when it is submitted (for forms with a method of "POST") and overrides the default enctype attribute of the form element. This should be used only with the input elements of type "submit" or "image"

Enumerated: "multipart/form-data" | "text/plain" | "application/x-www-form-urlencoded" (default)

input#formenctype @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.formEncType. View source (Generated from Scala DOM Types 19.0.0)

formId

lazy val formId: HtmlAttr[String]

The form attribute specifies an ID of the form an <input> element belongs to.

Inherited from scalive.defs.attrs.HtmlAttrs.formId. View source (Generated from Scala DOM Types 19.0.0)

formMethod

lazy val formMethod: HtmlAttr[String]

The formmethod attribute specifies the HTTP Method the form should use when it is submitted and overrides the default method attribute of the form element. This should be used only with the input elements of type "submit" or "image".

Enumerated: "post" | "get"

input#formmethod @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.formMethod. View source (Generated from Scala DOM Types 19.0.0)

formNoValidate

lazy val formNoValidate: HtmlAttr[Boolean]

The formnovalidate Boolean attribute specifies that the input of the form should not be validated upon submit and overrides the default novalidate attribute of the form. This should only be used with input elements of of type "submit".

input#formnovalidate @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.formNoValidate. View source (Generated from Scala DOM Types 19.0.0)

formTarget

lazy val formTarget: HtmlAttr[String]

The formtarget provides a name or keyword that indicates where to display the response that is received after submitting the form and overrides the target attribute of them form element. This should only be used with the input elements of type "submit" or "image"

Enumerated: "blank" | "parent" | "top" | "self" (default)

input#formtarget @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.formTarget. View source (Generated from Scala DOM Types 19.0.0)

heightAttr

lazy val heightAttr: HtmlAttr[Int]

The height attribute specifies the pixel height of the following elements: <canvas>, <embed>, <iframe>, <img>, <input type="image">, <object>, <video>

object#height @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.heightAttr. View source (Generated from Scala DOM Types 19.0.0)

hidden

lazy val hidden: HtmlAttr[Boolean]

Specifies that an element is not yet, or is no longer, relevant and consequently hidden from view of the user.

hidden @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.hidden. View source (Generated from Scala DOM Types 19.0.0)

high

lazy val high: HtmlAttr[Double]

For use in &lt;meter&gt; tags.

See also

See also

https://css-tricks.com/html5-meter-element/

meter#attr-high @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.high. View source (Generated from Scala DOM Types 19.0.0)

href

lazy val href: HtmlAttr[String]

This is the single required attribute for anchors defining a hypertext source link. It indicates the link target, either a URL or a URL fragment. A URL fragment is a name preceded by a hash mark (#), which specifies an internal target location (an ID) within the current document. URLs are not restricted to Web (HTTP)-based documents. URLs might use any protocol supported by the browser. For example, file, ftp, and mailto work in most user agents.

a#href @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.href. View source (Generated from Scala DOM Types 19.0.0)

httpEquiv

lazy val httpEquiv: HtmlAttr[String]

This enumerated attribute defines the pragma that can alter servers and user-agents behavior. The value of the pragma is defined using the content attribute and can be one of the following:

  • content-language

  • content-type

  • default-style

  • refresh

  • set-cookie

meta#attr-http-equiv @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.httpEquiv. View source (Generated from Scala DOM Types 19.0.0)

idAttr

lazy val idAttr: HtmlAttr[String]

This attribute defines a unique identifier (ID) which must be unique in the whole document. Its purpose is to identify the element when linking (using a fragment identifier), scripting, or styling (with CSS).

id @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.idAttr. View source (Generated from Scala DOM Types 19.0.0)

inputMode

lazy val inputMode: HtmlAttr[String]

The inputmode attribute hints at the type of data that might be entered by the user while editing the element or its contents. This allows a browser to display an appropriate virtual keyboard.

Acceptable values: none | text (default value) | decimal | numeric | tel | search | email | url

inputmode @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.inputMode. View source (Generated from Scala DOM Types 19.0.0)

labelAttr

lazy val labelAttr: HtmlAttr[String]

For optgroup elements, specifies the name of the group of options, which the browser can use when labeling the options in the user interface.

Inherited from scalive.defs.attrs.HtmlAttrs.labelAttr. View source (Generated from Scala DOM Types 19.0.0)

lang

lazy val lang: HtmlAttr[String]

This attribute participates in defining the language of the element, the language that non-editable elements are written in or the language that editable elements should be written in. The tag contains one single entry value in the format defines in the Tags for Identifying Languages (BCP47) IETF document. If the tag content is the empty string the language is set to unknown; if the tag content is not valid, regarding to BCP47, it is set to invalid.

lang @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.lang. View source (Generated from Scala DOM Types 19.0.0)

listId

lazy val listId: HtmlAttr[String]

Identifies a list of pre-defined options to suggest to the user. The value must be the id of a dataList element in the same document. The browser displays only options that are valid values for this input element. This attribute is ignored when the type attribute's value is hidden, checkbox, radio, file, or a button type.

Inherited from scalive.defs.attrs.HtmlAttrs.listId. View source (Generated from Scala DOM Types 19.0.0)

loadingAttr

lazy val loadingAttr: HtmlAttr[String]

Indicates how the browser should load the image:

"eager": Loads the image immediately, regardless of whether or not the image is currently within the visible viewport (this is the default value).

"lazy": Defers loading the image until it reaches a calculated distance from the viewport, as defined by the browser. The intent is to avoid the network and storage bandwidth needed to handle the image until it's reasonably certain that it will be needed. This generally improves the performance of the content in most typical use cases.

Inherited from scalive.defs.attrs.HtmlAttrs.loadingAttr. View source (Generated from Scala DOM Types 19.0.0)

low

lazy val low: HtmlAttr[Double]

For use in &lt;meter&gt; tags.

See also

See also

https://css-tricks.com/html5-meter-element/

meter#attr-low @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.low. View source (Generated from Scala DOM Types 19.0.0)

maxAttr

lazy val maxAttr: HtmlAttr[String]

The max attribute specifies the maximum value for an <input> element of type number, range, date, datetime, datetime-local, month, time, or week.

max @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.maxAttr. View source (Generated from Scala DOM Types 19.0.0)

maxLength

lazy val maxLength: HtmlAttr[Int]

Specifies the maximum number of characters accepted by a compatible form control. Browsers enforce the limit during editing and expose constraint-validation state when applicable.

maxlength @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.maxLength. View source (Generated from Scala DOM Types 19.0.0)

media

lazy val media: HtmlAttr[String]

This attribute specifies the media which the linked resource applies to. Its value must be a media query. This attribute is mainly useful when linking to external stylesheets by allowing the user agent to pick the best adapted one for the device it runs on.

link#attr-media @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.media. View source (Generated from Scala DOM Types 19.0.0)

method

lazy val method: HtmlAttr[String]

The HTTP method that the browser uses to submit the form. Possible values are:

  • post: Corresponds to the HTTP POST method ; form data are included in the body of the form and sent to the server.

  • get: Corresponds to the HTTP GET method; form data are appended to the action attribute URI with a '?' as a separator, and the resulting URI is sent to the server. Use this method when the form has no side-effects and contains only ASCII characters.

This value can be overridden by a formmethod attribute on a button or input element.

form#attr-method @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.method. View source (Generated from Scala DOM Types 19.0.0)

minAttr

lazy val minAttr: HtmlAttr[String]

The min attribute specifies the minimum value for an <input> element of type number, range, date, datetime, datetime-local, month, time, or week.

min @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.minAttr. View source (Generated from Scala DOM Types 19.0.0)

minLength

lazy val minLength: HtmlAttr[Int]

If the type of the input element is text, email, search, password, tel, or url, this attribute specifies the minimum number of characters (in Unicode code points) that the user can enter. For other control types, it is ignored.

minlength @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.minLength. View source (Generated from Scala DOM Types 19.0.0)

multiple

lazy val multiple: HtmlAttr[Boolean]

This Boolean attribute specifies, when present/true, that the user is allowed to enter more than one value for the <input> element for types "email" or "file". It can also be provided to the <select> element to allow selecting more than one option.

input#multiple @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.multiple. View source (Generated from Scala DOM Types 19.0.0)

nameAttr

lazy val nameAttr: HtmlAttr[String]

On form elements (input etc.): Name of the element. For example used by the server to identify the fields in form submits.

On the meta tag: This attribute defines the name of a document-level metadata. This document-level metadata name is associated with a value, contained by the content attribute.

input#name @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.nameAttr. View source (Generated from Scala DOM Types 19.0.0)

noValidate

lazy val noValidate: HtmlAttr[Boolean]

This Boolean attribute indicates that the form is not to be validated when submitted. If this attribute is not specified (and therefore the form is validated), this default setting can be overridden by a formnovalidate attribute on a <button> or <input> element belonging to the form.

form#attr-novalidate @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.noValidate. View source (Generated from Scala DOM Types 19.0.0)

optimum

lazy val optimum: HtmlAttr[Double]

For use in &lt;meter&gt; tags.

See also

See also

https://css-tricks.com/html5-meter-element/

meter#attr-optimum @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.optimum. View source (Generated from Scala DOM Types 19.0.0)

pattern

lazy val pattern: HtmlAttr[String]

Specifies a regular expression to validate the input. The pattern attribute works with the following input types: text, search, url, tel, email, and password. Use the title attribute to describe the pattern to the user.

pattern @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.pattern. View source (Generated from Scala DOM Types 19.0.0)

placeholder

lazy val placeholder: HtmlAttr[String]

A hint to the user of what can be entered in the control. The placeholder text must not contain carriage returns or line-feeds. This attribute applies when the value of the type attribute is text, search, tel, url or email; otherwise it is ignored.

input#placeholder @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.placeholder. View source (Generated from Scala DOM Types 19.0.0)

readOnly

lazy val readOnly: HtmlAttr[Boolean]

This Boolean attribute indicates that the user cannot modify the value of the control. This attribute is ignored if the value of the type attribute is hidden, range, color, checkbox, radio, file, or a button type.

readonly @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.readOnly. View source (Generated from Scala DOM Types 19.0.0)

required

lazy val required: HtmlAttr[Boolean]

This attribute specifies that the user must fill in a value before submitting a form. It cannot be used when the type attribute is hidden, image, or a button type (submit, reset, or button). The :optional and :required CSS pseudo-classes will be applied to the field as appropriate.

required @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.required. View source (Generated from Scala DOM Types 19.0.0)

rows

lazy val rows: HtmlAttr[Int]

The number of visible text lines for a text control.

textarea#attr-rows @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.rows. View source (Generated from Scala DOM Types 19.0.0)

rowSpan

lazy val rowSpan: HtmlAttr[Int]

This attribute contains a non-negative integer value that indicates for how many rows the cell extends. Its default value is 1; if its value is set to 0, it extends until the end of the table section (<thead>, <tbody>, <tfoot>, even if implicitly defined, that the cell belongs to. Values higher than 65534 are clipped down to 65534.

td#attr-rowspan @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.rowSpan. View source (Generated from Scala DOM Types 19.0.0)

scoped

lazy val scoped: HtmlAttr[Boolean]

Defines the obsolete scoped attribute for a <style> element. Current browsers do not implement scoped-style behavior; use ordinary CSS scoping instead.

scoped @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.scoped. View source (Generated from Scala DOM Types 19.0.0)

selected

lazy val selected: HtmlAttr[Boolean]

Indicates whether this <option> is initially selected in an option list of a <select> element.

Scalive emits the reflected selected HTML attribute.

option#attr-selected @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.selected. View source (Generated from Scala DOM Types 19.0.0)

size

lazy val size: HtmlAttr[Int]

The initial size of the control. This value is in pixels unless the value of the type attribute is text or password, in which case, it is an integer number of characters. Starting in HTML5, this attribute applies only when the type attribute is set to text, search, tel, url, email, or password; otherwise it is ignored. In addition, the size must be greater than zero. If you don't specify a size, a default value of 20 is used.

size @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.size. View source (Generated from Scala DOM Types 19.0.0)

slot

lazy val slot: HtmlAttr[String]

The slot global attribute assigns a slot in a shadow DOM shadow tree to an element.

MDN – https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/slot

slot @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.slot. View source (Generated from Scala DOM Types 19.0.0)

spellCheck

lazy val spellCheck: HtmlAttr[Boolean]

Defines whether the element may be checked for spelling errors.

MDN – https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/spellcheck

spellcheck @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.spellCheck. View source (Generated from Scala DOM Types 19.0.0)

src

lazy val src: HtmlAttr[String]

Specifies the URL of an image for <img> tag, for type="image" input buttons, or the URL of some other network resources like <iframe>.

Inherited from scalive.defs.attrs.HtmlAttrs.src. View source (Generated from Scala DOM Types 19.0.0)

stepAttr

lazy val stepAttr: HtmlAttr[String]

The step attribute specifies the numeric intervals for an <input> element that should be considered legal for the input. For example, if step is 2 on a number typed <input> then the legal numbers could be -2, 0, 2, 4, 6 etc. The step attribute should be used in conjunction with the min and max attributes to specify the full range and interval of the legal values. The step attribute is applicable to <input> elements of the following types: number, range, date, datetime, datetime-local, month, time and week.

step @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.stepAttr. View source (Generated from Scala DOM Types 19.0.0)

tabIndex

lazy val tabIndex: HtmlAttr[Int]

This integer attribute indicates if the element can take input focus (is focusable), if it should participate to sequential keyboard navigation, and if so, at what position. It can takes several values:

  • a negative value means that the element should be focusable, but should not be reachable via sequential keyboard navigation;

  • 0 means that the element should be focusable and reachable via sequential keyboard navigation, but its relative order is defined by the platform convention;

  • a positive value which means should be focusable and reachable via sequential keyboard navigation; its relative order is defined by the value of the attribute: the sequential follow the increasing number of the tabindex. If several elements share the same tabindex, their relative order follows their relative position in the document).

An element with a 0 value, an invalid value, or no tabindex value should be placed after elements with a positive tabindex in the sequential keyboard navigation order.

tabindex @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.tabIndex. View source (Generated from Scala DOM Types 19.0.0)

target

lazy val target: HtmlAttr[String]

A name or keyword indicating where to display the response that is received after submitting the form. In HTML 4, this is the name of, or a keyword for, a frame. In HTML5, it is a name of, or keyword for, a browsing context (for example, tab, window, or inline frame). The following keywords have special meanings:

  • _self: Load the response into the same HTML 4 frame (or HTML5 browsing context) as the current one. This value is the default if the attribute is not specified.

  • _blank: Load the response into a new unnamed HTML 4 window or HTML5 browsing context.

  • _parent: Load the response into the HTML 4 frameset parent of the current frame or HTML5 parent browsing context of the current one. If there is no parent, this option behaves the same way as _self.

  • _top: HTML 4: Load the response into the full, original window, canceling all other frames. HTML5: Load the response into the top-level browsing context (that is, the browsing context that is an ancestor of the current one, and has no parent). If there is no parent, this option behaves the same way as _self.

  • iframename: The response is displayed in a named iframe.

a#attr-target @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.target. View source (Generated from Scala DOM Types 19.0.0)

title

lazy val title: HtmlAttr[String]

This attribute contains a text representing advisory information related to the element it belongs too. Such information can typically, but not necessarily, be presented to the user as a tooltip.

title @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.title. View source (Generated from Scala DOM Types 19.0.0)

tpe

lazy val tpe: HtmlAttr[String]

Alias for the type member defining the type HTML attribute.

Inherited from scalive.defs.attrs.HtmlAttrs.tpe. View source (Generated from Scala DOM Types 19.0.0)

translate

lazy val translate: HtmlAttr[Boolean]

Specifies whether the content of an element should be translated or not

translate @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.translate. View source (Generated from Scala DOM Types 19.0.0)

typ

lazy val typ: HtmlAttr[String]

Alias for the type member defining the type HTML attribute.

Inherited from scalive.defs.attrs.HtmlAttrs.typ. View source (Generated from Scala DOM Types 19.0.0)

type

lazy val type: HtmlAttr[String]

This attribute has several meanings depending on what element it's applied to. It could indicate the type of a button, an input, a script, a stylesheet, etc.

Aliases: typ, tpe

Inherited from scalive.defs.attrs.HtmlAttrs.type. View source (Generated from Scala DOM Types 19.0.0)

unselectable

lazy val unselectable: HtmlAttr[Boolean]

IE-specific property to prevent user selection

Inherited from scalive.defs.attrs.HtmlAttrs.unselectable. View source (Generated from Scala DOM Types 19.0.0)

value

lazy val value: HtmlAttr[String]

The initial value of the control. This attribute is optional except when the value of the type attribute is radio or checkbox.

Scalive emits the reflected value HTML attribute.

input#value @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.value. View source (Generated from Scala DOM Types 19.0.0)

widthAttr

lazy val widthAttr: HtmlAttr[Int]

The width attribute specifies the pixel width of the following elements: <canvas>, <embed>, <iframe>, <img>, <input type="image">, <object>, <video>

object#width @ MDN

Inherited from scalive.defs.attrs.HtmlAttrs.widthAttr. View source (Generated from Scala DOM Types 19.0.0)

xmlns

lazy val xmlns: HtmlAttr[String]

Specifies XML namespace for the document

Inherited from scalive.defs.attrs.HtmlAttrs.xmlns. View source (Generated from Scala DOM Types 19.0.0)

DOM helpers6

dataAttr

def dataAttr(suffix: String): HtmlAttr[String]

Creates a custom data-* string attribute from suffix.

The suffix is appended verbatim and the resulting attribute name receives only generic HtmlAttr validation; it is not lowercased or otherwise normalized. Callers remain responsible for data-* naming rules. In particular, use a non-empty lowercase suffix that does not start with xml (case-insensitive) or contain a colon. Kebab-case supports standard HTMLElement.dataset mapping: for example, dataAttr("test-value") is exposed as element.dataset.testValue in JavaScript.

Throws

IllegalArgumentException

if the resulting HTML attribute name is invalid

Inherited from scalive.defs.complex.ComplexHtmlKeys.dataAttr. View source (scalive/api/src/scalive/defs/complex/ComplexHtmlKeys.scala:49-49)

className

val className: HtmlAttr[String]

Defines the element's space-separated CSS classes.

The value is emitted as the HTML class attribute without parsing or normalization.

Inherited from scalive.defs.complex.ComplexHtmlKeys.className. View source (scalive/api/src/scalive/defs/complex/ComplexHtmlKeys.scala:15-15)

cls

val cls: HtmlAttr[String]

Concise alias for className.

Inherited from scalive.defs.complex.ComplexHtmlKeys.cls. View source (scalive/api/src/scalive/defs/complex/ComplexHtmlKeys.scala:18-18)

rel

lazy val rel: HtmlAttr[String]

Defines the space-separated relationship types of a linked resource.

For example, a stylesheet link uses rel := "stylesheet". Values are emitted without parsing or normalization.

Inherited from scalive.defs.complex.ComplexHtmlKeys.rel. View source (scalive/api/src/scalive/defs/complex/ComplexHtmlKeys.scala:25-25)

role

lazy val role: HtmlAttr[String]

Defines the accessibility role of the current element.

Prefer an HTML element with the required native semantics when one exists; use role only when additional semantics are necessary. The value is emitted without validating ARIA role names.

See: s_role_module_attributes

Inherited from scalive.defs.complex.ComplexHtmlKeys.role. View source (scalive/api/src/scalive/defs/complex/ComplexHtmlKeys.scala:35-35)

styleAttr

lazy val styleAttr: HtmlAttr[String]

Defines inline CSS declarations through the HTML style attribute.

The declaration string is emitted without CSS parsing or sanitization. Prefer classes and a stylesheet for reusable styles, and do not interpolate untrusted CSS.

Inherited from scalive.defs.complex.ComplexHtmlKeys.styleAttr. View source (scalive/api/src/scalive/defs/complex/ComplexHtmlKeys.scala:56-56)

Types32

AsyncKey

opaque type AsyncKey >: ([A] =>> Nothing) <: ([A] =>> Any) = ([A] =>> String)

A nominal key that associates an asynchronous task name with its result type.

Passing AsyncKey[A] to an async context requires a task producing A. Within one connected LiveView or LiveComponent instance, starting the same key again replaces the previous task and suppresses its completion. The key is invariant in A, preventing accidental widening of its result type.

Type parameters

A

the result produced by the keyed task

Defined by scalive.AsyncKey. View source (scalive/api/src/scalive/AsyncKey.scala:13-13)

BrowserToServerEvent

opaque type BrowserToServerEvent >: ([A] =>> Nothing) <: ([A] =>> Any) = ([A] =>> String)

A named event pushed from browser JavaScript to the server with a typed JSON payload.

Register this event with a LiveView or LiveComponent onBrowserEvent hook. Registration requires a zio.json.JsonDecoder[A]; matching payloads are decoded before the handler runs. A malformed matching payload is logged and consumed without changing the model. Root handlers ignore events targeted at a component. The type is invariant in A, so an event cannot be widened to a different payload contract.

Type parameters

A

the payload expected from the browser

Defined by scalive.BrowserToServerEvent. View source (scalive/api/src/scalive/BrowserEvent.scala:48-48)

CompletedUpload

type CompletedUpload = ([Result] =>> upload.CompletedUpload[Result])

Exported from scalive.CompletedUpload. View source (scalive/api/src/scalive/Scalive.scala:13-13)

ComponentRef

opaque type ComponentRef >: ([Msg] =>> Nothing) <: ([Msg] =>> Any) = ([Msg] =>> ComponentTarget)

Defined by scalive.ComponentRef. View source (scalive/api/src/scalive/lifecycle/LiveComponent.scala:118-118)

ConsumeDecision

type ConsumeDecision = ([A] =>> upload.ConsumeDecision[A])

Defined by scalive.ConsumeDecision. View source (scalive/api/src/scalive/Scalive.scala:13-13)

DomRef

opaque type DomRef = String

A reusable, validated HTML id value which can also produce its exact CSS selector.

Construct references with apply. Values are nominal: a raw String cannot be used as a DomRef or DomSelector.

Defined by scalive.DomRef. View source (scalive/api/src/scalive/DomRef.scala:10-10)

DomSelector

opaque type DomSelector = Option[String]

A nominal DOM selection used by JS commands and DOM-targeting APIs.

Use css for an explicit CSS selector or current where an API supports its current/source element. Raw strings are deliberately not accepted.

Defined by scalive.DomSelector. View source (scalive/api/src/scalive/DomRef.scala:59-59)

ExternalUploadClientConfig

type ExternalUploadClientConfig = upload.api.ExternalUploadClientConfig

Defined by scalive.ExternalUploadClientConfig. View source (scalive/api/src/scalive/Scalive.scala:13-13)

FlashKind

opaque type FlashKind = String

A nominal key for one category of flash message.

The same kind is used to put, retrieve, clear, render, and transfer a flash message across navigation. Distinct declared values keep application flash categories explicit and prevent accidental use of unrelated string identifiers.

Defined by scalive.FlashKind. View source (scalive/api/src/scalive/FlashKind.scala:9-9)

Key

opaque type Key = String

A nominal browser keyboard-event key value used to filter key bindings.

Values correspond to KeyboardEvent.key, including its exact spelling and case. Construct uncommon values with apply or use the constants in Key.

Defined by scalive.Key. View source (scalive/api/src/scalive/Key.scala:8-8)

LiveExternalUploadResult

type LiveExternalUploadResult = ([Result] =>> upload.LiveExternalUploadResult[Result])

Defined by scalive.LiveExternalUploadResult. View source (scalive/api/src/scalive/Scalive.scala:13-13)

LiveStream

type LiveStream = ([A] =>> streams.LiveStream[A])

Defined by scalive.LiveStream. View source (scalive/api/src/scalive/Scalive.scala:12-12)

LiveStreamDef

type LiveStreamDef = ([A, Id] =>> streams.LiveStreamDef[A, Id])

Defined by scalive.LiveStreamDef. View source (scalive/api/src/scalive/Scalive.scala:12-12)

LiveUpload

type LiveUpload = ([Result] =>> upload.LiveUpload[Result])

Exported from scalive.LiveUpload. View source (scalive/api/src/scalive/Scalive.scala:13-13)

LiveUploadAbortReason

type LiveUploadAbortReason = upload.api.LiveUploadAbortReason

Defined by scalive.LiveUploadAbortReason. View source (scalive/api/src/scalive/Scalive.scala:13-13)

LiveUploadAccept

type LiveUploadAccept = upload.api.LiveUploadAccept

Defined by scalive.LiveUploadAccept. View source (scalive/api/src/scalive/Scalive.scala:13-13)

LiveUploadDef

type LiveUploadDef = ([Result] =>> upload.LiveUploadDef[Result])

Defined by scalive.LiveUploadDef. View source (scalive/api/src/scalive/Scalive.scala:13-13)

LiveUploadDestination

type LiveUploadDestination = ([Result] =>> upload.LiveUploadDestination[Result])

Defined by scalive.LiveUploadDestination. View source (scalive/api/src/scalive/Scalive.scala:13-13)

LiveUploadEntry

type LiveUploadEntry = ([Result] =>> upload.LiveUploadEntry[Result])

Exported from scalive.LiveUploadEntry. View source (scalive/api/src/scalive/Scalive.scala:13-13)

LiveUploadEntryStatus

type LiveUploadEntryStatus = upload.api.LiveUploadEntryStatus

Defined by scalive.LiveUploadEntryStatus. View source (scalive/api/src/scalive/Scalive.scala:13-13)

LiveUploadError

type LiveUploadError = upload.api.LiveUploadError

Defined by scalive.LiveUploadError. View source (scalive/api/src/scalive/Scalive.scala:13-13)

LiveUploadExternalUploader

type LiveUploadExternalUploader = ([Result] =>> upload.LiveUploadExternalUploader[Result])

Exported from scalive.LiveUploadExternalUploader. View source (scalive/api/src/scalive/Scalive.scala:13-13)

LiveUploadOperationError

type LiveUploadOperationError = upload.api.LiveUploadOperationError

Defined by scalive.LiveUploadOperationError. View source (scalive/api/src/scalive/Scalive.scala:13-13)

LiveUploadProgress

type LiveUploadProgress = ([Result] =>> upload.LiveUploadProgress[Result])

Exported from scalive.LiveUploadProgress. View source (scalive/api/src/scalive/Scalive.scala:13-13)

LiveUploadWriter

type LiveUploadWriter = ([State, Result] =>> upload.LiveUploadWriter[State, Result])

Exported from scalive.LiveUploadWriter. View source (scalive/api/src/scalive/Scalive.scala:13-13)

ServerToBrowserEvent

opaque type ServerToBrowserEvent >: ([A] =>> Nothing) <: ([A] =>> Any) = ([A] =>> String)

A named event pushed from the server to the browser with a typed JSON payload.

Pass this event and an A to ctx.client.push; a zio.json.JsonEncoder[A] is required and an encoding error fails the returned Task. Browser JavaScript subscribes to the stored string name and interprets the encoded payload. The type is invariant in A, so an event cannot be widened to a different payload contract.

Type parameters

A

the payload pushed to the browser

Defined by scalive.ServerToBrowserEvent. View source (scalive/api/src/scalive/BrowserEvent.scala:24-24)

StreamAt

type StreamAt = streams.api.StreamAt

Defined by scalive.StreamAt. View source (scalive/api/src/scalive/Scalive.scala:12-12)

StreamLimit

type StreamLimit = streams.api.StreamLimit

Defined by scalive.StreamLimit. View source (scalive/api/src/scalive/Scalive.scala:12-12)

SubscriptionKey

opaque type SubscriptionKey = String

A nominal runtime key for one managed LiveView subscription.

A subscription key names a stream within its owning LiveView lifecycle. In a connected lifecycle, starting an already active key fails, replacing a key swaps its stream, and cancelling an absent key is a no-op. Connected subscription operations reject empty names.

Defined by scalive.SubscriptionKey. View source (scalive/api/src/scalive/SubscriptionKey.scala:9-9)

UploadClientMetadata

type UploadClientMetadata = upload.api.UploadClientMetadata

Exported from scalive.UploadClientMetadata. View source (scalive/api/src/scalive/Scalive.scala:13-13)

UploadEntryRef

type UploadEntryRef = upload.api.UploadEntryRef

Defined by scalive.UploadEntryRef. View source (scalive/api/src/scalive/Scalive.scala:13-13)

UploadRef

type UploadRef = upload.api.UploadRef

Defined by scalive.UploadRef. View source (scalive/api/src/scalive/Scalive.scala:13-13)