Class default`Internal`

Index

Constructors

Properties

el id isDead liveSocket portalElementIds root

Methods

ackJoin addHook afterElementsRemoved all applyDiff applyJoinPatch applyPendingUpdates attachTrueDocEl bindChannel binding cancelSubmit closestComponentID componentID componentPatch connectParams delayedDisconnected destroy destroyAllChildren destroyDescendent destroyHook destroyPortalElements disableForm dispatchUploads displayError dropPendingRefs dropPortalElementId eachChild execAll execNewMounted expandURL extractMeta getChildById getDescendentByEl getFormsForRecovery getHook getScheduledSubmit getSession getStatic handleFailedEntryPreflight hideLoader isAcked isConnected isDestroyed isJoinPending isMain join joinChild joinDead joinNewChildren log logError maybeAddNewHook maybeMounted maybePushComponentsDestroyed maybeRecoverForms onAllChildJoinsComplete onChannel onClose onError onJoin onJoinComplete onJoinError onLivePatch onLiveRedirect onRedirect ownsElement performPatch pushEvent pushFileProgress pushFormRecovery pushFormSubmit pushHookEvent pushInput pushLinkPatch pushPortalElementId pushWithReply putRef refSrc renderContainer scheduleSubmit serializeForm setContainerClasses setHref setRedirect showLoader submitForm targetComponentID targetCtxElement transition triggerAwaitingSubmit triggerBeforeUpdateHook triggerReconnected undoElRef undoRefs update uploadFiles withinTargets wrapPush closestView

Constructors

constructor

new default(
    el: Element,
    liveSocket: LiveSocket,
    parentView: default,
    flash?: string,
    liveReferer?: string,
): default
Parameters
- el: Element
- liveSocket: LiveSocket
- parentView: default
- flash: string = null
- liveReferer: string = null
Returns default
- Defined in view.ts:127

Properties

el

el: Element

id

id: string

isDead

isDead: boolean

liveSocket

liveSocket: LiveSocket

portalElementIds

portalElementIds: Set<string>

root

Methods

ackJoin

ackJoin(_child: any): void
Parameters
- _child: any
Returns void
- Defined in view.ts:897

addHook

addHook(el: any): any
Parameters
- el: any
Returns any
- Defined in view.ts:999

afterElementsRemoved

afterElementsRemoved(elements: any, pruneCids: any): void
Parameters
- elements: any
- pruneCids: any
Returns void
- Defined in view.ts:735

all

all(parent: any, selector: any, callback: any): void
Parameters
- parent: any
- selector: any
- callback: any
Returns void
- Defined in view.ts:608

applyDiff

applyDiff(type: "update" | "mount", rawDiff: any, callback: any): void
Parameters
- type: "update" | "mount"
- rawDiff: any
- callback: any
Returns void
- Defined in view.ts:411

applyJoinPatch

applyJoinPatch(live_patch: any, html: any, streams: any, events: any): void
Parameters
- live_patch: any
- html: any
- streams: any
- events: any
Returns void
- Defined in view.ts:616

applyPendingUpdates

applyPendingUpdates(): void
Returns void
- Defined in view.ts:1114

attachTrueDocEl

attachTrueDocEl(): void
Returns void
- Defined in view.ts:564

bindChannel

bindChannel(): void
Returns void
- Defined in view.ts:1150

binding

binding(kind: any): string
Parameters
- kind: any
Returns string
- Defined in view.ts:2683

cancelSubmit

cancelSubmit(formEl: any, phxEvent: any): void
Parameters
- formEl: any
- phxEvent: any
Returns void
- Defined in view.ts:2129

closestComponentID

closestComponentID(targetCtx: any): any
Parameters
- targetCtx: any
Returns any
- Defined in view.ts:1727

componentID

componentID(el: any): number
Parameters
- el: any
Returns number
- Defined in view.ts:1704

componentPatch

componentPatch(diff: any, cid: any): boolean
Parameters
- diff: any
- cid: any
Returns boolean
- Defined in view.ts:987

connectParams

connectParams(liveReferer: any): Record<string, unknown>
Parameters
- liveReferer: any
Returns Record<string, unknown>
- Defined in view.ts:228

delayedDisconnected

delayedDisconnected(): void
Returns void
- Defined in view.ts:1399

destroy

destroy(callback?: () => void): void
Parameters
- callback: () => void = ...
Returns void
- Defined in view.ts:261

destroyAllChildren

destroyAllChildren(): void
Returns void
- Defined in view.ts:1169

destroyDescendent

destroyDescendent(id: any): void
Parameters
- id: any
Returns void
- Defined in view.ts:872

destroyHook

destroyHook(hook: any): void
Parameters
- hook: any
Returns void
- Defined in view.ts:1105

destroyPortalElements

destroyPortalElements(): void
Returns void
- Defined in view.ts:2696

disableForm

disableForm(
    formEl: HTMLFormElement,
    phxEvent: string,
    opts?: {},
): (number | Element[] | { [key: string]: any })[]
Parameters
- formEl: HTMLFormElement
- phxEvent: string
- opts: {} = {}
Returns (number | Element[] | { [key: string]: any })[]
- Defined in view.ts:2142

dispatchUploads

dispatchUploads(targetCtx: any, name: any, filesOrBlobs: any): void
Parameters
- targetCtx: any
- name: any
- filesOrBlobs: any
Returns void
- Defined in view.ts:2390

displayError

displayError(classes: any, details?: {}): void
Parameters
- classes: any
- details: {} = {}
Returns void
- Defined in view.ts:1388

dropPendingRefs

dropPendingRefs(): void
Returns void
- Defined in view.ts:510

dropPortalElementId

dropPortalElementId(id: any): void
Parameters
- id: any
Returns void
- Defined in view.ts:2692

eachChild

eachChild(callback: any): void
Parameters
- callback: any
Returns void
- Defined in view.ts:1124

execAll

execAll(binding: any): void
Parameters
- binding: any
Returns void
- Defined in view.ts:317

execNewMounted

execNewMounted(parent?: Document): void
Parameters
- parent: Document = document
Returns void
- Defined in view.ts:580

expandURL

expandURL(to: any): any
Parameters
- to: any
Returns any
- Defined in view.ts:1188

extractMeta

extractMeta(el: any, meta: any, value: any): any
Parameters
- el: any
- meta: any
- value: any
Returns any
- Defined in view.ts:1797

getChildById

getChildById(id: any): default
Parameters
- id: any
Returns default
- Defined in view.ts:858

getDescendentByEl

getDescendentByEl(el: any): default
Parameters
- el: any
Returns default
- Defined in view.ts:862

getFormsForRecovery

getFormsForRecovery(): {}
Returns {}
- Defined in view.ts:2531

getHook

getHook(el: any): ViewHook<HTMLElement>
Parameters
- el: any
Returns ViewHook<HTMLElement>
- Defined in view.ts:995

getScheduledSubmit

getScheduledSubmit(formEl: any): any
Parameters
- formEl: any
Returns any
- Defined in view.ts:2116

getSession

getSession(): string
Returns string
- Defined in view.ts:252

getStatic

getStatic(): string
Returns string
- Defined in view.ts:256

handleFailedEntryPreflight

handleFailedEntryPreflight(uploadRef: any, reason: any, uploader: any): void
Parameters
- uploadRef: any
- reason: any
- uploader: any
Returns void
- Defined in view.ts:2372

hideLoader

hideLoader(): void
Returns void
- Defined in view.ts:323

isAcked

isAcked(ref: any): boolean
Parameters
- ref: any
Returns boolean
- Defined in view.ts:1700

isConnected

isConnected(): any
Returns any
- Defined in view.ts:247

isDestroyed

