Skip to content

React material planner is a react component based on @mui v5 that allows you to manage data in a calendar

License

Notifications You must be signed in to change notification settings

rouftom/react-mui-scheduler

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

26 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“… React Material Scheduler

developed with @mui v5

MIT license GitHub release (latest by date) GitHub code size in bytes Snyk Vulnerabilities for GitHub Repo


React mui scheduler is a react component based on @mui v5 that allows you to manage data in a calendar.

Demo here

πŸš€ Installation

  npm install react-mui-scheduler

πŸ’» Usage

import React, {useState} from 'react'
import ReactDOM from 'react-dom'
import Scheduler from "react-mui-scheduler"

function App() {
  const [state] = useState({
    options: {
      transitionMode: "zoom", // or fade
      startWeekOn: "mon",     // or sun
      defaultMode: "month",    // or week | day | timeline
      minWidth: 540,
      maxWidth: 540,
      minHeight: 540,
      maxHeight: 540
    },
    alertProps: {
      open: true,
      color: "info",          // info | success | warning | error
      severity: "info",       // info | success | warning | error
      message: "πŸš€ Let's start with awesome react-mui-scheduler πŸ”₯ πŸ”₯ πŸ”₯" ,
      showActionButton: true,
      showNotification: true,
      delay: 1500
    },
    toolbarProps: {
      showSearchBar: true,
      showSwitchModeButtons: true,
      showDatePicker: true
    }
  })
  
  const events = [
    {
      id: "event-1",
      label: "Medical consultation",
      groupLabel: "Dr Shaun Murphy",
      user: "Dr Shaun Murphy",
      color: "#f28f6a",
      startHour: "04:00 AM",
      endHour: "05:00 AM",
      date: "2022-05-05",
      createdAt: new Date(),
      createdBy: "Kristina Mayer"
    },
    {
      id: "event-2",
      label: "Medical consultation",
      groupLabel: "Dr Claire Brown",
      user: "Dr Claire Brown",
      color: "#099ce5",
      startHour: "09:00 AM",
      endHour: "10:00 AM",
      date: "2022-05-09",
      createdAt: new Date(),
      createdBy: "Kristina Mayer"
    },
    {
      id: "event-3",
      label: "Medical consultation",
      groupLabel: "Dr Menlendez Hary",
      user: "Dr Menlendez Hary",
      color: "#263686",
      startHour: "13 PM",
      endHour: "14 PM",
      date: "2022-05-10",
      createdAt: new Date(),
      createdBy: "Kristina Mayer"
    },
    {
      id: "event-4",
      label: "Consultation prΓ©natale",
      groupLabel: "Dr Shaun Murphy",
      user: "Dr Shaun Murphy",
      color: "#f28f6a",
      startHour: "08:00 AM",
      endHour: "09:00 AM",
      date: "2022-05-11",
      createdAt: new Date(),
      createdBy: "Kristina Mayer"
    }
  ]
  
  const handleCellClick = (event, row, day) => {
    // Do something...
  }
  
  const handleEventClick = (event, item) => {
    // Do something...
  }
  
  const handleEventsChange = (item) => {
    // Do something...
  }
  
  const handleAlertCloseButtonClicked = (item) => {
    // Do something...
  }
  
  return (
    <Scheduler
      locale="en"
      events={events}
      legacyStyle={false}
      options={state?.options}
      alertProps={state?.alertProps}
      toolbarProps={state?.toolbarProps}
      onEventsChange={handleEventsChange}
      onCellClick={handleCellClick}
      onTaskClick={handleEventClick}
      onAlertCloseButtonClicked={handleAlertCloseButtonClicked}
    />
  )
}

ReactDOM.render(<App />, document.querySelector('#yourComponentRootId'))

Data structure

Name Type Required Details
id string true unique id for every event
label string true
color string true If not set, the primary color of the theme will be applied
groupLabel string true
startHour string true Hour string format with HH:mm aaa
endHour string true Hour string format with HH:mm aaa
date string true Date string, must be formatted with yyyy-MM-dd date format

For more details about date formats, see date-fns docs

Props

Name Type Default Description Values
locale string en This prop is used to set the locale of the scheduler ar, de, en, es, fr, ja, ko, zh
events object This prop sets event data
legacyStyle boolean false This prop allows to use the old display style false, true
options object This prop is used to set scheduler properties
alertProps object This prop is used to set scheduler properties
toolbarProps object This prop is used to set toolbar properties
onEventsChange event This event is fired when the event change occurs
onCellClick event This event is fired when a cell is clicked
onTaskClick event This event is fired when a task is clicked
onAlertCloseButtonClicked event This event is fired when the close button of the alert component

Options

Name Type Default Description Values
transitionMode string zoom This option is used to define the type of scheduler transition zoom, fade, slide
startWeekOn string mon This option is used to set the start of the calendar week to Monday or Sunday mon, sun
defaultMode string week This option allows you to define the type of view to display month, week, day, timeline
minWidth number 540 This option allows you to define the minimum width of the container number
maxWidth number 540 This option allows you to define the maximum width of the container number
minHeight number 540 This option allows you to define the minimum height of the container number
maxHeigh number 540 This option allows you to define the maximum height of the container number

alertProps

Name Type Default Description Values
open boolean true This option opens the notification Alert component true, false
color string info Alert notification color info, success, warning, error
severity string info Alert notification severity info, success, warning, error
message string πŸš€ Let's start with awesome react-mui-scheduler πŸ”₯ πŸ”₯ πŸ”₯ Alert notification message to display string
showActionButton boolean true This option displays or not the action button on the Alert boolean
showNotification boolean true This option allows to display or not a notification when data change boolean
delay number 1500 This option allows you to define the display delay in milliseconds of the Alert number

toolbarProps

Name Type Default Description Values
showSearchBar boolean true Show or hide the search bar true, false
showSwitchModeButtons boolean true Show or hide the view mode button group switcher true, false
showDatePicker boolean true Show or hide the date picker buttons true, false

Methods

Method Params Type Description
handleCellClick(event: Event, row: object, day: object) event: Event, row: object, day: object Event Triggered when you click on a cell
handleEventClick(event: Event, item: object) event: Event, item: object Event Triggered when you click on an event
handleEventsChange(item: object) item: object Event Triggers when a data update occurs
handleAlertCloseButtonClicked(item: object) item: object Event Triggers when clicking on the close button of the notification alert

😁 Authors

πŸ€” FAQ

  • Where can I find more documentation?

    This library is a marriage of @mui and a React setup created with React. Either one would be a great place to start!

πŸ™‡β€β™‚οΈ Extra

Do you like this library ? Buy me a coffee or support me with a star on Github

Buy Me A Coffee

  • Btc address: bc1qettgagenn9nc8ks7ghntjfme96yvvkfhntk774

  • Eth address: 0xB0413d8D0336E263e289A915c383e152155881E0

πŸ”₯ Some features to add in next releases

  • βœ… Week, day and timeline mode switch view

  • πŸ‘‰ Option menu

  • πŸ‘‰ Export events as PDF and CSV

  • βœ… Internationalization

  • πŸ‘‰ Typescript support

  • βœ… Display style customization

License

react-mui-scheduler

MIT License

Copyright (c) 2022 rouftom

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.