Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ScrimView

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new ScrimView(node: HTMLElement): ScrimView

  • Parameters

    • node: HTMLElement

    Returns ScrimView

Properties

Readonly alignContent

alignContent: StyleAnimator<ScrimView, undefined | AlignContent, never>

Readonly alignItems

alignItems: StyleAnimator<ScrimView, undefined | AlignItems, never>

Readonly alignSelf

alignSelf: StyleAnimator<ScrimView, undefined | AlignSelf, never>

Readonly appearance

appearance: StyleAnimator<ScrimView, undefined | Appearance, never>

Readonly autocomplete

autocomplete: AttributeAnimator<ScrimView, string, never>

Readonly backdropFilter

backdropFilter: StyleAnimator<ScrimView, undefined | string, never>

Readonly backgroundClip

backgroundClip: StyleAnimator<ScrimView, undefined | BackgroundClip, never>

Readonly backgroundColor

backgroundColor: StyleAnimator<ScrimView, null | Color, null | AnyColor>

Readonly backgroundImage

backgroundImage: StyleAnimator<ScrimView, null | string | LinearGradient, null | AnyLinearGradient>

Readonly borderBottomColor

borderBottomColor: StyleAnimator<ScrimView, null | Color, null | AnyColor>

Readonly borderBottomLeftRadius

borderBottomLeftRadius: StyleAnimator<ScrimView, null | Length, null | AnyLength>

Readonly borderBottomRightRadius

borderBottomRightRadius: StyleAnimator<ScrimView, null | Length, null | AnyLength>

Readonly borderBottomStyle

borderBottomStyle: StyleAnimator<ScrimView, undefined | BorderStyle, never>

Readonly borderBottomWidth

borderBottomWidth: StyleAnimator<ScrimView, null | Length, null | AnyLength>

Readonly borderCollapse

borderCollapse: StyleAnimator<ScrimView, undefined | BorderCollapse, never>

Readonly borderLeftColor

borderLeftColor: StyleAnimator<ScrimView, null | Color, null | AnyColor>

Readonly borderLeftStyle

borderLeftStyle: StyleAnimator<ScrimView, undefined | BorderStyle, never>

Readonly borderLeftWidth

borderLeftWidth: StyleAnimator<ScrimView, null | Length, null | AnyLength>

Readonly borderRightColor

borderRightColor: StyleAnimator<ScrimView, null | Color, null | AnyColor>

Readonly borderRightStyle

borderRightStyle: StyleAnimator<ScrimView, undefined | BorderStyle, never>

Readonly borderRightWidth

borderRightWidth: StyleAnimator<ScrimView, null | Length, null | AnyLength>

Readonly borderSpacing

borderSpacing: StyleAnimator<ScrimView, undefined | string, never>

Readonly borderTopColor

borderTopColor: StyleAnimator<ScrimView, null | Color, null | AnyColor>

Readonly borderTopLeftRadius

borderTopLeftRadius: StyleAnimator<ScrimView, null | Length, null | AnyLength>

Readonly borderTopRightRadius

borderTopRightRadius: StyleAnimator<ScrimView, null | Length, null | AnyLength>

Readonly borderTopStyle

borderTopStyle: StyleAnimator<ScrimView, undefined | BorderStyle, never>

Readonly borderTopWidth

borderTopWidth: StyleAnimator<ScrimView, null | Length, null | AnyLength>

Readonly bottom

bottom: StyleConstraintAnimator<ScrimView, null | Length, null | AnyLength>

Readonly boxShadow

boxShadow: StyleAnimator<ScrimView, null | BoxShadow, null | AnyBoxShadow>

Readonly boxSizing

boxSizing: StyleAnimator<ScrimView, undefined | BoxSizing, never>

Readonly checked

checked: AttributeAnimator<ScrimView, boolean, string | boolean>

Readonly childMap

childMap: null | Dictionary<View>

Readonly color

color: StyleAnimator<ScrimView, null | Color, null | AnyColor>

Readonly colspan

colspan: AttributeAnimator<ScrimView, number, string | number>

Readonly constraintVariables

constraintVariables: readonly ConstraintVariable[]

Readonly constraints

constraints: readonly Constraint[]

Optional Readonly contextType

contextType: Class<ViewContext>

Readonly cursor

cursor: StyleAnimator<ScrimView, undefined | CssCursor, never>

Readonly decoherent

decoherent: null | readonly Fastener<unknown>[]

Readonly disabled

disabled: AttributeAnimator<ScrimView, boolean, string | boolean>

Readonly display

display: StyleAnimator<ScrimView, undefined | CssDisplay, never>

Readonly displayProvider

displayProvider: DisplayProvider<ScrimView, DisplayService<ScrimView>>

Readonly displayState

displayState: number

Readonly domProvider

domProvider: DomProvider<ScrimView, DomService<ScrimView>>

Optional Readonly familyType

familyType: Class<View>

Readonly fasteners

fasteners: null | {}

Readonly filter

filter: StyleAnimator<ScrimView, undefined | string, never>

Readonly flags

flags: number

Readonly flexBasis

flexBasis: StyleAnimator<ScrimView, null | FlexBasis, null | string | number | Length>

Readonly flexDirection

flexDirection: StyleAnimator<ScrimView, string, never>

Readonly flexGrow

flexGrow: StyleAnimator<ScrimView, undefined | number, never>

Readonly flexShrink

flexShrink: StyleAnimator<ScrimView, undefined | number, never>

Readonly flexWrap

