Socket
Socket
Sign inDemoInstall

@aldabil/react-scheduler

Package Overview
Dependencies
45
Maintainers
1
Versions
131
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @aldabil/react-scheduler

React scheduler component based on Material-UI & date-fns


Version published
Maintainers
1
Install size
5.18 MB
Created

Readme

Source

Ract Scheduler Component

npm package Follow on Twitter

Installation

npm i @aldabil/react-scheduler
Peer Dependencies
npm i @material-ui/core @material-ui/icons date-fns

Usage

import { Scheduler } from "@aldabil/react-scheduler";

Example

<Scheduler
  view="month"
  events={[
    {
      event_id: 1,
      title: "Event 1",
      start: new Date("2021 5 2 09:30"),
      end: new Date("2021 5 2 10:30"),
    },
    {
      event_id: 2,
      title: "Event 2",
      start: new Date("2021 5 4 10:00"),
      end: new Date("2021 5 4 11:00"),
    },
  ]}
/>
Options
OptionValue
heightnumber. Min height of table.
Default: 600
viewstring. Initial view to load. options: "week", "month", "day".
Default: "week" (if it's not null)
monthObject. Month view props.
default:
{
weekDays: [0, 1, 2, 3, 4, 5],
weekStartOn: 6,
startHour: 9,
endHour: 17,
}
weekObject. Month view props.
default:
{ 
weekDays: [0, 1, 2, 3, 4, 5],
weekStartOn: 6,
startHour: 9,
endHour: 17,
}
dayObject. Month view props.
default:
{
startHour: 9,
endHour: 17
}
selectedDateDate. Initial selected date.
Default: new Date()
eventsArray of Objects.
Default: []
remoteEventsFunction(query: string). Return promise of array of events. Used for remote data
fieldsArray of extra fields with configurations.
Example:
 { 
name: "description",
type: "input" ,
config: { label: "Description", required: true, min: 3, email: true, variant: "outlined", ....
}
loadingboolean. Loading state of the calendar table
onConfirmFunction(event, action). Return promise with the new added/edited event use with remote data.
action: "add", "edit"
onDeleteFunction(id) Return promise with the deleted event id to use with remote data.
customEditorFunction(fields). Override editor modal
viewerExtraComponentFunction(fields, event) OR Component. Additional component in event viewer popper
resourcesArray. Resources array to split event views with resources
Example
{
assignee: 1,
text: "User One",
subtext: "Sales Manager",
avatar: "https://picsum.photos/200/300",
color: "#ab2d2d",
}
resourceFieldsObject. Map the resources correct fields.
Example:
{
idField: "admin_id",
textField: "title",
subTextField: "mobile",
avatarField: "title",
colorField: "background",
}
recourseHeaderComponentFunction(resource). Override header component of resource
resourceViewModeDisplay resources mode.
Options: "default", "tabs"
directionstring. Table direction. "rtl", "ltr"

Demos

Todos

  • Tests
  • Drag&Drop
  • Recurring events
  • Localization

Keywords

FAQs

Last updated on 06 May 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc