Getting Started with the KendoReact Inline AI Prompt

Premium

This guide provides essential information about using the KendoReact Inline AI Prompt component. You will learn how to install the Conversational UI package that provides the Inline AI Prompt. Then, you will add an Inline AI Prompt component to your project, style the component, and activate your license.

After completing this guide, you will be able to reproduce the following example.

Change Theme

Theme

Loading ...

Setting Up Your React Project

Before you install the KendoReact Conversational UI package, which contains the Inline AI Prompt component, make sure that you have a running React project. The easiest way to set up a KendoReact project is to use the Create KendoReact App approach that is described in the Get Started with KendoReact article.

Installing the Conversational UI Package

All KendoReact packages are distributed through npm and offer a similar installation experience. To use the Inline AI Prompt component, start with the installation of the Conversational UI npm package and its dependencies. Use NodeJS LTS (or a version >= 14).

sh

npm i @progress/kendo-react-conversational-ui

Importing the Component

After installing the package, import the Inline AI Prompt component in the React App.

In the src/App.js file of your React project, import the InlineAIPrompt from the Conversational UI package.

jsx

// ES2015 module syntax
import { InlineAIPrompt } from '@progress/kendo-react-conversational-ui';

jsx

// CommonJS format
const { InlineAIPrompt } = require('@progress/kendo-react-conversational-ui');

Using the Component

1. Define the InlineAIPrompt component and configure its basic properties:

   jsx

   <InlineAIPrompt
       show={showPrompt}
       onClose={() => setShowPrompt(false)}
       outputs={outputs}
       onPromptRequest={handlePromptRequest}
   />

2. Next, handle the onPromptRequest which is triggered when the user submits a prompt, and configure the outputs to display AI responses:

   jsx

   const [outputs, setOutputs] = useState([]);
   const [showPrompt, setShowPrompt] = useState(false);
   
   const handlePromptRequest = async (prompt) => {
       try {
           // Replace with your AI service call
           const response = await fetch('/api/ai-chat', {
               method: 'POST',
               headers: { 'Content-Type': 'application/json' },
               body: JSON.stringify({ prompt })
           });
   
           const data = await response.json();
   
           const newOutput = {
               id: Date.now(),
               prompt,
               responseContent: data.response
           };
   
           setOutputs([newOutput]);
       } catch (error) {
           console.error('AI request failed:', error);
       }
   };

3. To style the Inline AI Prompt, install and import the Default theme, which is one of the four beautiful themes for KendoReact.

   3.1. Install the Default theme package.

   sh

   npm i @progress/kendo-theme-default

   3.2. Import the CSS file from the package in src/App.js. Add this import before your existing App.css import.

   jsx

   import '@progress/kendo-theme-default/dist/all.css';

4. Build and run the application by typing the following command in the root folder of your project:

   sh

   npm start

5. Navigate to http://localhost:3000 to see the KendoReact Inline AI Prompt component on the page.

Activating Your License Key

Using any of the UI components in the KendoReact library requires either a commercial license key or an active trial license key.

Follow the instructions on the KendoReact My License page to activate your trial or commercial license. You can skip this step if your application already contains a KendoReact license file.

Dependencies

The Conversational UI package requires you to install the following peer dependencies in your application:

Package Name	Description
react 16.8.2*	Contains the functionality necessary to define React components.
react-dom	Contains the React renderer for the web.
@progress/kendo-licensing	Contains the internal infrastructure related to licensing.
@progress/kendo-react-buttons	Contains the KendoReact Buttons components.
@progress/kendo-react-intl	Contains the KendoReact Internationalization package that applies the desired cultures by providing services and pipes for the parsing and formatting of dates and numbers.
@progress/kendo-svg-icons	Contains the KendoReact SVG icons.

Suggested Links

• Getting Started with the KendoReact Conversational UI Package
• API Reference of the KendoReact Inline AI Prompt
• API Reference of the InlineAIPromptProps