Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LocalStorageChanged<TValue>

Used for creating new events for LocalStorage. This enables us to have the ability of updating the LocalStorage from outside of the component, but still update the component without prop drilling or creating a dependency on a large library such as Redux.

class

LocalStorageChanged

extends

{CustomEvent<KVP<string, string>>}

Type parameters

  • TValue

Hierarchy

  • CustomEvent<KVP<string, TValue>>
    • LocalStorageChanged

Index

Constructors

constructor

Properties

AT_TARGET

AT_TARGET: number

BUBBLING_PHASE

BUBBLING_PHASE: number

CAPTURING_PHASE

CAPTURING_PHASE: number

NONE

NONE: number

bubbles

bubbles: boolean

Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.

cancelBubble

cancelBubble: boolean

cancelable

cancelable: boolean

composed

composed: boolean

Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

currentTarget

currentTarget: EventTarget | null

Returns the object whose event listener's callback is currently being invoked.

defaultPrevented

defaultPrevented: boolean

detail

detail: KVP<string, TValue>

Returns any custom data event was created with. Typically used for synthetic events.

eventPhase

eventPhase: number

isTrusted

isTrusted: boolean

Returns true if event was dispatched by the user agent, and false otherwise.

returnValue

returnValue: boolean

srcElement

srcElement: Element | null
deprecated

target

target: EventTarget | null

Returns the object to which event is dispatched (its target).

timeStamp

timeStamp: number

Returns the event's timestamp as the number of milliseconds measured relative to the time origin.

type

type: string

Returns the type of event, e.g. "click", "hashchange", or "submit".

Static CustomEvent

CustomEvent: object

Type declaration

  • constructor: function
    • new __type<T>(typeArg: string, eventInitDict?: CustomEventInit<T>): CustomEvent<T>
    • Type parameters

      • T

      Parameters

      • typeArg: string
      • Optional eventInitDict: CustomEventInit<T>

      Returns CustomEvent<T>

  • prototype: CustomEvent

Static eventName

eventName: string = "onLocalStorageChange"

Methods

composedPath

  • composedPath(): EventTarget[]
  • Returns EventTarget[]

initCustomEvent

  • initCustomEvent(typeArg: string, canBubbleArg: boolean, cancelableArg: boolean, detailArg: KVP<string, TValue>): void
  • Parameters

    • typeArg: string
    • canBubbleArg: boolean
    • cancelableArg: boolean
    • detailArg: KVP<string, TValue>

    Returns void

initEvent

  • initEvent(type: string, bubbles?: undefined | false | true, cancelable?: undefined | false | true): void
  • Parameters

    • type: string
    • Optional bubbles: undefined | false | true
    • Optional cancelable: undefined | false | true

    Returns void

preventDefault

  • preventDefault(): void
  • Returns void

stopImmediatePropagation

  • stopImmediatePropagation(): void
  • Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.

    Returns void

stopPropagation

  • stopPropagation(): void
  • When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.

    Returns void

Generated using TypeDoc