1.0.82 • Published 2 years ago

@hoory/embed v1.0.82

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

Installation

yarn add @hoory/embed

Getting started

Simply put this hook in your app layout or main file, and it will load the embedded chat on your website.

import { useEffect } from "react";
import { useHoory } from "@hoory/embed";

export default function App() {
  const { isScriptLoaded, isChatInitialized } = useHoory("SLUG");

  useEffect(() => {
    if (isScriptLoaded) {
      window.hoory.openChat();
    }
  }, [isScriptLoaded]);

  return (
    <div className="App">
      <h1>Hoory script is {isScriptLoaded ? "isInitialized" : "not isInitialized"}</h1>
    </div>
  );
}

Also, you can pass additional options as second parameter to useHoory hook and control the widget.

type Options = {
  env?: "DEV" | "PROD";
  forceCacheClean?: boolean;
  initializeHidden?: boolean;
  forceChatInit?: boolean;
  user?: {
    firstName?: string;
    lastName?: string;
    email?: string;
    avatar?: string;
  };
  onChatOpen?: () => void;
  onChatClose?: () => void;
  onShowButton?: () => void;
  onHideButton?: () => void;
  onChatInit?: () => void;
  onScriptLoad?: () => void;
};

const api = useHoory('SLUG', options);  

on the other hand, you can use the object returned from this hook in order to control the widget:

const {
  isScriptLoaded,
  isChatInitialized,
  // Functions
  showButton,
  hideButton,
  openChat,
  closeChat,
  setUserInfo,
  // Listeners
  onChatOpen,
  onChatClose,
  onShowButton,
  onHideButton,
  onChatInit,
  onScriptLoad,
} = useHoory("WORKSPACE");

API

Contributing Guidelines

Read through our Contributing guidelines to learn about our submission process, coding rules and more

1.0.62

2 years ago

1.0.61

2 years ago

1.0.60

2 years ago

1.0.66

2 years ago

1.0.65

2 years ago

1.0.64

2 years ago

1.0.63

2 years ago

1.0.69

2 years ago

1.0.68

2 years ago

1.0.67

2 years ago

1.0.73

2 years ago

1.0.72

2 years ago

1.0.71

2 years ago

1.0.70

2 years ago

1.0.77

2 years ago

1.0.76

2 years ago

1.0.75

2 years ago

1.0.74

2 years ago

1.0.79

2 years ago

1.0.78

2 years ago

1.0.80

2 years ago

1.0.82

2 years ago

1.0.81

2 years ago

1.0.48

2 years ago

1.0.47

2 years ago

1.0.46

2 years ago

1.0.49

2 years ago

1.0.51

2 years ago

1.0.50

2 years ago

1.0.55

2 years ago

1.0.54

2 years ago

1.0.53

2 years ago

1.0.52

2 years ago

1.0.59

2 years ago

1.0.58

2 years ago

1.0.57

2 years ago

1.0.56

2 years ago

1.0.45

2 years ago

1.0.44

2 years ago

1.0.43

2 years ago

1.0.42

2 years ago

1.0.41

2 years ago

1.0.40

2 years ago

1.0.39

2 years ago

1.0.38

2 years ago

1.0.37

2 years ago

1.0.36

2 years ago

1.0.35

2 years ago

1.0.34

2 years ago

1.0.33

2 years ago

1.0.32

2 years ago

1.0.31

2 years ago

1.0.29

2 years ago

1.0.28

2 years ago

1.0.27

2 years ago

1.0.26

2 years ago

1.0.25

2 years ago

1.0.24

2 years ago

1.0.23

2 years ago

1.0.22

2 years ago

1.0.21

2 years ago

1.0.20

2 years ago

1.0.19

2 years ago

1.0.18

2 years ago

1.0.17

2 years ago

1.0.16

2 years ago

1.0.15

2 years ago

1.0.14

2 years ago

1.0.13

2 years ago

1.0.12

2 years ago

1.0.11

2 years ago

1.0.10

2 years ago

1.0.9

2 years ago

1.0.8

2 years ago

1.0.7

2 years ago

1.0.6

2 years ago

1.0.5

2 years ago

1.0.4

2 years ago

1.0.3

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago