kalendra

KalendraBookingCalendar React Component

KalendraCalendar is a themeable and customizable booking component built for managing events with features such as user-specific responses, event booking, with success and error handling. This component can be used in any React-based project and allows seamless integration with your application's and Kalendra scheduling platform.

Installation

To install the package, use npm or yarn:

npm install kalendra
# or
yarn add kalendra

Usage

Below is an example of how to use the KalendraCalendar component in your React application.

Importing the Component

import { KalendraCalendar } from "kalendra";

Example Usage

import React, { useState } from "react";
import { useNavigate } from "react-router-dom";
import { KalendraCalendar } from "kalendra"; // Import the component
import { parentActions } from "./store/actions"; // Replace with actual path to your actions

const CalendarExample = ({
  theme,
  event_type_id,
  kalendra_user_id,
  userInfo,
  metadata,
  duration,
  user,
}) => {
  const navigate = useNavigate();
  const [isSuccess, setIsSuccess] = useState(false);

  return (
    <KalendraCalendar
      styles={{
        border: theme.borders[1],
        borderRadius: theme.radii[1],
      }}
      eventTypeId={event_type_id}
      kalendra_user_id={kalendra_user_id}
      onSuccess={onSuccess}
      onError={onError}
      responses={{
        name: "name"
        email: "[e-mail]",
        "phone-number": "12345678",
      }}
      duration={duration}
    />
  );
};

export default CalendarExample;

Props

The KalendraCalendar component accepts the following props:

• styles (object) - Custom CSS styles for the calendar component (optional).
  • Example: { border: '1px solid #ccc', borderRadius: '8px' }
• eventTypeId (string) - The ID of the event type to be displayed in the calendar from the kalendra event types you created.
• kalendra_user_id (string) - The unique user ID associated with the kalendra user.
• onSuccess (function) - Callback function to be executed when the event is successfully added or processed.
• onError (function) - Callback function to be executed when there is an error during the event handling.
• responses (object) - To auto populate event questions if you have any.
  • Example:

    {
      name: 'John Doe',
      email: '[e-mail]',
      'phone-number': '555-555-5555',
    }
    

• duration (number) - Duration of the event in minutes (optional) used to auto populate the event duration.
• LoadingIndicator (JSX) - (Optional) A custom loading component to be displayed while the calendar is loading.
• NoEventError (JSX) - (Optional) A custom component to be displayed when there are no events to display or when something goes wrong.

Example of responses Object:

The responses object should contain necessary user and event data. It could look like this:

responses={{
  name: userInfo?.user?.full_name || userInfo?.full_name || '',
  email: userInfo?.user?.email || userInfo?.email || '',
  'db-email': userInfo?.user?.email || userInfo?.email || '',
  'profile-id': userInfo?.id || '',
  'phone-number': userInfo?.user?.phone_number || user.phone_number || '',
  'recording-consent-metadata': JSON.stringify(metadata || {}),
  session_uuid: uuid4(),
}}

Success and Error Callbacks

The onSuccess and onError callbacks allow you to handle the outcome of the calendar interaction:

• onSuccess: Triggered when the calendar operation completes successfully. It’s a good place to dispatch state updates or trigger side effects like navigation.
• onError: Triggered if something goes wrong. You can use this callback to show an error message or handle any failures gracefully.

Example of onSuccess Usage:

onSuccess={(response) => {
  console.log(response);
  setIsSuccess(true);
  navigate?.();
}}

Example of onError Usage:

onError={(error) => {
  console.log(error);
  showToast({
    message: 'Something went wrong',
    type: 'error',
  });
}}

Additional Notes

• The styles prop allows for full customization of the calendar's border and radius using your app's theme. Simply pass an object with the desired CSS properties.
• duration should be passed as a number representing the duration of the event in minutes.
• Make sure to manage the state and the responses object dynamically depending on the user's data or application context.

Dependencies

• uuid: Ensure you have the uuid library installed for generating unique session IDs.

  npm install uuid
  # or
  yarn add uuid
  

• react-redux: Used for dispatching actions (if you're using Redux).

  npm install react-redux
  # or
  yarn add react-redux
  

• react-router-dom: For navigation handling, if your application uses it.

  npm install react-router-dom
  # or
  yarn add react-router-dom
  

Theming

// Example theme (Our dark theme)
// You can create your own theme by modifying this object
// And create dark or light as you like or any other theme
export const lightTheme = {
  breakpoints: ["320px", "576px", "768px", "992px", "1200px", "1400px"],
  colors: {
    rootLoaderColor: "#ffa516", // The color of the loader when the KalendraCalander is initializing
    background: "white",
    border: "#cbd5e1",
    lightGray: "#cbd5e1",
    text: "black",
    headCell: "black",
    dayHoverBg: "#3b3b4f",
    dayHoverText: "white",
    daySelectedBg: "#1e293b",
    daySelectedText: "#f8fafc",
    dayDisabled: "#cbd5e1",
    dayRangeMiddle: "#475569",
    icon: "#475569",
    transparent: "transparent",
    dayBg: "#cbd5e1",
    error: "#f87171",
  },
};

License

This software is under a Commercial Software License.

📩 For licensing and inquiries, contact: [e-mail]
📄 See the full license in the LICENSE file.