flexWrap: StyleAnimator<ScrimView, undefined | FlexWrap, never>

Readonly fontFamily

fontFamily: StyleAnimator<ScrimView, undefined | string | string[], undefined | string | readonly string[]>

Readonly fontSize

fontSize: StyleAnimator<ScrimView, null | Length, null | AnyLength>

Readonly fontStretch

fontStretch: StyleAnimator<ScrimView, undefined | FontStretch, never>

Readonly fontStyle

fontStyle: StyleAnimator<ScrimView, undefined | FontStyle, never>

Readonly fontVariant

fontVariant: StyleAnimator<ScrimView, undefined | FontVariant, never>

Readonly fontWeight

fontWeight: StyleAnimator<ScrimView, undefined | FontWeight, never>

Readonly height

height: StyleConstraintAnimator<ScrimView, null | Length, null | AnyLength>

Readonly justifyContent

justifyContent: StyleAnimator<ScrimView, undefined | JustifyContent, never>

Readonly key

key: undefined | string

Readonly layoutProvider

layoutProvider: LayoutProvider<ScrimView, LayoutService<ScrimView>>

Readonly left

left: StyleConstraintAnimator<ScrimView, null | Length, null | AnyLength>

Readonly lineHeight

lineHeight: StyleAnimator<ScrimView, null | Length, null | AnyLength>

Readonly marginBottom

marginBottom: StyleConstraintAnimator<ScrimView, null | Length, null | AnyLength>

Readonly marginLeft

marginLeft: StyleConstraintAnimator<ScrimView, null | Length, null | AnyLength>

Readonly marginRight

marginRight: StyleConstraintAnimator<ScrimView, null | Length, null | AnyLength>

Readonly marginTop

marginTop: StyleConstraintAnimator<ScrimView, null | Length, null | AnyLength>

Readonly maxHeight

maxHeight: StyleAnimator<ScrimView, null | Length, null | AnyLength>

Readonly maxWidth

maxWidth: StyleAnimator<ScrimView, null | Length, null | AnyLength>

Readonly minHeight

minHeight: StyleAnimator<ScrimView, null | Length, null | AnyLength>

Readonly minWidth

minWidth: StyleAnimator<ScrimView, null | Length, null | AnyLength>

Readonly modalProvider

modalProvider: ModalProvider<ScrimView, ModalService<ScrimView>>

Readonly mood

mood: Property<ScrimView, null | MoodVector<Feel>, null | MoodVector<Feel>>

Readonly moodModifier

moodModifier: Property<ScrimView, null | MoodMatrix<Feel, Feel>, null | MoodMatrix<Feel, Feel>>

Readonly node

node: HTMLElement

Readonly observerCache

observerCache: ElementViewObserverCache<ScrimView>

Optional Readonly observerType

observerType: Class<HtmlViewObserver<HtmlView>>

Readonly observers

observers: readonly HtmlViewObserver<HtmlView>[]

Readonly opacity

opacity: StyleAnimator<ScrimView, undefined | number, never>

Readonly order

order: StyleAnimator<ScrimView, undefined | number, never>

Readonly outlineColor

outlineColor: StyleAnimator<ScrimView, null | Color, null | AnyColor>

Readonly outlineStyle

outlineStyle: StyleAnimator<ScrimView, undefined | BorderStyle, never>

Readonly outlineWidth

outlineWidth: StyleAnimator<ScrimView, null | Length, null | AnyLength>

Readonly overflowScrolling

overflowScrolling: StyleAnimator<ScrimView, undefined | "touch" | "auto", never>

Readonly overflowX

overflowX: StyleAnimator<ScrimView, undefined | Overflow, never>

Readonly overflowY

overflowY: StyleAnimator<ScrimView, undefined | Overflow, never>

Readonly overscrollBehaviorX

overscrollBehaviorX: StyleAnimator<ScrimView, undefined | OverscrollBehavior, never>

Readonly overscrollBehaviorY

overscrollBehaviorY: StyleAnimator<ScrimView, undefined | OverscrollBehavior, never>

Readonly paddingBottom

paddingBottom: StyleConstraintAnimator<ScrimView, null | Length, null | AnyLength>

Readonly paddingLeft

paddingLeft: StyleConstraintAnimator<ScrimView, null | Length, null | AnyLength>

Readonly paddingRight

paddingRight: StyleConstraintAnimator<ScrimView, null | Length, null | AnyLength>

Readonly paddingTop

paddingTop: StyleConstraintAnimator<ScrimView, null | Length, null | AnyLength>

Readonly placeholder

placeholder: AttributeAnimator<ScrimView, string, never>

Readonly pointerEvents

pointerEvents: StyleAnimator<ScrimView, undefined | PointerEvents, never>

Readonly position

position: StyleAnimator<ScrimView, undefined | Position, never>

Readonly right

right: StyleConstraintAnimator<ScrimView, null | Length, null | AnyLength>

Readonly rowspan

rowspan: AttributeAnimator<ScrimView, number, string | number>

Readonly selected

selected: AttributeAnimator<ScrimView, boolean, string | boolean>

Readonly textAlign

textAlign: StyleAnimator<ScrimView, undefined | TextAlign, never>

Readonly textDecorationColor

textDecorationColor: StyleAnimator<ScrimView, null | Color, null | AnyColor>

Readonly textDecorationLine

textDecorationLine: StyleAnimator<ScrimView, undefined | string, never>

Readonly textDecorationStyle

