Home Reference Source

References

summary
public

The wrapping constructor module which renders ReactWebChatComponent to the target element

public

The main react component for React Web Chat

actions

summary
public

F attempted(_: *): {type: CONNECTION_ATTEMPTED}

Sets connection to attempted

public

F dropped(_: *): {type: CONNECTION_DROPPED}

Sets connection to offline

public

F established(_: *): {type: CONNECTION_ESTABLISHED}

Sets connection to established

public

F listening(_: *): {type: CONNECTION_LISTENING}

Sets connection to listening

public

Async action creator: Adds a new message after a delay of 1200 milliseconds.

public

F messageAdd(message: object): {type: MESSAGE_ADD}

Action creator: Adds a message to the store.

public

F messageReceive(message: object): function()

Async action creator: Dispatched when a message is received from the server.

public

F messageSend(message: object): function()

Async action creator: Dispatched when a message is received from the server.

components/AvatarContainer

summary
public

F AvatarContainer(objectPattern: {"AvatarComponent": *, "connection": *, "typing": *}): *

components/ButtonContainer

summary
public

F ButtonContainer(objectPattern: {"children": *}): *

components/ChatContainer

summary
public

F ChatContainer(objectPattern: {"theme": *, "connection": *}): *

components/InputArea

summary
public

F InputArea(objectPattern: {"InputComponent": *, "submitHandler": *, "inputExpected": *, "MenuComponent": *, "CheckboxMenuComponent": *, "buttons": *}): *

components/Message

summary
public

F Message(objectPattern: {"page": *, "isLocal": *, "ImageComponent": *, "InputComponent": *, "MessageComponent": *, "TextComponent": *, "ButtonComponent": *, "submitHandler": *}): undefined[]

components/MessageContainer

summary
public

F MessageContainer(objectPattern: {"userId": *, "type": *, "children": *, "layout": *, "origin": *, "pages": *, ...rest: Object}): *

middleware

summary
public

Automatically dispatches custom events whenever a redux action is dispatched.

themes/default/components/Animation

summary
public

F Fade(objectPattern: {"children": *, ...props: Object})

themes/default/components/Avatar

summary
public

F Avatar(props: Object): Object

Renders the chat bot's avatar along with a status indicator.

themes/default/components/Button

summary
public

F Button(param: Object): Object

A simple button component

themes/default/components/Image

summary
public

An image

themes/default/components/Input

summary
public

F Input(param: Object): Object

A simple text Input component.

themes/default/components/Menu

summary
public

F Menu(param: Object): Object

A menu listing several items.

public

V CheckboxMenu(param: Object): Object: *

A menu listing several checkbox items.

themes/default/components/TypingIndicator

summary
public

A typing indicator component

utils

summary
public

F remoteMessage(message: Object)

Checks if a message belongs to remote

public

F getLatestRemote(messages: Array)

Returns the latest remote message

public

Network manager that handles message sending and receiving.