Function usePixelProp

  • usePixelProp<T>(pixel, prop): PixelMutableProps[T] | undefined

  • React Hook that updates when the given Pixel's prop changes.

    Type Parameters

    • T extends
          | "name"
          | "status"
          | "batteryLevel"
          | "rssi"
          | "systemId"
          | "pixelId"
          | "ledCount"
          | "colorway"
          | "dieType"
          | "firmwareDate"
          | "isCharging"
          | "rollState"
          | "currentFace"
          | "currentFaceIndex"
          | (keyof PixelOwnMutableProps)

    Parameters

    • pixel: undefined | Pixel

      The Pixel for which to watch the prop.

    • prop: T

      The prop to watch.

    Returns PixelMutableProps[T] | undefined

    The current value of the given prop on the given Pixel.

    Remarks

    Use usePixelEvent to watch the RSSI value.

Settings

Member Visibility