Options
All
  • Public
  • Public/Protected
  • All
Menu

@bytesoftio/use-value

Installation

yarn add @bytesoftio/use-value or npm install @bytesoftio/use-value

Table of contents

Description

This package provides a React integration for @bytesoftio/value.

useValue

This helper can be used to hook up a value inside a component.

import React from "react"
import { createValue } from "@bytesoftio/value"
import { useValue } from "@bytesoftio/use-value"

const globalCount = createValue(0)

const Component = () => {
  // hook up a new value, creates a new instance of ObservableValue behind the scenes
  const count1 = useValue(0)
  // use an initializer / factory
  const count2 = useValue(() => 0)
  // use an existing instance of ObservableValue
  const count3 = useValue(globalCount)

  const increment = () => count1.set(count1 + 1)

  return <button onClick={increment}>count: {count1.get()}</button>
}

Index

Type aliases

Functions

Type aliases

UseValue

UseValue: <TValue>(initialValue: ValueInitializer<TValue | ObservableValue<TValue>>) => ObservableValue<TValue>

Type declaration

    • <TValue>(initialValue: ValueInitializer<TValue | ObservableValue<TValue>>): ObservableValue<TValue>
    • Type parameters

      • TValue

      Parameters

      Returns ObservableValue<TValue>

ValueInitializer

ValueInitializer<TValue>: TValue | (() => TValue)

Type parameters

  • TValue

Functions

Const useValue

  • useValue<TValue>(initialValue: any): ObservableValue<TValue>
  • Type parameters

    • TValue

    Parameters

    • initialValue: any

    Returns ObservableValue<TValue>