Class Part<StateType>`Abstract`

Base class for all parts.

Type Parameters

StateType

Hierarchy

Part
- RouterPart

Properties

`Private` `Optional` _attachedElement

_attachedElement?: HTMLElement

The DOM element to which this part was last rendered.

`Private` `Optional` _mountElement

_mountElement?: HTMLElement

The DOM element to which which this part has been explicitly mounted. (Will be undefined for all except root parts)

Accessors

context

get context(): PartContext
Returns the current context.

Returns PartContext
- Defined in src/parts.ts:291

element

get element(): null | HTMLElement
Returns
Either this part's explicit mount element, or the element found by its id. This will return null if the part is un-attached parts, i.e.:
- Root elements that have never been mounted
- Child elements that have never been rendered
- Child elements that have since been orphaned by their parents
Returns null | HTMLElement
- Defined in src/parts.ts:565

isAttached

get isAttached(): boolean
Returns
Whether or not the part is currently in the DOM tree with either a parent or a valid DOM element mount point.

Returns boolean
- Defined in src/parts.ts:572

isRoot

get isRoot(): boolean
Returns
Whether the part is a root part (doesn't have a parent, is mounted directly to a DOM element).

Returns boolean
- Defined in src/parts.ts:579

name

get name(): string
Returns
the name of the part class.

Returns string
- Defined in src/parts.ts:152

params

get params(): QueryParams
Returns the query params from the current context.

Returns QueryParams
- Defined in src/parts.ts:298

parentClasses

get parentClasses(): string[]
Subclasses can override this to provide a list of classes to apply to the parent element.

Returns string[]
- Defined in src/parts.ts:637

Methods

`Protected` _attachEventListeners

_attachEventListeners(): void
Attaches event listeners to this.element (if needsEventListeners() has been called) Needs to be protected for FormPart.

Returns void
- Defined in src/parts.ts:431

`Private` _markClean

_markClean(frame: number): void
Recursively crawls the children to see if any is dirty, then renders their entire branch. If they're only stale, calls the update() method.
Parameters
- frame: number
Returns void
- Defined in src/parts.ts:645

`Private` _requestFrame

_requestFrame(): void
Requests the next animation frame to render the part.

Returns void
- Defined in src/parts.ts:343

`Private` _setNeedsEventListeners

_setNeedsEventListeners(includeMe: boolean): void
Tells the children that they need to attach event listeners.
Parameters
- includeMe: boolean
  
  only set _needsEventListeners on this if it's true
Returns void
- Defined in src/parts.ts:418

`Private` _update

_update(): void
Recursively calls update() on this part and all of its children.

Returns void
- Defined in src/parts.ts:700

`Private` addDomListener

addDomListener(elem: HTMLElement, type: keyof HTMLElementEventMap): void
Attaches an event listener for a particular type of HTML event. Only event types with Tuff listeners will have HTML listeners attached.
Parameters
- elem: HTMLElement
- type: keyof HTMLElementEventMap
Returns void
- Defined in src/parts.ts:453

dirty

dirty(): void
Mark this part as dirty, meaning it needs to be fully re-rendered.

Returns void
- Defined in src/parts.ts:321

eachChild

eachChild(func: ((child: StatelessPart) => void)): void
Iterates over each direct child part.
Parameters
- func: ((child: StatelessPart) => void)
  - - (child: StatelessPart): void
    - Parameters
      
      child: StatelessPart
      
      Returns void
Returns void
- Defined in src/parts.ts:113

emit

emit<EventType, DataType>(type: EventType, key: TypedKey<DataType>, evt: messages.EventMap[EventType], data: DataType, options?: EmitOptions): void
Creates and emits a message for the given type and key.
Type Parameters
- EventType extends keyof messages.EventMap
- DataType
Parameters
- type: EventType
- key: TypedKey<DataType>
- evt: messages.EventMap[EventType]
- data: DataType
- options: EmitOptions = {}
Returns void
- Defined in src/parts.ts:490

emitMessage

emitMessage<DataType>(key: TypedKey<DataType>, data: DataType, options?: EmitOptions): void
Emits a generic message associated with the part (as opposed to a DOM event).
Type Parameters
- DataType
Parameters
- key: TypedKey<DataType>
  
  the message key
- data: DataType
  
  data associated with the message
- Optional options: EmitOptions
  
  configures how the message is emitted
Returns void
- Defined in src/parts.ts:516

init

init(): Promise<void>
Parts can override this to provide custom behavior that is run exactly once before the part is rendered for the first time.

Returns Promise<void>
- Defined in src/parts.ts:248

listenMessage

listenMessage<DataType>(key: UntypedKey | TypedKey<DataType>, handler: ((m: Message<"message", DataType>) => void), options?: ListenOptions): void
Listens for a generic message on the part (emitted with emitMessage()).
Type Parameters
- DataType
Parameters
- key: UntypedKey | TypedKey<DataType>
  
  the message key
- handler: ((m: Message<"message", DataType>) => void)
  
  the message handler
  - - (m: Message<"message", DataType>): void
    - Parameters
      
      m: Message<"message", DataType>
      
      Returns void
- options: ListenOptions = {}
  
  message handling options
Returns void
- Defined in src/parts.ts:404

load

load(): void
Parts can override this to provide custom behavior that is run after init() and whenever the page changes.

Returns void
- Defined in src/parts.ts:258

loadAll

loadAll(): void
Computes a new context and loads this and all child parts. Meant to be used by Nav.

Returns void
- Defined in src/parts.ts:266

namedChild

namedChild(name: string): undefined | StatelessPart
Looks up a child part by name.
Parameters
- name: string
  
  the name of the child part assigned during makePart or makeStatelessPart
Returns undefined | StatelessPart
- Defined in src/parts.ts:131

onAnyKeyPress

onAnyKeyPress(listener: Listener): void
Register a wildcard listener for all global keyboard events.
Parameters
- listener: Listener
  
  the listener function
Returns void
- Defined in src/parts.ts:540

onKeyPress

onKeyPress(press: KeyPress, listener: ((m: Message<"keypress", KeyPress>) => void)): void
Register a listener for a specific global key press event.
Parameters
- press: KeyPress
- listener: ((m: Message<"keypress", KeyPress>) => void)
  - - (m: Message<"keypress", KeyPress>): void
    - Parameters
      
      m: Message<"keypress", KeyPress>
      
      Returns void
Returns void
- Defined in src/parts.ts:530

removeChild

removeChild(child: StatelessPart): void
Removes a child part by id.
Parameters
- child: StatelessPart
  
  the id of the part
Returns void
- Defined in src/parts.ts:123

stale

stale(): void
Mark this part as stale, meaning it needs to be updated but not rendered.

Returns void
- Defined in src/parts.ts:330

update

update(_elem: HTMLElement): void
Gets called every time the part is rendered.
Parameters
- _elem: HTMLElement
  
  the actual DOM element containing the part
Returns void
- Defined in src/parts.ts:693

`Static` mount

mount<PartType, StateType>(partType: PartConstructor<PartType, StateType>, mountPoint: MountPoint, state: StateType, mountOptions?: MountOptions): PartType
Mounts a part to a DOM element (by DOM object or id).
Type Parameters
- PartType extends Part<StateType, PartType>
- StateType
Parameters
- partType: PartConstructor<PartType, StateType>
- mountPoint: MountPoint
- state: StateType
- Optional mountOptions: MountOptions
Returns PartType
- Defined in src/parts.ts:606

Class Part<StateType>Abstract

Type Parameters

StateType

Hierarchy

Index

Properties

Accessors

Methods

Properties

Private Optional _attachedElement

Private Optional _mountElement

Accessors

context

Returns PartContext

element

Returns

Returns null | HTMLElement

isAttached

Returns

Returns boolean

isRoot

Returns

Returns boolean

name

Returns

Returns string

params

Returns QueryParams

parentClasses

Returns string[]

Methods

Protected _attachEventListeners

Returns void

Private _markClean

Parameters

frame: number

Returns void

Private _requestFrame

Returns void

Private _setNeedsEventListeners

Parameters

includeMe: boolean

Returns void

Private _update

Returns void

Private addDomListener

Parameters

elem: HTMLElement

type: keyof HTMLElementEventMap

Returns void

dirty

Returns void

eachChild

Parameters

func: ((child: StatelessPart) => void)

Parameters

child: StatelessPart

Returns void

Returns void

emit

Type Parameters

EventType extends keyof messages.EventMap

DataType

Parameters

type: EventType

key: TypedKey<DataType>

evt: messages.EventMap[EventType]

data: DataType

options: EmitOptions = {}

Returns void

emitMessage

Type Parameters

DataType

Parameters

key: TypedKey<DataType>

data: DataType

Optional options: EmitOptions

Returns void

init

Returns Promise<void>

Class Part<StateType>`Abstract`

`Private` `Optional` _attachedElement

`Private` `Optional` _mountElement

`Protected` _attachEventListeners

`Private` _markClean

`Private` _requestFrame

`Private` _setNeedsEventListeners

`Private` _update

`Private` addDomListener

`Optional` options: EmitOptions

`Static` mount

`Optional` mountOptions: MountOptions