isDestroyed(): boolean
Returns boolean
- Defined in view.ts:1206

isJoinPending

isJoinPending(): boolean
Returns boolean
- Defined in view.ts:893

isMain

isMain(): boolean
Returns boolean
- Defined in view.ts:224

join

join(callback?: any): void
Parameters
- Optionalcallback: any
Returns void
- Defined in view.ts:1214

joinChild

joinChild(el: any): boolean
Parameters
- el: any
Returns boolean
- Defined in view.ts:882

joinDead

joinDead(): void
Returns void
- Defined in view.ts:1210

joinNewChildren

joinNewChildren(): void
Returns void
- Defined in view.ts:769

log

log(
    kind: string,
    msgCallback: () => [string, unknown] | [string],
    diagnostic?: {
        code: string;
        context?: LiveViewDiagnosticContext;
        level?: LiveViewDiagnosticLevel;
        metadata?: () => LiveViewDiagnosticMetadata;
    },
): void
Parameters
- kind: string
- msgCallback: () => [string, unknown] | [string]
- Optionaldiagnostic: {
      code: string;
      context?: LiveViewDiagnosticContext;
      level?: LiveViewDiagnosticLevel;
      metadata?: () => LiveViewDiagnosticMetadata;
  }
Returns void
- Defined in view.ts:336

logError

logError(
    code: string,
    message: string,
    metadata: Record<string, unknown>,
    context?: LiveViewDiagnosticContext,
): void
Parameters
- code: string
- message: string
- metadata: Record<string, unknown>
- context: LiveViewDiagnosticContext = ...
Returns void
- Defined in view.ts:349

maybeAddNewHook

maybeAddNewHook(el: any): void
Parameters
- el: any
Returns void
- Defined in view.ts:670

maybeMounted

maybeMounted(el: any): void
Parameters
- el: any
Returns void
- Defined in view.ts:661

maybePushComponentsDestroyed

maybePushComponentsDestroyed(destroyedCIDs: any): void
Parameters
- destroyedCIDs: any
Returns void
- Defined in view.ts:2611

maybeRecoverForms

maybeRecoverForms(html: any, callback: any): any
Parameters
- html: any
- callback: any
Returns any
- Defined in view.ts:773

onAllChildJoinsComplete

onAllChildJoinsComplete(): void
Returns void
- Defined in view.ts:909

onChannel

onChannel(event: any, cb: any): void
Parameters
- event: any
- cb: any
Returns void
- Defined in view.ts:1131

onClose

onClose(reason: any): void
Parameters
- reason: any
Returns void
- Defined in view.ts:1345

onError

onError(reason: any): void
Parameters
- reason: any
Returns void
- Defined in view.ts:1363

onJoin

onJoin(resp: any): void
Parameters
- resp: any
Returns void
- Defined in view.ts:451

onJoinComplete

onJoinComplete(
    __namedParameters: { live_patch: any },
    html: any,
    streams: any,
    events: any,
): void
Parameters
- __namedParameters: { live_patch: any }
- html: any
- streams: any
- events: any
Returns void
- Defined in view.ts:518

onJoinError

onJoinError(resp: any): void
Parameters
- resp: any
Returns void
- Defined in view.ts:1235

onLivePatch

onLivePatch(redir: any): void
Parameters
- redir: any
Returns void
- Defined in view.ts:1182

onLiveRedirect

onLiveRedirect(redir: any): void
Parameters
- redir: any
Returns void
- Defined in view.ts:1173

onRedirect

onRedirect(
__namedParameters: { flash?: string; reloadToken?: string; to: string },
): void
Parameters
- __namedParameters: { flash?: string; reloadToken?: string; to: string }
Returns void
- Defined in view.ts:1194

ownsElement

ownsElement(el: any): boolean
Parameters
- el: any
Returns boolean
- Defined in view.ts:2664

performPatch

