Introduction

This package is the javascript client for LiveState channels. LiveState channels are Phoenix Channels which manage state for connected web clients.

This library is organized in layers of increasing levels of abstraction.

LiveState

This is the lowest level of abstraction for connecting to LiveState. It is typically, but not necessarily, used by framework integrations.

connectElement

This is a function designed to connect a Custom Element to LiveState

liveState

This is a decorator function for CustomElement classes which leverages connectElement