Skip to content

danheron/Heron.MudCalendar

Repository files navigation

Heron.MudCalendar

GitHub Workflow Status Codecov GitHub GitHub last commit Nuget version

A simple but powerful calendar component for MudBlazor.

Features

  • Multiple views (month, week, work week, and day)
  • Customizable events
  • Easy integration with your existing MudBlazor project

Documentation

Documentation and examples are available here.

Getting Started

MudCalendar relies on MudBlazor. Follow the installation instructions for MudBlazor

Once your project is setup with MudBlazor you can install the MudCalendar package.

dotnet add package Heron.MudCalendar

Add the following to _Imports.razor.

@using Heron.MudCalendar

Add style and script references (optional). This step shouldn't be necessary as the component injects the references into the page as needed. However if you find that calendar is not displaying properly then add the following to your index.html or _Layout.cshtml/_Host.cshtml

<link href="_content/Heron.MudCalendar/Heron.MudCalendar.min.css" rel="stylesheet" />
...
<script type="module" src="_content/Heron.MudCalendar/Heron.MudCalendar.min.js"></script>

Add the MudCalendar component to your razor page/component.

<MudCalendar />

Check out the examples of how to use and customize the MudCalendar component.

Support

For any issues or feature requests, please open a new issue on GitHub.

Building From Source

The project includes 2 solution files:

  • Heron.MudCalendar.sln
  • Heron.MudCalendarWithDocs.sln

The Heron.MudCalendar.sln solution contains the MudCalendar project and Unit Test projects.

The Heron.MudCalendarWithDocs.sln solution also contains the Docs project. This is a bit more complicated to compile because it uses the MudBlazor.Docs project. To build this project you need to clone the danheron/MudBlazor repo and checkout the mudcalendar branch.

The repositories should be cloned into the same parent directory e.g.

MyProjects
|-> MudBlazor
|-> Heron.MudCalendar

Build the projects in the following order:

  1. Heron.MudCalendar (Debug)
  2. Heron.MudCalendar (Release)
  3. MudBlazor.Docs (Release)
  4. Heron.MudCalendar.Docs