textDecorationStyle: StyleAnimator<ScrimView, undefined | TextDecorationStyle, never>

Readonly textOverflow

textOverflow: StyleAnimator<ScrimView, undefined | string, never>

Readonly textTransform

textTransform: StyleAnimator<ScrimView, undefined | TextTransform, never>

Readonly theme

theme: Property<ScrimView, null | ThemeMatrix, null | ThemeMatrix>

Readonly themeModifier

themeModifier: Property<ScrimView, null | MoodMatrix<Feel, Feel>, null | MoodMatrix<Feel, Feel>>

Readonly themeProvider

themeProvider: ThemeProvider<ScrimView, ThemeService<ScrimView>>

Readonly title

title: AttributeAnimator<ScrimView, string, never>

Readonly top

top: StyleConstraintAnimator<ScrimView, null | Length, null | AnyLength>

Readonly touchAction

touchAction: StyleAnimator<ScrimView, undefined | TouchAction, never>

Readonly transform

transform: StyleAnimator<ScrimView, null | Transform, null | AnyTransform>

Readonly type

type: AttributeAnimator<ScrimView, string, never>

Readonly uid

uid: number

Readonly userSelect

userSelect: StyleAnimator<ScrimView, undefined | UserSelect, never>

Readonly value

value: AttributeAnimator<ScrimView, string, never>

Readonly verticalAlign

verticalAlign: StyleAnimator<ScrimView, undefined | VerticalAlign, undefined | string | number | Length>

Readonly viewportProvider

viewportProvider: ViewportProvider<ScrimView, ViewportService<ScrimView>>

Readonly visibility

visibility: StyleAnimator<ScrimView, undefined | Visibility, never>

Readonly whiteSpace

whiteSpace: StyleAnimator<ScrimView, undefined | WhiteSpace, never>

Readonly width

width: StyleConstraintAnimator<ScrimView, null | Length, null | AnyLength>

Readonly zIndex

zIndex: StyleAnimator<ScrimView, undefined | number, never>

Static Readonly ContextualFlag

ContextualFlag: number

Static Readonly CullFlag

CullFlag: number

Static Readonly CulledFlag

CulledFlag: number

Static Readonly CulledMask

CulledMask: number

Static Readonly DisplayMask

DisplayMask: number

Static Readonly DisplayingFlag

DisplayingFlag: number

Static Readonly FlagMask

FlagMask: number

Static Readonly FlagShift

FlagShift: number

Static Readonly HiddenFlag

HiddenFlag: number

Static Readonly HiddenMask

HiddenMask: number

Static Readonly HiddenState

HiddenState: number

Static Readonly HideFlag

HideFlag: number

Static Readonly HideState

HideState: number

Static Readonly HidingState

HidingState: number

Static Readonly InsertChildFlags

InsertChildFlags: number

Static Readonly IntangibleFlag

IntangibleFlag: number

Static Readonly MountFlags

MountFlags: number

Static Readonly MountedFlag

MountedFlag: number

Static Readonly NeedsAnimate

NeedsAnimate: number

Static Readonly NeedsChange

NeedsChange: number

Static Readonly NeedsComposite

NeedsComposite: number

Static Readonly NeedsDisplay

NeedsDisplay: number

Static Readonly NeedsLayout

NeedsLayout: number

Static Readonly NeedsProcess

NeedsProcess: number

Static Readonly NeedsProject

NeedsProject: number

Static Readonly NeedsRasterize

NeedsRasterize: number

Static Readonly NeedsRender

NeedsRender: number

Static Readonly NeedsResize

NeedsResize: number

Static Readonly NeedsScroll

NeedsScroll: number

Static Readonly ProcessMask

ProcessMask: number

Static Readonly ProcessingFlag

ProcessingFlag: number

Static Readonly RemoveChildFlags

RemoveChildFlags: number

Static Readonly RemovingFlag

RemovingFlag: number

Static Readonly ShowState

ShowState: number

Static Readonly ShowingState

ShowingState: number

Static Readonly ShownState

ShownState: number

Static Readonly StatusMask

StatusMask: number

Static Readonly TraversingFlag

TraversingFlag: number

Static Readonly UnboundedFlag

UnboundedFlag: number

Static Readonly UncullFlags

UncullFlags: number

Static Readonly UpdateMask

UpdateMask: number

Static Readonly UpdatingMask

UpdatingMask: number

Static Optional Readonly namespace

namespace: string

Static Readonly tag

tag: string

Static uid

uid: () => number

Type declaration

    • (): number

    • Returns number

Accessors

childCount

  • get childCount(): number

  • Returns number

children

  • get children(): readonly View[]

  • Returns readonly View[]

classList

  • get classList(): DOMTokenList

  • Returns DOMTokenList

clientBounds

  • get clientBounds(): R2Box

  • Returns R2Box

clientTransform

  • Returns Transform

culled

  • get culled(): boolean

  • Returns boolean

displaying

  • get displaying(): boolean

  • Returns boolean

insertChildFlags

  • get insertChildFlags(): number

  • Returns number

intangible

  • get intangible(): boolean

  • Returns boolean

mountFlags

  • get mountFlags(): number

  • Returns number

mounted

  • get mounted(): boolean

  • Returns boolean

pageBounds

  • get pageBounds(): R2Box

  • Returns R2Box

pageTransform

  • Returns Transform

parent

  • get parent(): null | View

  • Returns null | View

parentTransform

  • Returns Transform

popoverFrame

  • get popoverFrame(): R2Box

  • Returns R2Box

