Getting Started with the KendoReact Ripple

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

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

Setting Up Your React Project

Before you install the KendoReact Ripple, 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 Ripple Package

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

Copy Codenpm install --save @progress/kendo-react-ripple @progress/kendo-licensing

Importing the Component

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

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

Copy Code// ES2015 module syntax
import { Ripple } from "@progress/kendo-ripple";

Copy Code// CommonJS format
const { Ripple } = require('@progress/kendo-react-ripple');

Using the Component

1. Add a button element on the page. You will add a ripple effect over it.

   Copy Code    <button className="k-button k-button-md k-rounded-md k-button-solid k-button-solid-base mt-3 mb-1">
           Click Me
       </button>

2. Wrap the button element with the Ripple component. That will add the effect on click.

   Copy Code    <Ripple>
           <button className="k-button k-button-md k-rounded-md k-button-solid k-button-solid-base mt-3 mb-1">
               Click Me
           </button>
       </Ripple>

3. To style the Ripple, install and import the Default theme, which is one of the three beautiful themes for KendoReact.

   3.1. Install the Default theme package.

   Copy Codenpm install --save @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.

   Copy Codeimport '@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:

   Copy Codenpm start

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

Suggested Links

• API Reference of the Ripple

Learning Resources

• Getting Started with KendoReact
• Virtual Classroom (Introductory Course Available to Trial and Commercial License Holders)
• Explore the Finance Portfolio Sample Application
• Explore the Coffee Warehouse Sample Application
• Explore the Github Issues Grid Sample Application