Toppr Ask-Expert-Byjus

This is a React library which can be used for interacting with the tutors for doubt resolution of the students.

To install the package, run the following command in the terminal

npm install @toppr-engg/ask-expert-byjus

or

yarn add @toppr-engg/ask-expert-byjus

Install the Peer Dependencies in your project

yarn add react react-dom react-redux redux redux-saga

import AskExpert from '@toppr-engg/ask-expert-byjus'
function App() {
  return (
    <AskExpert
      clientId={clientId} //required --> string
      token={token} //required --> string
      apiBaseUrl={apiBaseUrl} //optional --> string
      imageSelectCallback={imageSelectCallback} //required --> function --> To invoke camera flow from chat window for client handling
      chatImage={chatImage} //optional --> object --> image Data from doc upload to render image in chat window
      onDoubtLimitExceeded={onDoubtLimitExceeded} //optional --> function --> Invoked when set doubt limits are over for the month
      onLiveSessionsExceeded={onLiveSessionsExceeded} // optional -> function -> Invokes when live sessions are exceeded beyond set limit( three at present )
      queryImage={queryImage} //optional --> object --> object --> image Data from doc upload to start a new doubt session from that image
      queryText={queryText} //optional --> string --> A query string to start a new tutor session with that as a question
      subjectList={subjectList} //required --> array of strings --> Array of subject names to be passed to show some or all of those subjects in the subject selection screen
      subjectId={subjectId} //optional --> numeric ID --> To set this subject as selected initially when the subject selection screen is opened
      showSessionList={showSessionList} //optional --> boolean --> To render the session list for that instance
      onModalCloseCallback={onModalCloseCallback} // To handle event related to close of Ask Expert
    />
  )
}

clientId and token are to be generated by tenant app

For the Subject Confidence Flow, if the confidence is high then send the subjectId as a prop and through that the new session will be automatically created for the subject and the chat screen will open. If subjectId is not passed then the manual subject selection screen will be shown.