processing

  • get processing(): boolean

  • Returns boolean

removeChildFlags

  • get removeChildFlags(): number

  • Returns number

superViewContext

  • Returns ViewContext

traversing

  • get traversing(): boolean

  • Returns boolean

unbounded

  • get unbounded(): boolean

  • Returns boolean

uncullFlags

  • get uncullFlags(): number

  • Returns number

updating

  • get updating(): boolean

  • Returns boolean

viewContext

  • Returns ViewContextType<this>

viewIdiom

  • Returns ViewIdiom

viewport

  • Returns Viewport

Methods

activateConstraint

  • activateConstraint(constraint: Constraint): void

activateConstraintVariable

Protected activateLayout

  • activateLayout(): void

  • Returns void

addClass

  • addClass(...classNames: string[]): ScrimView

  • Parameters

    • Rest ...classNames: string[]

    Returns ScrimView

addConstraint

  • Parameters

    Returns void

addConstraintVariable

appendChild

  • Type parameters

    Parameters

    • child: V
    • Optional key: string

    Returns V

  • Type parameters

    • F: new (...args: any[]) => InstanceType<F> & Creatable<InstanceType<F>, F>

    Parameters

    • factory: F
    • Optional key: string

    Returns InstanceType<F>

  • Type parameters

    Parameters

    • tag: K
    • Optional key: string

    Returns HtmlViewTagMap[K]

  • Parameters

    Returns NodeView

applyRootTheme

applyTheme

Protected attachFastener

  • attachFastener(fastenerName: string, fastener: Fastener<unknown>): void

  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

attachParent

  • attachParent(parent: View): void

  • Parameters

    Returns void

Protected bindChildFastener

  • bindChildFastener(fastener: Fastener<unknown>, child: View, target: null | View): void

Protected bindChildFasteners

  • bindChildFasteners(child: View, target: null | View): void

  • Parameters

    Returns void

Protected bindFastener

  • bindFastener(fastener: Fastener<unknown>): void

  • Parameters

    Returns void

borderColor

borderRadius

borderStyle

borderWidth

callObservers

  • Type parameters

    • O

    • K: string | number | symbol

    Parameters

    Returns void

cascadeCull

  • cascadeCull(): void

  • Returns void

cascadeDisplay

  • cascadeDisplay(displayFlags: number, baseViewContext: ViewContext): void

  • Parameters

    Returns void

cascadeInsert

  • cascadeInsert(updateFlags?: number, viewContext?: ViewContext): void

  • Parameters

    • Optional updateFlags: number
    • Optional viewContext: ViewContext

    Returns void

cascadeMount

  • cascadeMount(): void

  • Returns void

cascadeProcess

  • cascadeProcess(processFlags: number, baseViewContext: ViewContext): void

  • Parameters

    Returns void

cascadeUncull

  • cascadeUncull(): void

  • Returns void

cascadeUnmount

  • cascadeUnmount(): void

  • Returns void

Protected changeMood

  • changeMood(): void

  • Returns void

Protected changeTheme

  • changeTheme(): void

  • Returns void

className

  • className(): undefined | string
  • className(value: undefined | string): ScrimView

  • Returns undefined | string

  • Parameters

    • value: undefined | string

    Returns ScrimView

constraint

constraintVariable

Protected cullChildren

  • cullChildren(): void

  • Returns void

deactivateConstraint

  • deactivateConstraint(constraint: Constraint): void

deactivateConstraintVariable

Protected deactivateLayout

  • deactivateLayout(): void

  • Returns void

decohereFastener

  • decohereFastener(fastener: Fastener<unknown>): void

  • Parameters

    Returns void

Protected detachFastener

  • detachFastener(fastenerName: string, fastener: Fastener<unknown>): void

  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

detachParent

  • detachParent(parent: View): void

  • Parameters

    Returns void

Protected didAnimate

  • Parameters

    Returns void

Protected didApplyTheme

Protected didAttachFastener

  • didAttachFastener(fastenerName: string, fastener: Fastener<unknown>): void

  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

Protected didAttachParent

  • didAttachParent(parent: View): void

  • Parameters

    Returns void

Protected didChange

  • Parameters

    Returns void

Protected didCull

  • didCull(): void

  • Returns void

Protected didDetachFastener

  • didDetachFastener(fastenerName: string, fastener: Fastener<unknown>): void

  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

Protected didDetachParent

  • didDetachParent(parent: View): void

  • Parameters

    Returns void

Protected didDisplay

  • didDisplay(displayFlags: number, viewContext: ViewContext): void

  • Parameters

    Returns void

Protected didHide

  • didHide(): void

  • Returns void

Protected didInsertChild

  • didInsertChild(child: View, target: null | View): void

  • Parameters

    Returns void

Protected didLayout

  • Parameters

    Returns void

Protected didMount

  • didMount(): void

  • Returns void

Protected didObserve

Protected didProcess

  • didProcess(processFlags: number, viewContext: ViewContext): void

  • Parameters

    Returns void

Protected didRemoveChild

  • didRemoveChild(child: View): void

  • Parameters

    Returns void

Protected didResize

  • Parameters

    Returns void

Protected didScroll

  • Parameters

    Returns void

Protected didSetAttribute

  • didSetAttribute(attributeName: string, value: unknown): void

  • Parameters

    • attributeName: string
    • value: unknown

    Returns void

Protected didSetIntangible

  • didSetIntangible(intangible: boolean): void

  • Parameters

    • intangible: boolean

    Returns void

Protected didSetStyle

  • didSetStyle(propertyName: string, value: unknown, priority: undefined | string): void

  • Parameters

    • propertyName: string
    • value: unknown
    • priority: undefined | string

    Returns void

Protected didSetUnbounded

  • didSetUnbounded(unboundedFlag: boolean): void

  • Parameters

    • unboundedFlag: boolean

    Returns void

Protected didShow

  • didShow(): void

  • Returns void

Protected didUncull

  • didUncull(): void

  • Returns void

Protected didUnmount

  • didUnmount(): void

  • Returns void

Protected didUnobserve

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • Parameters

    • event: Event

    Returns boolean

Protected displayChild

  • displayChild(child: View, displayFlags: number, viewContext: ViewContext): void

  • Parameters

    Returns void

Protected displayChildren

  • displayChildren(displayFlags: number, viewContext: ViewContext, displayChild: (childView: View, displayFlags: number, viewContext: ViewContext) => void): void

  • Parameters

    • displayFlags: number
    • viewContext: ViewContext
    • displayChild: (childView: View, displayFlags: number, viewContext: ViewContext) => void

        • Parameters

          Returns void

    Returns void

equals

  • equals(that: unknown): boolean

  • Parameters

    • that: unknown

    Returns boolean

evaluateConstraintVariables

  • evaluateConstraintVariables(): void

extendViewContext

firstChild

  • firstChild(): null | View

  • Returns null | View

font

  • Returns null | Font

  • Parameters

    • value: null | AnyFont
    • Optional timing: boolean | AnyTiming
    • Optional precedence: number

    Returns ScrimView

forEachChild

  • forEachChild<T>(callback: (child: View) => void | T): undefined | T
  • forEachChild<T, S>(callback: (child: View) => void | T, thisArg: S): undefined | T

  • Type parameters

    • T

    Parameters

    • callback: (child: View) => void | T
        • (child: View): void | T

        • Parameters

          Returns void | T

    Returns undefined | T

  • Type parameters

    • T

    • S

    Parameters

    • callback: (child: View) => void | T
        • (child: View): void | T

        • Parameters

          Returns void | T

    • thisArg: S

    Returns undefined | T

forEachObserver

getAttribute

  • getAttribute(attributeName: string): null | string

  • Parameters

    • attributeName: string

    Returns null | string

getBase

  • getBase<F>(baseBound: F): null | InstanceType<F>

  • Type parameters

    Parameters

    • baseBound: F

    Returns null | InstanceType<F>

getChild

  • getChild<F>(key: string, childBound: F): null | InstanceType<F>
  • getChild(key: string, childBound?: new (...args: any[]) => View): null | View

  • Type parameters

    • F: new (...args: any[]) => View

    Parameters

    • key: string
    • childBound: F

    Returns null | InstanceType<F>

  • Parameters

    • key: string
    • Optional childBound: new (...args: any[]) => View
        • new (...args: any[]): View

        • Parameters

          • Rest ...args: any[]

          Returns View

    Returns null | View

getFastener

  • getFastener<F>(fastenerName: string, fastenerBound: Class<F>): null | F
  • getFastener(fastenerName: string, fastenerBound?: null | Class<Fastener<unknown>>): null | Fastener<unknown>

  • Type parameters

    Parameters

    • fastenerName: string
    • fastenerBound: Class<F>

    Returns null | F

  • Parameters

    • fastenerName: string
    • Optional fastenerBound: null | Class<Fastener<unknown>>

    Returns null | Fastener<unknown>

getLazyFastener

  • getLazyFastener<F>(fastenerName: string, fastenerBound: Class<F>): null | F
  • getLazyFastener(fastenerName: string, fastenerBound?: null | Class<Fastener<unknown>>): null | Fastener<unknown>

  • Type parameters

    Parameters

    • fastenerName: string
    • fastenerBound: Class<F>

    Returns null | F

  • Parameters

    • fastenerName: string
    • Optional fastenerBound: null | Class<Fastener<unknown>>

    Returns null | Fastener<unknown>

getLook

  • Type parameters

    • T

    Parameters

    Returns undefined | T

getLookOr

  • getLookOr<T, E>(look: Look<T, unknown>, elseValue: E): T | E
  • getLookOr<T, E>(look: Look<T, unknown>, mood: null | MoodVector<Feel>, elseValue: E): T | E

  • Type parameters

    • T

    • E

    Parameters

    • look: Look<T, unknown>
    • elseValue: E

    Returns T | E

  • Type parameters

    • T

    • E

    Parameters

    Returns T | E

getStyle

  • getStyle(propertyNames: string | readonly string[]): undefined | string | CSSStyleValue

  • Parameters

    • propertyNames: string | readonly string[]

    Returns undefined | string | CSSStyleValue

getSuper

  • getSuper<F>(superBound: F): null | InstanceType<F>

  • Type parameters

    Parameters

    • superBound: F

    Returns null | InstanceType<F>

getSuperFastener

  • getSuperFastener<F>(fastenerName: string, fastenerBound: Class<F>): null | F
  • getSuperFastener(fastenerName: string, fastenerBound?: null | Class<Fastener<unknown>>): null | Fastener<unknown>

  • Type parameters

    Parameters

    • fastenerName: string
    • fastenerBound: Class<F>

    Returns null | F

  • Parameters

    • fastenerName: string
    • Optional fastenerBound: null | Class<Fastener<unknown>>

    Returns null | Fastener<unknown>

