# event_calendor

> Render a full-sized event calendar easily in your React projects.

Latest version **0.0.3** (published 2023-12-03) · 0 weekly downloads

## Install

```sh
npm install event_calendor
pnpm add event_calendor
yarn add event_calendor
bun add event_calendor
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2023-12-03 |
| First published | 2023-12-03 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM |
| Dependencies | 3 |
| Unpacked size | 15.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | abhishek_p_s |

## Links

- npm: https://www.npmjs.com/package/event_calendor
- Repository: https://github.com/abhishek-p-s/event_calendor_npm
- Homepage: https://github.com/abhishek-p-s/event_calendor_npm#readme
- Issues: https://github.com/abhishek-p-s/event_calendor_npm/issues
- npm.io page: https://npm.io/package/event_calendor

## Dependencies (3)

- [react](https://npm.io/package/react.md) ^18.2.0
- [react-dom](https://npm.io/package/react-dom.md) ^18.2.0
- [@iconify/react](https://npm.io/package/@iconify/react.md) ^4.1.1

## Recent versions

- 0.0.3 (latest) — 2023-12-03
- 0.0.2 — 2023-12-03
- 0.0.1 — 2023-12-03
- 0.0.0 — 2023-12-03

## README

# React Event Calendar

Render a full-sized event calendar easily in your React projects.

## Installation

Install the `event_calendor` package using npm:

```bash
npm install event_calendor

import { CustomCalendor } from 'event_calendor/src';
```
# Usage

import { CustomCalendor } from 'event_calendor/src';

// ...

<CustomCalendor />

# Displaying Events

import { CustomCalendor } from 'event_calendor/src';

// ...

const sampleEvents = [
  {
    date: '2023-12-05',
    title: 'Meeting',
    link: 'https://example.com/meeting',
  },
  {
    date: '2023-12-10',
    title: 'Project Deadline',
    link: 'https://example.com/project-deadline',
  },
  {
    date: '2023-12-15',
    title: 'Team Lunch',
    link: 'https://example.com/team-lunch',
  },
  {
    date: '2023-12-28',
    title: 'Holiday Party',
    link: 'https://example.com/holiday-party',
  },
];

# Customization

 This project is under active development, and users are encouraged to customize it according to their specific use cases. The CustomCalendor component provides various customization options, such as styling, event markers, and more. Refer to the component's documentation for detailed customization instructions.

 # Contributions 

 Contributions and feedback are welcome! If you have ideas for improvements, found a bug, or want to contribute to the project, please open an issue or submit a pull request.

 # License

Feel free to adjust or add any additional sections depending on the features of your project.

---
_Source: https://npm.io/package/event_calendor · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._