@ssmirnovacode/calendar

Light-weight simple Calendar React.js component.

• date formatting based on locale;
• customizable and responsive layout and styles;
• number of months to be displayed can be easily changed;
• customized captions each date (e.g. prices, notes etc)

Setup

npm install @ssmirnovacode/calendar

Usage

Calendar can be configured with two possible options:

• 2 dates as a range (suitable for purposes like hotel booking, car renting etc);
• single date (ideal for appointment management and all other cases when only 1 date should be selected):

Range of 2 dates option:

import { Calendar } from "@ssmirnovacode/calendar";

const App = () => {
  const [selectedDates, setSelectedDates] = useState({
    startDate: new Date(2022, 2, 21),
    endDate: new Date(),
  });

  const THEME = {
    color: "#0f1721",
    bgc: "white",
  };

  const CAPTIONS_WITH_PRICES = {
    "2022-04-04": "123 USD",
    "2022-04-06": "125 USD",
    "2022-04-07": "121 USD",
  };

  return (
    <>
      <Calendar
        numberOfMonths={2}
        arrows
        startDate={selectedDates.startDate}
        endDate={selectedDates.endDate}
        onChange={setSelectedDates}
        locale={"es-ES"}
        theme={THEME}
        clearDatesBtn
        weekendsStyled
        captions={CAPTIONS_WITH_PRICES}
      />
    </>
  );
};

Single date option:

import { Calendar } from "@ssmirnovacode/calendar";

const App = () => {
  const [date, setDate] = useState(new Date());

  const THEME = {
    color: "#0f1721",
    bgc: "white",
  };

  return (
    <>
      <Calendar
        numberOfMonths={2}
        arrows
        singleDate
        startDate={date}
        onChange={setDate}
        theme={THEME}
        weekendsStyled
      />
    </>
  );
};

Properties

Following properties can be passed to Calendar component:

• arrows boolean indicating if to render previous/next arrow buttons (false by default);
• blockedDates* array of strings: dates to be blocked, in 'YYYY-MM-DD' format (should only be used with availableDates undefined, otherwise all dates will be treated as available);
• availableDates* array of strings: dates to be available, in 'YYYY-MM-DD' format (should only be used with blockedDates undefined, otherwise all dates will be treated as available);
• captions - object with date strings in 'YYYY-MM-DD' format as keys and caption text for each date as values;
• clearDatesBtn boolean indicating if to render 'Clear dates' button or numberOfMonths;
• disablePast boolean: if true shows past dates as blocked (false by default)
• locale locale string ('en-US' by default);
• numberOfMonths number of months to be rendered (2 by default);
• onChange REQUIRED! a function to be ejecuted when dates are selected;
• singleDate boolean: if true only one date can be selected (false by default, endDate prop is not needed in this case)
• startDate REQUIRED! and endDate javascript Date Objects;
• theme an object with specific keys defining the theme for the component to override default styles
• vertical boolean enabling vertical layout without arrows (false by default). Enabled for XS and S screens automatically as part of responsive design;
• weekendsBlocked boolean: if true weekends will be displayed with the same styles as blocked dates and will not be clickable;
• weekendsStyled boolean: if true speficic styles will be applied to weekends cells (can be customized with weekendColor and weekendBgc keys of theme configuration object);

Properties assertion at runtime

The properties are defined by CalendarProps interface exported from the library:

interface CalendarProps {
  numberOfMonths?: number;
  arrows?: boolean;
  startDate: Date | undefined;
  endDate: Date | undefined;
  onChange: (dates: SelectedDates) => void;
  locale?: string;
  theme?: Theme;
  clearDatesBtn?: boolean;
  vertical?: boolean;
  blockedDates?: string[];
  availableDates?: string[];
  weekendsBlocked?: boolean;
  weekendsStyled?: boolean;
  captions?: { [key: string]: string };
  singleDate?: boolean;
  disablePast?: boolean;
}

If the props are passed incorrectly, the component will throw a runtime error with explanatory warnings in the console about each property that was found invalid.

Theme

Default style variables can be modified by passing an theme object with specific keys as in the following example (also suggesting a nice darkmode theme palette):

// nice dark mode theme settings
const FONT_COLOR = "#E9A6A6";
const BGC = "#1F1D36";
const BGC_OTHER = "#3F3351";
const ACCENT = "#864879";

// configuration object to be passed as 'theme' prop
const DARK_THEME = {
  betweenColor: FONT_COLOR,
  betweenBg: BGC_OTHER,
  bgc: BGC,
  blockedColor: ACCENT,
  blockedBg: BGC,
  borderColor: BGC,
  captionFz: "12px", // captions font-size
  cellSize: "30px",
  color: FONT_COLOR,
  danger: ACCENT,
  fontFamily: '"Helvetica", sans-serif',
  fz: "16px", // basic font-size
  gap: "2rem", // flex gap between months
  hoverColor: BGC,
  hoverBg: FONT_COLOR,
  maxWidth: "800px", // max calendar block width
  padding: "2rem",
  selectedColor: BGC,
  selectedBg: ACCENT,
  weekendColor: ACCENT,
  weekendBg: BGC,
};

Values are to be passed as usual CSS values.

Additional styles can be also added by custom CSS.

Themes

Dark mode lila:

const FONT_COLOR = "#E9A6A6";
const BGC = "#1F1D36";
const BGC_OTHER = "#3F3351";
const ACCENT = "#864879";

Pink Pastel:

const FONT_COLOR = "#874356";
const BGC = "#F6E7D8";
const BGC_OTHER = "#F68989";
const ACCENT = "#C65D7B";

links

GitHub repository: (https://github.com/ssmirnovacode/mini-calendar)