hasClass

  • hasClass(className: string): boolean

  • Parameters

    • className: string

    Returns boolean

hasConstraint

  • Parameters

    Returns boolean

hasConstraintVariable

hasFastener

  • hasFastener(fastenerName: string, fastenerBound?: null | Class<Fastener<unknown>>): boolean

  • Parameters

    • fastenerName: string
    • Optional fastenerBound: null | Class<Fastener<unknown>>

    Returns boolean

hashCode

  • hashCode(): number

  • Returns number

hide

  • Parameters

    Returns void

id

  • id(): undefined | string
  • id(value: undefined | string): ScrimView

  • Returns undefined | string

  • Parameters

    • value: undefined | string

    Returns ScrimView

init

  • Parameters

    Returns void

Protected initAttributes

Protected initElement

  • initElement(node: Element): void

  • Parameters

    • node: Element

    Returns void

Protected initScrim

  • initScrim(): void

  • Returns void

Protected initStyle

injectChild

  • injectChild(child: Node | View, target: null | Node | View, key?: string): void

  • Parameters

    • child: Node | View
    • target: null | Node | View
    • Optional key: string

    Returns void

insertChild

  • Type parameters

    Parameters

    • child: V
    • target: null | Node | View
    • Optional key: string

    Returns V

  • Type parameters

    • F: new (...args: any[]) => InstanceType<F> & Creatable<InstanceType<F>, F>

    Parameters

    • factory: F
    • target: null | View
    • Optional key: string

    Returns InstanceType<F>

  • Type parameters

    Parameters

    • tag: K
    • target: null | Node | View
    • Optional key: string

    Returns HtmlViewTagMap[K]

  • Parameters

    Returns NodeView

Protected insertChildMap

  • insertChildMap(child: View): void

  • Parameters

    Returns void

intersectsViewport

  • intersectsViewport(): boolean

  • Returns boolean

isHidden

  • isHidden(): boolean

  • Returns boolean

isPositioned

  • isPositioned(): boolean

  • Returns boolean

isShown

  • isShown(): boolean

  • Returns boolean

lastChild

  • lastChild(): null | View

  • Returns null | View

margin

modifyMood

modifyTheme

mount

  • mount(): void

  • Returns void

Protected mountChildren

  • mountChildren(): void

  • Returns void

Protected mountFasteners

  • mountFasteners(): void

  • Returns void

Protected mountTheme

  • mountTheme(): void

  • Returns void

Protected needsDisplay

  • needsDisplay(displayFlags: number, viewContext: ViewContext): number

  • Parameters

    Returns number

Protected needsProcess

  • needsProcess(processFlags: number, viewContext: ViewContext): number

  • Parameters

    Returns number

Protected needsUpdate

  • needsUpdate(updateFlags: number, immediate: boolean): number

  • Parameters

    • updateFlags: number
    • immediate: boolean

    Returns number

nextChild

  • nextChild(targetView: View): null | View

  • Parameters

    Returns null | View

observe

off

  • off<K>(type: K, listener: (event: HTMLElementEventMap[K]) => unknown, options?: boolean | EventListenerOptions): ScrimView
  • off(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): ScrimView

  • Type parameters

    • K: keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: (event: HTMLElementEventMap[K]) => unknown
        • (event: HTMLElementEventMap[K]): unknown

        • Parameters

          • event: HTMLElementEventMap[K]

          Returns unknown

    • Optional options: boolean | EventListenerOptions

    Returns ScrimView

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | EventListenerOptions

    Returns ScrimView

on

  • on<K>(type: K, listener: (event: HTMLElementEventMap[K]) => unknown, options?: boolean | AddEventListenerOptions): ScrimView
  • on(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): ScrimView

  • Type parameters

    • K: keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: (event: HTMLElementEventMap[K]) => unknown
        • (event: HTMLElementEventMap[K]): unknown

        • Parameters

          • event: HTMLElementEventMap[K]

          Returns unknown

    • Optional options: boolean | AddEventListenerOptions

    Returns ScrimView

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns ScrimView

Protected onAnimate

  • Parameters

    Returns void

Protected onApplyTheme

Protected onAttachFastener

  • onAttachFastener(fastenerName: string, fastener: Fastener<unknown>): void

  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

Protected onAttachParent

  • onAttachParent(parent: View): void

  • Parameters

    Returns void

Protected onChange

  • Parameters

    Returns void

Protected onClick

  • onClick(event: Event): void

  • Parameters

    • event: Event

    Returns void

Protected onCull

  • onCull(): void

  • Returns void

Protected onDetachFastener

  • onDetachFastener(fastenerName: string, fastener: Fastener<unknown>): void

  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

Protected onDetachParent

  • onDetachParent(parent: View): void

  • Parameters

    Returns void

Protected onDisplay

  • onDisplay(displayFlags: number, viewContext: ViewContext): void

  • Parameters

    Returns void

Protected onInsertChild

  • onInsertChild(child: View, target: null | View): void

  • Parameters

    Returns void

Protected onLayout

  • Parameters

    Returns void

Protected onMount

  • onMount(): void

  • Returns void

Protected onObserve

Protected onProcess

  • onProcess(processFlags: number, viewContext: ViewContext): void

  • Parameters

    Returns void

Protected onRemoveChild

  • onRemoveChild(child: View): void

  • Parameters

    Returns void

Protected onResize

  • Parameters

    Returns void

Protected onScroll

  • Parameters

    Returns void

