2.1.4 β€’ Published 1 year ago

material-scheduler v2.1.4

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

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

πŸš€ 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

NameTypeRequiredDetails
idstringtrueunique id for every event
labelstringtrue
colorstringtrueIf not set, the primary color of the theme will be applied
groupLabelstringtrue
startHourstringtrueHour string format with HH:mm aaa
endHourstringtrueHour string format with HH:mm aaa
datestringtrueDate string, must be formatted with yyyy-MM-dd date format

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

Props

NameTypeDefaultDescriptionValues
localestringenThis prop is used to set the locale of the schedulerar, de, en, es, fr, ja, ko, zh
eventsobjectThis prop sets event data
legacyStylebooleanfalseThis prop allows to use the old display stylefalse, true
optionsobjectThis prop is used to set scheduler properties
alertPropsobjectThis prop is used to set scheduler properties
toolbarPropsobjectThis prop is used to set toolbar properties
onEventsChangeeventThis event is fired when the event change occurs
onCellClickeventThis event is fired when a cell is clicked
onTaskClickeventThis event is fired when a task is clicked
onAlertCloseButtonClickedeventThis event is fired when the close button of the alert component

Options

NameTypeDefaultDescriptionValues
transitionModestringzoomThis option is used to define the type of scheduler transitionzoom, fade, slide
startWeekOnstringmonThis option is used to set the start of the calendar week to Monday or Sundaymon, sun
defaultModestringweekThis option allows you to define the type of view to displaymonth, week, day, timeline
minWidthnumber540This option allows you to define the minimum width of the containernumber
maxWidthnumber540This option allows you to define the maximum width of the containernumber
minHeightnumber540This option allows you to define the minimum height of the containernumber
maxHeighnumber540This option allows you to define the maximum height of the containernumber

alertProps

NameTypeDefaultDescriptionValues
openbooleantrueThis option opens the notification Alert componenttrue, false
colorstringinfoAlert notification colorinfo, success, warning, error
severitystringinfoAlert notification severityinfo, success, warning, error
messagestringπŸš€ Let's start with awesome react-mui-scheduler πŸ”₯ πŸ”₯ πŸ”₯Alert notification message to displaystring
showActionButtonbooleantrueThis option displays or not the action button on the Alertboolean
showNotificationbooleantrueThis option allows to display or not a notification when data changeboolean
delaynumber1500This option allows you to define the display delay in milliseconds of the Alertnumber

toolbarProps

NameTypeDefaultDescriptionValues
showSearchBarbooleantrueShow or hide the search bartrue, false
showSwitchModeButtonsbooleantrueShow or hide the view mode button group switchertrue, false
showDatePickerbooleantrueShow or hide the date picker buttonstrue, false

Methods

MethodParamsTypeDescription
handleCellClick(event: Event, row: object, day: object)event: Event, row: object, day: objectEventTriggered when you click on a cell
handleEventClick(event: Event, item: object)event: Event, item: objectEventTriggered when you click on an event
handleEventsChange(item: object)item: objectEventTriggers when a data update occurs
handleAlertCloseButtonClicked(item: object)item: objectEventTriggers 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

  • 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.