performPatch(patch: any, pruneCids: any, isJoinPatch?: boolean): boolean
Parameters
- patch: any
- pruneCids: any
- isJoinPatch: boolean = false
Returns boolean
- Defined in view.ts:677

pushEvent

pushEvent(
    type: any,
    el: any,
    targetCtx: any,
    phxEvent: any,
    meta: any,
    opts?: { [key: string]: any },
    onReply?: any,
): void
Parameters
- type: any
- el: any
- targetCtx: any
- phxEvent: any
- meta: any
- opts: { [key: string]: any } = {}
- OptionalonReply: any
Returns void
- Defined in view.ts:1942

pushFileProgress

pushFileProgress(
    fileEl: any,
    entryRef: any,
    progress: any,
    onReply?: () => void,
): void
Parameters
- fileEl: any
- entryRef: any
- progress: any
- onReply: () => void = ...
Returns void
- Defined in view.ts:1983

pushFormRecovery

pushFormRecovery(
    oldForm: HTMLFormElement,
    newForm: HTMLFormElement,
    templateDom: DocumentFragment | Element,
    callback: () => void,
): void
Parameters
- oldForm: HTMLFormElement
- newForm: HTMLFormElement
- templateDom: DocumentFragment | Element
- callback: () => void
Returns void
- Defined in view.ts:2427

pushFormSubmit

pushFormSubmit(
    formEl: any,
    targetCtx: any,
    phxEvent: any,
    submitter: any,
    opts: any,
    onReply: any,
): boolean
Parameters
- formEl: any
- targetCtx: any
- phxEvent: any
- submitter: any
- opts: any
- onReply: any
Returns boolean
- Defined in view.ts:2195

pushHookEvent

pushHookEvent(
    el: any,
    targetCtx: any,
    event: any,
    payload: any,
): Promise<{ ref: number; reply: any }>
Parameters
- el: any
- targetCtx: any
- event: any
- payload: any
Returns Promise<{ ref: number; reply: any }>
- Defined in view.ts:1754

pushInput

pushInput(
    inputEl: any,
    targetCtx: any,
    forceCid: any,
    phxEvent: any,
    opts: any,
    callback?: any,
): void
Parameters
- inputEl: any
- targetCtx: any
- forceCid: any
- phxEvent: any
- opts: any
- Optionalcallback: any
Returns void
- Defined in view.ts:2008

pushLinkPatch

pushLinkPatch(e: any, href: any, targetEl: any, callback: any): void
Parameters
- e: any
- href: any
- targetEl: any
- callback: any
Returns void
- Defined in view.ts:2490

pushPortalElementId

pushPortalElementId(id: any): void
Parameters
- id: any
Returns void
- Defined in view.ts:2688

pushWithReply

pushWithReply(
    refGenerator: any,
    event: any,
    payload: any,
): Promise<
    | { ref: number; reply: any; resp: any; type: "ok" }
    | { context: LiveViewDiagnosticContext; error: string; type: "error" },
>
Parameters
- refGenerator: any
- event: any
- payload: any
Returns Promise<
| { ref: number; reply: any; resp: any; type: "ok" }
| { context: LiveViewDiagnosticContext; error: string; type: "error" },
>
- Defined in view.ts:1425

putRef

putRef(
    elements: { el: Element; loading: boolean; lock: boolean }[],
    phxEvent: string,
    eventType: string,
    opts?: { [key: string]: any },
): (number | Element[] | { [key: string]: any })[]
Parameters
- elements: { el: Element; loading: boolean; lock: boolean }[]
- phxEvent: string
- eventType: string
- opts: { [key: string]: any } = {}
Returns (number | Element[] | { [key: string]: any })[]
- Defined in view.ts:1574

refSrc

refSrc(): string
Returns string
- Defined in view.ts:1570

renderContainer

renderContainer(diff: any, kind: any): any
Parameters
- diff: any
- kind: any
Returns any
- Defined in view.ts:976

scheduleSubmit