Protected onSetAttribute

  • onSetAttribute(attributeName: string, value: unknown): void

  • Parameters

    • attributeName: string
    • value: unknown

    Returns void

Protected onSetIntangible

  • onSetIntangible(intangible: boolean): void

  • Parameters

    • intangible: boolean

    Returns void

Protected onSetStyle

  • onSetStyle(propertyName: string, value: unknown, priority: undefined | string): void

  • Parameters

    • propertyName: string
    • value: unknown
    • priority: undefined | string

    Returns void

Protected onSetUnbounded

  • onSetUnbounded(unboundedFlag: boolean): void

  • Parameters

    • unboundedFlag: boolean

    Returns void

Protected onSyntheticClick

  • onSyntheticClick(event: Event): void

  • Parameters

    • event: Event

    Returns void

Protected onUncull

  • onUncull(): void

  • Returns void

Protected onUnmount

  • onUnmount(): void

  • Returns void

Protected onUnobserve

overflow

overscrollBehavior

padding

prependChild

  • Type parameters

    Parameters

    • child: V
    • Optional key: string

    Returns V

  • Type parameters

    • F: new (...args: any[]) => InstanceType<F> & Creatable<InstanceType<F>, F>

    Parameters

    • factory: F
    • Optional key: string

    Returns InstanceType<F>

  • Type parameters

    Parameters

    • tag: K
    • Optional key: string

    Returns HtmlViewTagMap[K]

  • Parameters

    Returns NodeView

previousChild

  • previousChild(targetView: View): null | View

  • Parameters

    Returns null | View

Protected processChild

  • processChild(child: View, processFlags: number, viewContext: ViewContext): void

  • Parameters

    Returns void

Protected processChildren

  • processChildren(processFlags: number, viewContext: ViewContext, processChild: (childView: View, processFlags: number, viewContext: ViewContext) => void): void

  • Parameters

    • processFlags: number
    • viewContext: ViewContext
    • processChild: (childView: View, processFlags: number, viewContext: ViewContext) => void

        • Parameters

          Returns void

    Returns void

recohereAnimators

  • recohereAnimators(t: number): void

  • Parameters

    • t: number

    Returns void

recohereFasteners

  • recohereFasteners(t?: number): void

  • Parameters

    • Optional t: number

    Returns void

remove

  • remove(): void

  • Returns void

removeChild

  • removeChild(key: string): null | View
  • removeChild<V>(child: V): V
  • removeChild(child: Node): View

  • Parameters

    • key: string

    Returns null | View

  • Type parameters

    Parameters

    • child: V

    Returns V

  • Parameters

    • child: Node

    Returns View

Protected removeChildMap

  • removeChildMap(child: View): void

  • Parameters

    Returns void

removeChildren

  • removeChildren(): void

  • Returns void

removeClass

  • removeClass(...classNames: string[]): ScrimView

  • Parameters

    • Rest ...classNames: string[]

    Returns ScrimView

removeConstraint

removeConstraintVariable

replaceChild

Protected replaceChildMap

  • replaceChildMap(newChild: View, oldChild: View): void

  • Parameters

    Returns void

requestUpdate

  • requestUpdate(target: View, updateFlags: number, immediate: boolean): void

  • Parameters

    • target: View
    • updateFlags: number
    • immediate: boolean

    Returns void

requireUpdate

  • requireUpdate(updateFlags: number, immediate?: boolean): void

  • Parameters

    • updateFlags: number
    • Optional immediate: boolean

    Returns void

serviceDidUpdateModality

  • serviceDidUpdateModality(newModality: number, oldModality: number, modalService: ModalService<View>): void

setAttribute

  • setAttribute(attributeName: string, value: unknown): ScrimView

  • Parameters

    • attributeName: string
    • value: unknown

    Returns ScrimView

setChild

  • Type parameters

    Parameters

    • key: string
    • newChild: V

    Returns null | View

  • Type parameters

    • F: new (...args: any[]) => InstanceType<F> & Creatable<InstanceType<F>, F>

    Parameters

    • key: string
    • factory: F

    Returns null | View

  • Parameters

    Returns null | View

setConstraintVariable

setCulled

  • setCulled(culled: boolean): void

  • Parameters

    • culled: boolean

    Returns void

setDisplayState

  • setDisplayState(displayState: number): void

  • Parameters

    • displayState: number

    Returns void

setFastener

  • setFastener(fastenerName: string, newFastener: null | Fastener<unknown>): void

  • Parameters

    • fastenerName: string
    • newFastener: null | Fastener<unknown>

    Returns void

setFlags

  • setFlags(flags: number): void

  • Parameters

    • flags: number

    Returns void

setIntangible

  • setIntangible(intangible: boolean): void

  • Parameters

    • intangible: boolean

    Returns void

setKey

  • setKey(key: undefined | string): void

  • Parameters

    • key: undefined | string

    Returns void

setProperties

setProperty

  • setProperty(key: string, value: unknown, timing?: null | boolean | AnyTiming, affinity?: number): void

  • Parameters

    • key: string
    • value: unknown
    • Optional timing: null | boolean | AnyTiming
    • Optional affinity: number

    Returns void

setStyle

  • setStyle(propertyName: string, value: unknown, priority?: string): ScrimView

  • Parameters

    • propertyName: string
    • value: unknown
    • Optional priority: string

    Returns ScrimView

setUnbounded

  • setUnbounded(unboundedFlag: boolean): void

  • Parameters

    • unboundedFlag: boolean

    Returns void

