React Popup Getting Started

This guide provides essential information about using the KendoReact Popup package—you will learn how to install the Popup package, add a Popup component to your project, style the component, and activate your license.

This is a Free React PopupThe KendoReact Popup is free to use, including in production—no sign-up or license required. Check out all 120+ free and premium UI components in the enterprise-grade KendoReact library.

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

Change Theme

Theme

Loading ...

Before You Begin

npm create vite@latest my-app -- --template react

This guide requires that you have basic knowledge of React and TypeScript, and that you have already created a blank React project.

You can speed up the development of your KendoReact application with the Kendo UI Template Wizard for Visual Studio Code.

Install the Component

npm i @progress/kendo-react-popup @progress/kendo-theme-default

Run these commands in the root of your React project to install the KendoReact Popup package and the Kendo UI Default theme.

Note that kendo-react-buttons is not a direct dependency for the Popup component. The workflow of this guide requires that you also install and use a Button component to trigger the Popup.

Import the Component

After installing the Popup npm package, import the Popup and Button components. While the Button is not required for the Popup, it is needed for this tutorial.

In the App component file of your React project (for example, src/App.tsx), add the following code:

tsx

// ES2015 module syntax
import { Popup } from '@progress/kendo-react-popup';
import { Button } from '@progress/kendo-react-buttons';

tsx

// CommonJS format
const { Popup } = require('@progress/kendo-react-popup');
const { Button } = require('@progress/kendo-react-buttons');

Use the Component

After installing the Popup package add a button to the App component of your React project (for example, src/App.tsx) that will be used as an anchor of the Popup. You will also use the button to open and close the Popup on click.
tsx
```
<Button type="button" onClick={onClick} ref={anchor}>
    {show ? 'Hide' : 'Show'}
</Button>
```
Create a reference to the button element.
tsx
```
const anchor = React.useRef(null);
```

Handle the button onClick event to toggle the Popup.

tsx

const onClick = () => {
    setShow(!show);
};

Create a state variable to control when the Popup opens.
tsx
```
const [show, setShow] = React.useState(false);
```

Add the Popup markup to the App component.

tsx

<Button type="button" onClick={onClick} ref={anchor}>
    {show ? 'Hide' : 'Show'}
</Button>
<Popup
  anchor={anchor.current && anchor.current.element}
  show={show}
  popupClass={'popup-content'}
>
    Popup content.
</Popup>

Navigate to http://localhost:3000 to see the KendoReact Popup component on the page.

Style the Components

Are you looking for guidance around how to create visually appealing and consistent user interfaces with Telerik UI components? Check out the Progress Design System.

With the import "@progress/kendo-theme-default/dist/all.css"; statement present in your code, you already have professionally designed styling applied to your app out-of-box. You can also try any of the other available Kendo UI Themes.

Popup API

The Popup 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-popup-common	Contains shared Popup logic.
@progress/kendo-react-common	Contains common utilities that enhance the performance and functionalities of the KendoReact UI components.