Getting Started with the KendoReact Popup

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.


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

Example
View Source
Change Theme:

Setting Up Your React Project

Before you install the KendoReact Popup, make sure that you have a running React project. The easiest way to set up a React project is to use the Create React App approach that is described in the Get Started with KendoReact article.

Installing the Popup Package

All KendoReact packages are distributed through npm and offer a similar installation experience. To use the Popup component, start with the installation of the Popup npm package and its dependencies. Use Node.js v5.0.0 or later.

npm install --save @progress/kendo-react-popup @progress/kendo-licensing

Importing the Component

After installing the package, import the Popup component in the React App.

In the src/App.js file of your React project, import the Popup component from the Popup package.

// ES2015 module syntax
import { Popup } from "@progress/kendo-react-popup";
// CommonJS format
const { Popup } = require('@progress/kendo-react-popup');

Using the Component

  1. Add a button that you will use as an anchor of the Popup. You will also use the button to open and close the Popup on click.

        <button
            className="k-button k-button-md k-rounded-md k-button-solid k-button-solid-base"
            onClick={onClick}
            ref={anchor}
        >
            {show ? 'Hide' : 'Show'}
        </button>
        ```
    
  2. Create a reference to the button element.

        const anchor = React.useRef();
  3. Handle the button onClick event to toggle the Popup.

        const onClick = () => {
        setShow(!show);
        }
  4. Create a state variable to control when the Popup opens.

        const [show, setShow] = React.useState(false);
  5. Add the Popup markup to the App component.

        <button
            className="k-button k-button-md k-rounded-md k-button-solid k-button-solid-base"
            onClick={onClick}
            ref={anchor}
        >
            {show ? 'Hide' : 'Show'}
        </button>
        <Popup
            anchor={anchor.current}
            show={show}
            popupClass={'popup-content'}
        >
            Popup content.
        </Popup>
  6. To style the Popup, install and import the Default theme, which is one of the three beautiful themes for KendoReact.

    6.1. Install the Default theme package.

    npm install --save @progress/kendo-theme-default

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

    import '@progress/kendo-theme-default/dist/all.css';
  7. Build and run the application by typing the following command in the root folder of your project:

    npm start
  8. Navigate to http://localhost:3000 to see the KendoReact Popup 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 Popup package requires you to install the following peer dependencies in your application:

Package NameDescription
react 16.8.2*Contains the functionality necessary to define React components.
react-domContains the React renderer for the web.
@progress/kendo-licensingContains the internal infrastructure related to licensing.

Learning Resources