show

  • show(opacity: number, timing?: boolean | AnyTiming): void

  • Parameters

    • opacity: number
    • Optional timing: boolean | AnyTiming

    Returns void

text

  • text(): undefined | string
  • text(value: undefined | null | string): ScrimView

  • Returns undefined | string

  • Parameters

    • value: undefined | null | string

    Returns ScrimView

Protected themeAnimators

toggleClass

  • toggleClass(className: string, state?: boolean): ScrimView

  • Parameters

    • className: string
    • Optional state: boolean

    Returns ScrimView

Protected unbindChildFastener

  • unbindChildFastener(fastener: Fastener<unknown>, child: View): void

Protected unbindChildFasteners

  • unbindChildFasteners(child: View): void

Protected uncullChildren

  • uncullChildren(): void

  • Returns void

Protected unmountChildren

  • unmountChildren(): void

  • Returns void

Protected unmountFasteners

  • unmountFasteners(): void

  • Returns void

unobserve

Protected updateTheme

  • updateTheme(timing?: boolean | AnyTiming): void

  • Parameters

    Returns void

Protected willAnimate

  • Parameters

    Returns void

Protected willApplyTheme

Protected willAttachFastener

  • willAttachFastener(fastenerName: string, fastener: Fastener<unknown>): void

  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

Protected willAttachParent

  • willAttachParent(parent: View): void

  • Parameters

    Returns void

Protected willChange

  • Parameters

    Returns void

Protected willCull

  • willCull(): void

  • Returns void

Protected willDetachFastener

  • willDetachFastener(fastenerName: string, fastener: Fastener<unknown>): void

  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

Protected willDetachParent

  • willDetachParent(parent: View): void

  • Parameters

    Returns void

Protected willDisplay

  • willDisplay(displayFlags: number, viewContext: ViewContext): void

  • Parameters

    Returns void

Protected willHide

  • willHide(): void

  • Returns void

Protected willInsertChild

  • willInsertChild(child: View, target: null | View): void

  • Parameters

    Returns void

Protected willLayout

  • Parameters

    Returns void

Protected willMount

  • willMount(): void

  • Returns void

Protected willObserve

Protected willProcess

  • willProcess(processFlags: number, viewContext: ViewContext): void

  • Parameters

    Returns void

Protected willRemoveChild

  • willRemoveChild(child: View): void

  • Parameters

    Returns void

Protected willResize

  • Parameters

    Returns void

Protected willScroll

  • Parameters

    Returns void

Protected willSetAttribute

  • willSetAttribute(attributeName: string, value: unknown): void

  • Parameters

    • attributeName: string
    • value: unknown

    Returns void

Protected willSetIntangible

  • willSetIntangible(intangible: boolean): void

  • Parameters

    • intangible: boolean

    Returns void

Protected willSetStyle

  • willSetStyle(propertyName: string, value: unknown, priority: undefined | string): void

  • Parameters

    • propertyName: string
    • value: unknown
    • priority: undefined | string

    Returns void

Protected willSetUnbounded

  • willSetUnbounded(unboundedFlag: boolean): void

  • Parameters

    • unboundedFlag: boolean

    Returns void

Protected willShow

  • willShow(): void

  • Returns void

Protected willUncull

  • willUncull(): void

  • Returns void

Protected willUnmount

  • willUnmount(): void

  • Returns void

Protected willUnobserve

Static create

  • create<S>(): InstanceType<S>
  • create(): HtmlView

  • Type parameters

    • S: new (...args: any[]) => InstanceType<S>

    Returns InstanceType<S>

  • Returns HtmlView

Static forTag

Static fromAny

Static fromInit

  • fromInit<S>(init: InitType<InstanceType<S>>): InstanceType<S>

  • Type parameters

    • S: new (...args: any[]) => InstanceType<S>

    Parameters

    Returns InstanceType<S>

Static fromNode

  • fromNode<S>(node: ViewNodeType<InstanceType<S>>): InstanceType<S>
  • fromNode(node: HTMLElement): HtmlView

  • Type parameters

    • S: new (node: HTMLElement) => InstanceType<S>

    Parameters

    Returns InstanceType<S>

  • Parameters

    • node: HTMLElement

    Returns HtmlView

Static fromTag

  • fromTag(tag: "style"): StyleView
  • fromTag(tag: "svg"): SvgView
  • fromTag<S>(tag: string): InstanceType<S>
  • fromTag(tag: string): HtmlView

  • Parameters

    • tag: "style"

    Returns StyleView

  • Parameters

    • tag: "svg"

    Returns SvgView

  • Type parameters

    • S: new (...args: any[]) => InstanceType<S>

    Parameters

    • tag: string

    Returns InstanceType<S>

  • Parameters

    • tag: string

    Returns HtmlView

Static isNodeMounted

  • isNodeMounted(node: Node): boolean

  • Parameters

    • node: Node

    Returns boolean

Static isPositioned

  • isPositioned(element: HTMLElement): boolean

  • Parameters

    • element: HTMLElement

    Returns boolean

Static isRootView

  • isRootView(node: Node): boolean

  • Parameters

    • node: Node

    Returns boolean

Static mount

  • Parameters

    Returns void

Static pageTransform

  • pageTransform(element: HTMLElement): Transform

  • Parameters

    • element: HTMLElement

    Returns Transform

Static parentTransform

  • parentTransform(element: HTMLElement): Transform

  • Parameters

    • element: HTMLElement

    Returns Transform

Generated using TypeDoc