scheduleSubmit(formEl: any, ref: any, opts: any, callback: any): boolean
Parameters
- formEl: any
- ref: any
- opts: any
- callback: any
Returns boolean
- Defined in view.ts:2122

serializeForm

serializeForm(
    form: HTMLFormElement,
    opts?: { [key: string]: any },
    onlyNames?: string[],
): string
Parameters
- form: HTMLFormElement
- opts: { [key: string]: any } = {}
- onlyNames: string[] = []
Returns string
- Defined in view.ts:1833

setContainerClasses

setContainerClasses(...classes: any[]): void
Parameters
- ...classes: any[]
Returns void
- Defined in view.ts:294

setHref

setHref(href: any): void
Parameters
- href: any
Returns void
- Defined in view.ts:215

setRedirect

setRedirect(href: any): void
Parameters
- href: any
Returns void
- Defined in view.ts:219

showLoader

showLoader(timeout?: number): void
Parameters
- Optionaltimeout: number
Returns void
- Defined in view.ts:305

submitForm

submitForm(
    form: any,
    targetCtx: any,
    phxEvent: any,
    submitter: any,
    opts?: {},
): void
Parameters
- form: any
- targetCtx: any
- phxEvent: any
- submitter: any
- opts: {} = {}
Returns void
- Defined in view.ts:2673

targetComponentID

targetComponentID(
    target: any,
    targetCtx: any,
    opts?: { [key: string]: any },
): any
Parameters
- target: any
- targetCtx: any
- opts: { [key: string]: any } = {}
Returns any
- Defined in view.ts:1709

targetCtxElement

targetCtxElement(targetCtx: any): any
Parameters
- targetCtx: any
Returns any
- Defined in view.ts:2416

transition

transition(time: any, onStart: any, onDone?: () => void): void
Parameters
- time: any
- onStart: any
- onDone: () => void = ...
Returns void
- Defined in view.ts:361

triggerAwaitingSubmit

triggerAwaitingSubmit(formEl: any, phxEvent: any): void
Parameters
- formEl: any
- phxEvent: any
Returns void
- Defined in view.ts:2107

triggerBeforeUpdateHook

triggerBeforeUpdateHook(fromEl: any, toEl: any): ViewHook<HTMLElement>
Parameters
- fromEl: any
- toEl: any
Returns ViewHook<HTMLElement>
- Defined in view.ts:647

triggerReconnected

triggerReconnected(): void
Returns void
- Defined in view.ts:330

undoElRef

undoElRef(el: any, ref: any, phxEvent: any): void
Parameters
- el: any
- ref: any
- phxEvent: any
Returns void
- Defined in view.ts:1551

undoRefs

undoRefs(ref: any, phxEvent: any, onlyEls?: any): void
Parameters
- ref: any
- phxEvent: any
- OptionalonlyEls: any
Returns void
- Defined in view.ts:1528

update

update(diff: any, events: any, isPending?: boolean): boolean
Parameters
- diff: any
- events: any
- isPending: boolean = false
Returns boolean
- Defined in view.ts:925

uploadFiles

uploadFiles(
    formEl: any,
    phxEvent: any,
    targetCtx: any,
    ref: any,
    cid: any,
    onComplete: any,
): void
Parameters
- formEl: any
- phxEvent: any
- targetCtx: any
- ref: any
- cid: any
- onComplete: any
Returns void
- Defined in view.ts:2284

withinTargets

withinTargets(phxTarget: any, callback: any, dom?: QueryableNode): any
Parameters
- phxTarget: any
- callback: any
- dom: QueryableNode = document
Returns any
- Defined in view.ts:371

wrapPush

wrapPush(callerPush: any, receives: any): void
Parameters
- callerPush: any
- receives: any
Returns void
- Defined in view.ts:1405

`Static`closestView

closestView(el: any): any
Parameters
- el: any
Returns any
- Defined in view.ts:91