Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Product<A, A>

Type parameters

  • A: object

  • A: object

Hierarchy

  • Tag<Props, State>
    • Product

Index

Type aliases

Static Transform

Transform: object | string[] | function

Properties

Optional _aliases

_aliases: object

_consumes

_consumes: string[]

_eventHandlers

_eventHandlers: [string, function][]

_lookups

_lookups: [string[], function][]

_provides

_provides: Record<string, function>

_removeEventHandlers

_removeEventHandlers: function

Type declaration

    • (): void
    • Returns void

_removeLookups

_removeLookups: function

Type declaration

    • (): void
    • Returns void

_riot_id

_riot_id: number

actions

actions: ActionCreators

config

config: Configuration

flux

flux: FluxCapacitor

isInitialized

isInitialized: boolean

isMounted

isMounted: boolean

log

log: Log

opts

opts: Props

Optional parent

parent: TagInstance

the parent tag if any

refs

refs: TagRefs

References to tags or DOM elements

root

root: HTMLElement

services

services: SystemServices

tags

tags: NestedTags

nested custom tags

Methods

consume

  • consume(alias: string): void
  • Parameters

    • alias: string

    Returns void

dispatch

  • dispatch(action: Action<string, any>): void
  • Parameters

    • action: Action<string, any>

    Returns void

expose

  • expose(alias: string, value?: any): void
  • Parameters

    • alias: string
    • Optional value: any

    Returns void

init

  • init(): void

mixin

  • mixin(mixin: string | TagMixin): void
  • Extend tag with functionality available on shared mixin registered with riot.mixin(mixinName, mixinObject) or extend tag functionality with functionality available on provided mixin object.

    Parameters

    • mixin: string | TagMixin

      Name of shared mixin or mixin object

    Returns void

mount

  • mount(): void
  • Mount the tag

    Returns void

off

  • off(event: string, callback?: ObservableCallback): this
  • For specified event remove specified callback or all registered callbacks if callback is not passed in

    Parameters

    • event: string

      Event name or wildcard '*' that matches all events

    • Optional callback: ObservableCallback

      Callback function to remove

    Returns this

on

  • on(event: string, callback: ObservableCallback): this
  • Register callback for specified events. Callback is executed each time event is triggered

    Parameters

    • event: string

      Event name or wildcard '*' that matches all events

    • callback: ObservableCallback

      Callback function

    Returns this

onBeforeMount

  • onBeforeMount(): void
  • aliases are available here

    Returns void

onBeforeUnmount

  • onBeforeUnmount(): void
  • Returns void

onMount

  • onMount(): void
  • Returns void

onUnmount

  • onUnmount(): void
  • Returns void

onUpdate

  • onUpdate(): void

onUpdated

  • onUpdated(): void
  • Returns void

one

  • one(event: string, callback: ObservableCallback): this
  • Register callback for specified events. Callback is executed at most once.

    Parameters

    • event: string

      Event name.

    • callback: ObservableCallback

      Callback function

    Returns this

provide

  • provide(alias: string, resolve?: function): void
  • Parameters

    • alias: string
    • Optional resolve: function
        • (props: Props, state: State, aliases: A): void
        • Parameters

          • props: Props
          • state: State
          • aliases: A

          Returns void

    Returns void

select

  • select(selector: function, ...args: any[]): any
  • Parameters

    • selector: function
        • (state: State, ...args: any[]): any
        • Parameters

          • state: State
          • Rest ...args: any[]

          Returns any

    • Rest ...args: any[]

    Returns any

set

  • set(state: Partial<State> | true): void
  • Parameters

    • state: Partial<State> | true

    Returns void

shouldUpdate

  • shouldUpdate(stateChange: object, nextOpts: Props): boolean
  • Parameters

    • stateChange: object
    • nextOpts: Props

    Returns boolean

subscribe

  • subscribe<T>(event: string, handler: function): void
  • Invoke the callback provided each time the target event is emitted.

    All callbacks are automatically removed when the component is unmounted.

    Type parameters

    • T

    Parameters

    • event: string
    • handler: function
        • (data?: T): void
        • Parameters

          • Optional data: T

          Returns void

    Returns void

subscribeOnce

  • subscribeOnce(event: string, handler: function): void
  • Invoke the callback provided the next time the target event is emitted, then unregister it.

    Parameters

    • event: string
    • handler: function
        • (event: string, data?: any): void
        • Parameters

          • event: string
          • Optional data: any

          Returns void

    Returns void

subscribeWith

  • subscribeWith<T>(events: string[], handler: function): void
  • Invoke the callback provided each time the member events have been emitted at least once.

    All callbacks are automatically removed when the component is unmounted.

    Type parameters

    • T

    Parameters

    • events: string[]
    • handler: function
        • (data?: T): void
        • Parameters

          • Optional data: T

          Returns void

    Returns void

trigger

  • trigger(event: string, ...args: any[]): this
  • Execute all callback functions registered for specified list of events

    Parameters

    • event: string

      Event name

    • Rest ...args: any[]

      Arguments provided to callbacks

    Returns this

unexpose

  • unexpose(alias: string): void
  • Parameters

    • alias: string

    Returns void

unmount

  • unmount(keepTheParent?: boolean): void
  • Detach the tag and its children from the page.

    Parameters

    • Optional keepTheParent: boolean

      If true unmounting tag doesn't remove the parent tag

    Returns void

update

  • update(data?: any): void
  • Updates all the expressions on the current tag instance as well as on all the children.

    Parameters

    • Optional data: any

      Context data

    Returns void

updateAlias

  • updateAlias(alias: string, value: any): void
  • Parameters

    • alias: string
    • value: any

    Returns void

Static create

  • create(_riot: any): function
  • Parameters

    • _riot: any

    Returns function

      • (clazz: object): any
      • Parameters

        • clazz: object

        Returns any

Static findAliases

  • findAliases(tag: Tag, keys?: string[]): Record<string, object>
  • Parameters

    • tag: Tag
    • Optional keys: string[]

    Returns Record<string, object>

Static findAllAliases

  • findAllAliases(tag: Tag): Record<string, object>
  • Parameters

    • tag: Tag

    Returns Record<string, object>

Static findConsumes

  • findConsumes(tag: Tag & object): string[]
  • Parameters

    • tag: Tag & object

    Returns string[]

Static getDescription

  • getDescription(target: any): Description
  • Parameters

    • target: any

    Returns Description

Static getMeta

  • getMeta(tag: Tag): Metadata
  • extract tag metadata

    Parameters

    • tag: Tag

    Returns Metadata

Static getName

  • getName(tag: Tag): string
  • Parameters

    • tag: Tag

    Returns string

Static mixin

  • mixin(__namedParameters: object): Mixin
  • create a tag mixin

    Parameters

    • __namedParameters: object
      • config: Configuration
      • flux: FluxCapacitor
      • log: Log
      • services: CoreServices & object

    Returns Mixin

Static setDescription

  • setDescription(target: any, description: Description): Description
  • Parameters

    • target: any
    • description: Description

    Returns Description

Object literals

props

props: object

product

product: object

data

data: object

Type declaration

variants

variants: undefined[] = []

state

state: object

data

data: object

Type declaration

persistent

persistent: number = 0

variants

variants: undefined[] = []

link

  • link(): any

onClick

  • onClick(): void

onSelect

  • onSelect(index: number, persist: boolean): void

Generated using TypeDoc