Skip to content
scalive
Menu
ConnectingLiveReconnectingOffline
GitHub
c

FormPath

class FormPath

A structured form field path rendered with browser bracket notation.

This is a wire/rendering path and may contain array segments. Use FormAddress for stable, owner-scoped validation identity, especially inside repeated rows.

Defined by scalive.FormPath. View source (scalive/api/src/scalive/forms/FormPath.scala:16-76)

Methods8

/

def /(segment: String): FormPath

Appends a trusted literal name segment.

This constructor is intended for application-defined names. Invalid literal names fail fast; use parse for untrusted browser input.

Defined by scalive.FormPath./. View source (scalive/api/src/scalive/forms/FormPath.scala:24-25)

array

def array: FormPath

Appends an explicit array segment.

Defined by scalive.FormPath.array. View source (scalive/api/src/scalive/forms/FormPath.scala:28-31)

id

def id: String

Returns an injective, ASCII-only DOM id for this path.

Name segments are encoded as UTF-16 code units and array segments have a distinct marker. The fp prefix also ensures that non-empty ids begin with an ASCII letter.

Defined by scalive.FormPath.id. View source (scalive/api/src/scalive/forms/FormPath.scala:56-68)

isEmpty

def isEmpty: Boolean

Whether this path has no segments.

Defined by scalive.FormPath.isEmpty. View source (scalive/api/src/scalive/forms/FormPath.scala:34-34)

name

def name: String

Renders this path as a browser field name, such as user[address][city].

Defined by scalive.FormPath.name. View source (scalive/api/src/scalive/forms/FormPath.scala:40-49)

nonEmpty

def nonEmpty: Boolean

Whether this path has at least one segment.

Defined by scalive.FormPath.nonEmpty. View source (scalive/api/src/scalive/forms/FormPath.scala:37-37)

startsWith

def startsWith(prefix: FormPath): Boolean

Whether this path begins with exactly the same segments as prefix.

Defined by scalive.FormPath.startsWith. View source (scalive/api/src/scalive/forms/FormPath.scala:71-72)

toString

def toString: String

Returns name.

Defined by scalive.FormPath.toString. View source (scalive/api/src/scalive/forms/FormPath.scala:75-75)

Values1

segments

val segments: Vector[FormPathSegment]

Defined by scalive.FormPath.segments. View source (scalive/api/src/scalive/forms/FormPath.scala:16-16)