{"id":18224898,"url":"https://github.com/react-scheduler/react-big-schedule","last_synced_at":"2025-04-12T23:42:25.951Z","repository":{"id":162568836,"uuid":"637048017","full_name":"react-scheduler/react-big-schedule","owner":"react-scheduler","description":"React Big Schedule is a powerful and intuitive scheduler and resource planning solution built with React.","archived":false,"fork":false,"pushed_at":"2025-03-03T04:35:46.000Z","size":1075,"stargazers_count":136,"open_issues_count":27,"forks_count":28,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-12T23:42:21.323Z","etag":null,"topics":["libraries","npm-lib","npm-library","npm-module","npm-package","npm-packages","package","react","react-big-schedule","react-big-scheduler","react-scheduler","scheduler"],"latest_commit_sha":null,"homepage":"https://react-big-schedule.vercel.app/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/react-scheduler.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-06T10:48:45.000Z","updated_at":"2025-04-09T16:37:27.000Z","dependencies_parsed_at":"2024-04-10T04:29:40.045Z","dependency_job_id":"606f1a54-9649-4dfe-bd9a-ca47f477fcdb","html_url":"https://github.com/react-scheduler/react-big-schedule","commit_stats":null,"previous_names":["ansulagrawal/react-scheduler-master","react-scheduler/react-big-schedule"],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/react-scheduler%2Freact-big-schedule","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/react-scheduler%2Freact-big-schedule/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/react-scheduler%2Freact-big-schedule/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/react-scheduler%2Freact-big-schedule/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/react-scheduler","download_url":"https://codeload.github.com/react-scheduler/react-big-schedule/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248647257,"owners_count":21139081,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["libraries","npm-lib","npm-library","npm-module","npm-package","npm-packages","package","react","react-big-schedule","react-big-scheduler","react-scheduler","scheduler"],"created_at":"2024-11-04T02:04:48.180Z","updated_at":"2025-04-12T23:42:25.924Z","avatar_url":"https://github.com/react-scheduler.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# React Big Schedule (react-big-schedule)\n\n[![NPM version][npm-image]][npm-url] [![MIT License][mit-image]][mit-url] [![CodeQL][codeql-image]][codeql-url] [![CodeFactor][codeFactor-badge]][codeFactor-link]\n\n[npm-image]: http://img.shields.io/npm/v/react-big-schedule.svg\n[npm-url]: http://npmjs.org/package/react-big-schedule\n[mit-image]: https://img.shields.io/badge/License-MIT-green.svg\n[mit-url]: https://github.com/react-scheduler/react-big-schedule/blob/master/LICENSE\n[codeql-image]: https://github.com/react-scheduler/react-big-schedule/actions/workflows/github-code-scanning/codeql/badge.svg?branch=master\n[codeql-url]: https://github.com/react-scheduler/react-big-schedule/actions/workflows/github-code-scanning/codeql\n[codeFactor-badge]: https://www.codefactor.io/repository/github/react-scheduler/react-big-schedule/badge\n[codeFactor-link]: https://www.codefactor.io/repository/github/react-scheduler/react-big-schedule\n\nReact Big Schedule is a powerful and intuitive scheduler and resource planning solution built with React. Seamlessly integrate this modern, browser-compatible component into your applications to effectively manage time, appointments, and resources. With drag-and-drop functionality, interactive UI, and granular views, react-big-schedule empowers users to effortlessly schedule and allocate resources with precision.\n\nEnhance productivity and streamline your workflow with this React-based solution, designed to optimize time management and simplify calendar-based operations. Perfect for applications requiring advanced scheduling capabilities, react-big-schedule offers a seamless and intuitive experience for managing appointments, resource allocation, and time slots.\n\nUnlock the potential of your React projects with react-big-schedule and revolutionize the way you handle scheduling and resource planning.\n\n### This project code is forked from:\n\n- [react-big-scheduler](https://stephenchou1017.github.io/scheduler/#/).\n- [react-big-scheduler-stch](https://github.com/hbatalhaStch/react-big-scheduler).\n\n## Installation\n\nTo install react-big-schedule, use npm:\n\n```bash\n  npm install react-big-schedule\n```\n\n## Tech Stack\n\n- React\n- Ant Design\n- react-dnd\n- react-dnd-html5-backend\n- webpack\n- dayjs\n\n## Features\n\n- Modern and intuitive scheduler component for React applications.\n- Seamless integration with React projects.\n- Drag-and-drop functionality for effortless scheduling.\n- Interactive user interface for a smooth user experience\n- Granular views to manage time, appointments, and resources effectively.\n- Optimized for time management and calendar-based operations.\n- Perfect for applications requiring advanced scheduling capabilities.\n\n## Contributions\n\nContributions to react-big-schedule are welcome! If you find a bug or want to contribute to the project, please follow these steps:\n\n1. Fork the repository on GitHub.\n2. Create a new branch with a descriptive name.\n3. Make your changes and commit them with clear messages.\n4. Push your changes to your forked repository.\n5. Submit a pull request to the master repository.\n\nPlease ensure that your code adheres to the project's coding conventions and includes appropriate tests.\n\n## License\n\nReact Big Schedule is released under the MIT License. See the [LICENSE](https://github.com/react-scheduler/react-big-schedule/blob/master/LICENSE) file for more details.\n\n## Support\n\nIf you have any questions or need support, please create an issue in the [GitHub repository](https://github.com/react-scheduler/react-big-schedule/issues).\n\n## Credits\n\nReact Big Schedule is developed and maintained by the React Big Schedule team. We would like to thank the open-source community for their valuable contributions and feedback.\n\nSpecial thanks to the following contributors:\n\n- Ansul Agrawal ([@ansulagrawal](https://github.com/ansulagrawal))\n- Jitendra Soni ([@JitendraSoni1234](https://github.com/JitendraSoni1234))\n- hbatalhaStch [[@hbatalhaStch](https://github.com/hbatalhaStch))\n- DamyanBG ([@DamyanBG](https://github.com/DamyanBG))\n\n## Acknowledgments\n\nWe would like to acknowledge the following projects for their inspiration and contributions:\n\n- [react-big-scheduler](https://stephenchou1017.github.io/scheduler/#/).\n- [react-big-scheduler-stch](https://github.com/hbatalhaStch/react-big-scheduler).\n\n## Roadmap\n\n- Additional view options for different scheduling needs.\n- Support for recurring appointments.\n- Integration with popular calendar services.\n- Improved accessibility and localization support.\n- Performance optimizations for handling large data sets.\n\nWe are continuously working on enhancing react-big-schedule and welcome your feedback and suggestions for future improvements.\n\n## Changelog\n\nPlease refer to the [CHANGELOG.md](https://github.com/react-scheduler/react-big-schedule/blob/master/CHANGELOG.md) file.\n\n## Use and Setup\n\n1.) Installation\n\n```\n  npm i react-big-schedule\n```\n\nor\n\n```\n  yarn add react-big-schedule\n```\n\n2.) Import dependencies\n\n```\nimport { Scheduler, SchedulerData, ViewType, DATE_FORMAT } from \"react-big-schedule\";\nimport dayjs from \"dayjs\";\nimport \"react-big-schedule/dist/css/style.css\";\n```\n\n3.) Basic Usage\n\n```js\nconst schedulerData = new SchedulerData(new dayjs().format(DATE_FORMAT), ViewType.Week);\n\n//set locale dayjs to the schedulerData, if your locale isn't English. By default, Scheduler comes with English(en, United States).\nschedulerData.setSchedulerLocale('pt-br'); // this uses dayjs, but it doesn't require dayjs to be installed as its called dynamically\nschedulerData.setCalendarPopoverLocale('pt_BR'); // this uses antd [List of supported locales](https://ant.design/docs/react/i18n#supported-languages)\n\nschedulerData.setResources([\n  { id: 'r0', name: 'Resource0', groupOnly: true },\n  { id: 'r1', name: 'Resource1' },\n  { id: 'r2', name: 'Resource2', parentId: 'r0' },\n  { id: 'r3', name: 'Resource3', parentId: 'r4' },\n  { id: 'r4', name: 'Resource4', parentId: 'r2' },\n]);\n\n// the event array should be sorted in ascending order by event.start property\n// otherwise there will be some rendering errors\nschedulerData.setEvents([\n  {\n    id: 1,\n    start: '2022-12-18 09:30:00',\n    end: '2022-12-19 23:30:00',\n    resourceId: 'r1',\n    title: 'I am finished',\n    bgColor: '#D9D9D9',\n  },\n  {\n    id: 2,\n    start: '2022-12-18 12:30:00',\n    end: '2022-12-26 23:30:00',\n    resourceId: 'r2',\n    title: 'I am not resizable',\n    resizable: false,\n  },\n  {\n    id: 3,\n    start: '2022-12-19 12:30:00',\n    end: '2022-12-20 23:30:00',\n    resourceId: 'r3',\n    title: 'I am not movable',\n    movable: false,\n  },\n  {\n    id: 4,\n    start: '2022-12-19 14:30:00',\n    end: '2022-12-20 23:30:00',\n    resourceId: 'r1',\n    title: 'I am not start-resizable',\n    startResizable: false,\n  },\n  {\n    id: 5,\n    start: '2022-12-19 15:30:00',\n    end: '2022-12-20 23:30:00',\n    resourceId: 'r2',\n    title: 'R2 has recurring tasks every week on Tuesday, Friday',\n    rrule: 'FREQ=WEEKLY;DTSTART=20221219T013000Z;BYDAY=TU,FR',\n    bgColor: '#f759ab',\n  },\n]);\n\n// ...\n\n//3. render the scheduler component, mind that the Scheduler component should be placed in a DragDropContext(father or ancestor).\n\n\u003cScheduler\n  schedulerData={schedulerData}\n  prevClick={this.prevClick}\n  nextClick={this.nextClick}\n  onSelectDate={this.onSelectDate}\n  onViewChange={this.onViewChange}\n  eventItemClick={this.eventClicked}\n/\u003e;\n```\n\n### Run examples locally\n\n- Clone this repository\n- Retrieve dependencies: `npm install` or `npm i`\n- Start: `npm run start`\n- Open [http://localhost:8080](http://localhost:8080).\n\nIf you fail to execute the `npm install` command, remove the package-lock.json file and try again.\n\n# API\n\n### SchedulerData\n\nSchedulerData is the view model of Scheduler, we can modify it to control the view of the Scheduler.\n\n#### constructor\n\n```js\nconstructor(date=dayjs().format(DATE_FORMAT), viewType = ViewType.Week,\n                showAgenda = false, isEventPerspective = false,\n                newConfig = undefined, newBehaviors=undefined\n                localeDayjs = undefined)\n```\n\n- `date` is a string in `YYYY-MM-DD` format, and is the initial date Scheduler will render. Take the date `2022-12-20`\n  for example, Scheduler will render the time window of the week from `2022-12-18` to `2022-12-24` in `ViewType.Week`\n  view type, and will render the time window of the `2022-12` month in `ViewType.Month` view type.\n- `viewType` is the initial view type, now Scheduler supports `Day`, `Week`, `Month`, `Quarter`, `Year` 5 built-in view types,\n  in addition Scheduler now supports `Custom`, `Custom1`, `Custom2` 3 custom view types at the same time, in which you can control\n  the time window yourself, refer to [this example](https://stephenchou1017.github.io/scheduler/#/customtimewindow). `viewType`,\n  `showAgenda` and `isEventPerspective` are a group which should be contained in the SchedulerData.config.views array,\n  and they together decide which view should be rendered. When `showAgenda` and `isEventPerspective` are both `false`,\n  Scheduler will render the resource view, refer to [this example](https://stephenchou1017.github.io/scheduler/#/views).\n- `showAgenda` is a bool value, if true, Scheduler will display the agenda view of current view type. Agenda view is\n  read only.\n- `isEventPerspective` is a bool value, if true, Scheduler will display the task view of current view type. In\n  resource view, every slot(row) describes how many events a resource does in the time window, while in task view,\n  every slot describes how many events a big task is divided into and who will make it done. Add a `groupId` and\n  `groupName` property to every event object, so that the events having the same `groupId` will belong to the same big task and\n  be rendered in the same slot in task view. If `groupId` and `groupName` are not provided, SchedulerData will take\n  the `id` as the `groupId`, and take the `title` as the `groupName`. See the `eventsForTaskView` in the\n  [sample1.js](https://github.com/react-scheduler/react-big-schedule/blob/master/src/sample-data/sample1.js) for details.\n- `newConfig` is a config object, used to override the [default config](https://github.com/react-scheduler/react-big-schedule/blob/master/src/config/scheduler.js)\n  fully or partly.\n- `newBehaviors` is a config object, used to override the [default behaviors](https://github.com/react-scheduler/react-big-schedule/blob/master/src/helper/behaviors.js)\n  fully or partly.\n- `localeDayjs` is a locale dayjs object, which is unified used in react-big-scheduler. If not provided, Scheduler will come\n  with English(en, United States) locale strings.\n\n#### setSchedulerLocale\n\n```js\nsetSchedulerLocale(preset);\n```\n\nUsed to set locale to the scheduler, it uses dayjs locales ([List of supported locales](https://github.com/iamkun/dayjs/tree/dev/src/locale)) and it is loaded on demand.\n\n`preset` will be locale imported from dayjs.\n\n#### example:\n\n```js\nimport * as dayjsLocale from 'dayjs/locale/pt-br';\n\nsetSchedulerLocale(dayjsLocale);\n```\n\nBy default, Scheduler comes with English(en, United States)\n\n#### setCalendarPopoverLocale\n\n```js\nsetCalendarPopoverLocale(lang);\n```\n\nUsed to set locale to the calendar popover. it uses antd locales ([List of supported locales](https://ant.design/docs/react/i18n#supported-languages)). By default, it comes with English(en, United States)\n\n#### example:\n\n```js\nimport * as antdLocale from 'antd/locale/pt_BR';\n\nsetCalendarPopoverLocale(antdLocale);\n```\n\nrefer this for the demo of the locale.\n\n#### setResources\n\n```js\nsetResources(resources);\n```\n\nUsed to set the resources(the slots in resource view), make sure that there are no duplicated `resource.id` in the `resources`.\nSee the demo `resources` in the [sample1.js](https://github.com/react-scheduler/react-big-schedule/blob/master/src/sample-data/sample1.js).\n\n#### setEvents\n\n```js\nsetEvents(events);\n```\n\nUsed to set the events. the event array should be sorted in ascending order by event.start property.\nSee the demo `events` in the [sample1.js](https://github.com/react-scheduler/react-big-schedule/blob/master/src/sample-data/sample1.js).\nIf we use the task view, we'd better add the `groupId` and the `groupName` property to each event object, see the\n`eventsForTaskView` in the [sample1.js](https://github.com/react-scheduler/react-big-schedule/blob/master/src/sample-data/sample1.js) for details.\n\n#### prev\n\n```js\nprev();\n```\n\nLet the time window scroll to the left once. When `SchedulerData,viewType` is `ViewType.Month`, the time window will\nscroll a month, when `SchedulerData,viewType` is `ViewType.Week`, the time window will scroll a week. `SchedulerData.events`\nwill be clear after calling this method.\n\n#### next\n\n```js\nnext();\n```\n\nLet the time window scroll to the right once. `SchedulerData.events` will be clear after calling this method.\n\n#### setDate\n\n```js\nsetDate((date = dayjs().format(DATE_FORMAT)));\n```\n\nLet the time window jump to the provided `date` directly. `SchedulerData.events` will be clear after calling this method.\n\n#### setViewType\n\n```js\nsetViewType((viewType = ViewType.Week), (showAgenda = false), (isEventPerspective = false));\n```\n\nTell SchedulerData to change current view, the `viewType`, `showAgenda` and `isEventPerspective` group should be\nprovided, and should be contained in the `SchedulerData.config.views` array. `SchedulerData.events` will be clear\nafter calling this method.\n\n#### setEventGroups\n\n```js\nsetEventGroups(eventGroups);\n```\n\nUsed to set the event groups(the slots in task view), make sure that there are no duplicated `eventGroup.id` in the `eventGroups`.\nThis method is optional, and is needed only when `SchedulerData.eventGroupsAutoGenerated` is `false`.\n\n#### setEventGroupsAutoGenerated\n\n```js\nsetEventGroupsAutoGenerated(autoGenerated);\n```\n\nTell SchedulerData to generate `SchedulerData.eventGroups` automatically or not. If `true`, SchedulerData will generate the event\ngroups(slots) automatically according to the `event.groupId` and 'event.groupName' automatically. If `groupId` and 'groupName' are\nnot provided, SchedulerData will take `event.id` and `event.title` instead.\n\n#### setMinuteStep\n\n```js\nsetMinuteStep(minuteStep);\n```\n\nUsed to set minute step for daily view and refresh the render data.\n\n#### toggleExpandStatus\n\n```js\ntoggleExpandStatus(slotId);\n```\n\nUsed to toggle slot's(and its children's) expand status.\n\n#### getMinuteStepsInHour\n\n```js\ngetMinuteStepsInHour();\n```\n\nUsed to get minute steps in an hour, it equals 60 / SchedulerData.config.minuteStep.\n\n#### addResource\n\n```js\naddResource(resource);\n```\n\nAdd the `resource` to the `SchedulerData.resources`, make sure that `resource.id` is not duplicated. Refer\nto [this example](https://stephenchou1017.github.io/scheduler/#/addresource).\n\n#### addEventGroup\n\n```js\naddEventGroup(eventGroup);\n```\n\nAdd the `eventGroup` to the `SchedulerData.eventGroups`, make sure that `eventGroup.id` is not duplicated. Please note\nthat the `eventGroup` added may be override when `SchedulerData.eventGroupsAutoGenerated` is `true` and\n`SchedulerData.eventGroups` is auto-generated.\n\n#### addEvent\n\n```js\naddEvent(newEvent);\n```\n\nAdd the `newEvent` to the `SchedulerData.events`, make sure that `newEvent.id` is not duplicated. SchedulerData will\nplace the `newEvent` in the right index according to the `newEvent.start` property.\n\n#### updateEventStart\n\n```js\nupdateEventStart(event, newStart);\n```\n\nUpdate the `newStart` to the `event.start`, `newStart` is a string in `YYYY-MM-DD HH:mm:ss` format(similarly hereinafter).\nSchedulerData will replace the `event` in the right index according to the `newStart` value.\n\n#### updateEventEnd\n\n```js\nupdateEventEnd(event, newEnd);\n```\n\nUpdate the `newEnd` to the `event.end`.\n\n#### moveEvent\n\n```js\nmoveEvent(event, newSlotId, newSlotName, newStart, newEnd);\n```\n\nUpdate the `newSlotId`, `newSlotName`, `newStart`, `newEnd` of the `event`. In resource view, new slot is a resource,\nwhile in task view, new slot is a event group. SchedulerData will replace the `event` in the right index according\nto the `newStart` value.\n\n#### removeEvent\n\n```js\nremoveEvent(event);\n```\n\nRemove the given event from `SchedeulerData.events`.\n\n#### removeEventById\n\n```js\nremoveEventById(eventId);\n```\n\nRemove event from `SchedeulerData.events` by the given event id.\n\n#### getSlots\n\n```js\ngetSlots();\n```\n\nReturns the slot array, `SchedulerData.resources` in resource view, `SchedulerData.eventGroups` in task view.\n\n#### getSlotById\n\n```js\ngetSlotById(slotId);\n```\n\nReturns the slot by `slotId`, returns `undefined` if not found.\n\n#### getResourceById\n\n```js\ngetResourceById(resourceId);\n```\n\n#### isEventInTimeWindow\n\n```js\nisEventInTimeWindow(eventStart, eventEnd, windowStart, windowEnd);\n```\n\nReturns whether an event is in the time window or not, remind that `eventStart`, `eventEnd`, `windowStart`, `windowEnd`\nare all dayjs | Date objects.\n\n#### getViewDates\n\n```js\ngetViewDates();\n```\n\nReturns an object with the startDate and endDate of the currently selected view ({ startDate: Dayjs, endDate: Dayjs }).\n\n#### getViewStartDate\n\n```js\ngetViewStartDate();\n```\n\nReturns a dayjs object with the startDate of the currently selected view.\n\n#### getViewEndDate\n\n```js\ngetViewEndDate();\n```\n\nReturns a dayjs object with the endDate of the currently selected view.\n\n### Locale support(Refer to [this example](https://stephenchou1017.github.io/scheduler/#/locale) for details.)\n\n#### SchedulerData.config.resourceName\n\nThe locale string of resource name.\n\n#### SchedulerData.config.taskName\n\nThe locale string of task name.\n\n#### SchedulerData.config.agendaViewHeader\n\nThe locale string of agenda view header.\n\n#### SchedulerData.config.addMorePopoverHeaderFormat\n\nThe locale string of add more popover header format.\n\n#### SchedulerData.config.eventItemPopoverDateFormat\n\nThe locale string of event item popover date format.\n\n#### SchedulerData.config.nonAgendaDayCellHeaderFormat\n\nThe locale string of non-agenda view cell header format of day view type.\n\n#### SchedulerData.config.nonAgendaOtherCellHeaderFormat\n\nThe locale string of non-agenda view cell header format of other view types.\n\n#### SchedulerData.behaviors.getDateLabelFunc\n\nUsed to resolve the locale string of date label of Scheduler component.(Refer to the [getDateLabel](https://github.com/react-scheduler/react-big-schedule/blob/master/src/helper/behaviors.js) func for example)\n\n### SchedulerData.config(See the [config file](https://github.com/react-scheduler/react-big-schedule/blob/master/src/config/scheduler.js) for details.)\n\n#### schedulerWidth\n\nThe width of Scheduler. Scheduler uses responsive layout so schedulerWidth should be a percentage,\nScheduler in the responsive layout:\n`actual width of Scheduler = (SchedulerData.documentWidth - SchedulerData.config.besidesWidth) * SchedulerData.config.schedulerWidth`\n`SchedulerData.documentWidth` is the window width of browser (or the the parent width in case SchedulerData.config.responsiveByParent\nand Scheduler component prop parentRef is passed) and will change automatically when resized.\n\n#### responsiveByParent\n\nWhen true, Scheduler resposiveness will not be determined by the window width of browser but instead by the\nwidth of the of the parent (the parent ref must be passed to the Scheduler component prop named `parentRef`,\nin case it is not passed resposiveness will fall back to being determined by the window width).\nMeaning:\n`SchedulerData.documentWidth` is the width of the parent and will change automatically when resized\n\n#### schedulerMaxHeight\n\nThe max height of Scheduler. If the desired height is bigger than the max height, the header row of Scheduler will be\nfrozen and vertical scroll bar will appear, but this won't happen when the max height is set to `0`. Refer\nto [this example](https://stephenchou1017.github.io/scheduler/#/freezefirstrow).\n\n#### tableHeaderHeight\n\nHeight of Scheduler table header.\n\n#### agendaResourceTableWidth\n\nWidth of the left Scheduler resource column in agenda view.\n\n#### agendaMaxEventWidth\n\nMax width of an event item in agenda view.\n\n#### dayResourceTableWidth, weekResourceTableWidth, monthResourceTableWidth, yearResourceTableWidth, quarterResourceTableWidth\n\nWidth of the left Scheduler resource column in resource view and task view of different view types.\n\n#### dayCellWidth, weekCellWidth, monthCellWidth, yearCellWidth, quarterCellWidth\n\nWidth of Scheduler table cells in resource view and task view of different view types.\n\n#### dayMaxEvents, weekMaxEvents, monthMaxEvents, yearMaxEvents, quarterMaxEvents\n\nMax events count of a cell in resource view and task view of different view types. A '+N more' will appear when exceeded.\nRefer to [this example](https://stephenchou1017.github.io/scheduler/#/addmore).\n\n#### eventItemHeight\n\nHeight of an event item in 3 views.\n\n#### eventItemLineHeight\n\nLine height of an event item in 3 views.\n\n#### nonAgendaSlotMinHeight\n\nMin height of a slot in non-agenda views, default 0, means there is no min height.\n\n#### dayStartFrom\n\nStart hour rendered from in `ViewType.Day` in resource view and task view, default 0.\n\n#### dayStopTo\n\nEnd hour rendered to in `ViewType.Day` in resource view and task view, default 23.\n\n#### defaultEventBgColor\n\nDefault event item background color in 3 views, will be override if there is a `bgColor` property in event object.\n\n#### selectedAreaColor\n\nSelected cells color in resource view and task view, cells are selectable only when `creatable` is `true`.\n\n#### nonWorkingTimeHeadColor\n\nColor of non-working time head cells. Modify `SchedulerData.behaviors.isNonWorkingTimeFunc` to re-define non-working time.\nRefer the `isNonWorkingTime` func in the [behaviors.js](https://github.com/react-scheduler/react-big-schedule/blob/master/src/helper/behaviors.js).\n\n#### nonWorkingTimeHeadBgColor\n\nBackground color of non-working time head cells.\n\n#### nonWorkingTimeBodyBgColor\n\nBackground color of non-working time body cells.\n\n#### summaryColor\n\nColor of cell summary. Modify `SchedulerData.behaviors.getSummaryFunc` to display summary in a cell.\nRefer the `getSummary` func in the [behaviors.js](https://github.com/react-scheduler/react-big-schedule/blob/master/src/helper/behaviors.js).\n\n#### summaryPos\n\nPosition of cell summary, supports `SummaryPos.Top`, `SummaryPos.TopRight`, `SummaryPos.TopLeft`, `SummaryPos.Bottom`,\n`SummaryPos.BottomRight` and `SummaryPos.BottomLeft`.\n\n#### startResizable\n\nControls whether to resize the start of every event item in resource view and task view. If `false`, all item starts are\nnon-resizable, if `true`, all item starts are resizable except those who have a `resizable` or `startResizable`\nproperty and its value is `false`.\n\n#### endResizable\n\nControls whether to resize the end of every event item in resource view and task view. If `false`, all item ends are\nnon-resizable, if `true`, all item ends are resizable except those who have a `resizable` or `endResizable`\nproperty and its value is `false`.\n\n#### movable\n\nControls whether to move every event item in resource view and task view. If `false`, all items are\nnon-movable, if `true`, all items are movable except those who have a `movable` property and its value is `false`.\n\n#### creatable\n\nControls whether to create new event item in resource view and task view.\n\n#### crossResourceMove\n\nControls whether to cross-slot move an event item in resource view and task view. If `false`, the `slotId` and `slotName`\nwon't change in the `moveEvent` method. Refer to [this example](https://stephenchou1017.github.io/scheduler/#/nocrossslotmove).\n\n#### checkConflict\n\nControls whether to check conflicts when creating, resizing or moving an event item in resource view and task view. If\n`true`, Scheduler will call the `conflictOccurred` function if given. Refer to\n[this example](https://stephenchou1017.github.io/scheduler/#/overlapcheck).\n\n#### scrollToSpecialDayjsEnabled\n\nControls Scheduler whether to scroll to special dayjs automatically when the time window contains special dayjs. If `true`, Scheduler\nhorizontal bar will scroll to special dayjs after calling `setScrollToSpecialDayjs(true)` to SchedulerData. Use `SchedulerData.behaviors.getScrollSpecialDayjsFunc`\nto tell Scheduler what time the special dayjs is.\n\n#### eventItemPopoverEnabled\n\nControls Scheduler whether to display event item popover when moving mouse on an event item, default `true`.\n\n#### eventItemPopoverTrigger\n\nControls Scheduler event item popover trigger, default `hover`.\nControls Scheduler whether to display event item popover when moving mouse on an event item, default `true`.\n\n#### eventItemPopoverPlacement\n\nControls Scheduler event item popover placement (`'topLeftMousePosition' | 'bottomLeftMousePosition' | 'topRightMousePosition' | 'bottomRightMousePosition' | 'top' | 'left' | 'right' | 'bottom' | 'topLeft' | 'topRight' | 'bottomLeft' | 'bottomRight' | 'leftTop' | 'leftBottom' | 'rightTop' | 'rightBottom'`), default `bottomLeft`.\n\n#### eventItemPopoverWidth\n\nControls Scheduler event item popover width. Should be taken into account when you set `eventItemPopoverPlacement` to one of the `...MousePosition` options and you set your own event item popover by setting `eventItemPopoverTemplateResolver` as `eventItemPopoverWidth` is used to determine when the event item popover content goes off the screen so the popover can be adjusted accordingly. Defaults to 300.\n\n#### calendarPopoverEnabled\n\nControls Scheduler whether to display calendar popover when clicking on a date label in header, default `true`.\n\n#### recurringEventsEnabled\n\nControls Scheduler whether to support recurring event, refer to [this feature request](https://github.com/StephenChou1017/react-big-scheduler/issues/8), default `true`.\nIf `true`, SchedulerData will filter out those template events who has a `rrule` string property in `setEvents` method,\ngenerate the recurring events in the time window, and insert them into the event array in the right orders. The recurring events\ngenerated from the same template event, all have a new id like `${templateEvent.id}-${number}`, and have a `recurringEventId`\nproperty with the value `templateEvent.id`.\n\n#### headerEnabled\n\nControls Scheduler whether to display header, default `true`.\n\n#### resourceViewEnabled\n\nControls Scheduler whether to display resource view, default `true`.\n\n#### displayWeekend\n\nControls Scheduler whether to display weekends in non-agenda view, default `true`.\n\n#### relativeMove\n\nControls Scheduler whether to move events(only DnDTypes.EVENT type) relatively or absolutely, default `true`, means relatively.\n\n#### minuteStep\n\nMinute step for day view type in non-agenda view, can be 10, 12, 15, 20, 30, 60, etc, default 30.\n\n#### views\n\nArray of view that Scheduler will support.\n\n#### dragAndDropEnabled\n\nControls whether the dragAndDrop funcionality is enabled. If false there's no need for the [withDnDContext wrapper function](https://github.com/react-scheduler/react-big-schedule/blob/master/src/components/WrapperFun.jsx).\n\n### SchedulerData.behaviors(See the [behaviors.js](https://github.com/react-scheduler/react-big-schedule/blob/master/src/helper/behaviors.js) for details.)\n\n#### getEventTextFunc\n\n```js\ngetEventTextFunc(schedulerData, event);\n```\n\nMethod that defines the text displayed in the `event`.\n\n#### isNonWorkingTimeFunc\n\n```js\nisNonWorkingTimeFunc(schedulerData, time);\n```\n\nMethod that defines non-working time.\n\n#### getSummaryFunc\n\n```js\ngetSummary(schedulerData, headerEvents, slotId, slotName, headerStart, headerEnd);\n```\n\nMethod that defines the summary text displayed in the Scheduler cells.Refer\nto [this example](https://stephenchou1017.github.io/scheduler/#/summary).\n\n#### getCustomDateFunc\n\n```js\ngetCustomDate(schedulerData, num, (date = undefined));\n```\n\nMethod that controls the start and end of time window when current view type is Custom, Custom1 or Custom2.Refer\nto [this example](https://stephenchou1017.github.io/scheduler/#/customtimewindow).\n\n#### getNonAgendaViewBodyCellBgColorFunc\n\n```js\ngetNonAgendaViewBodyCellBgColor(schedulerData, slotId, header);\n```\n\nMethod that sets the background color of cells dynamically.\n\n#### getScrollSpecialDayjsFunc\n\n```js\ngetScrollSpecialDayjs(schedulerData, startDayjs, endDayjs);\n```\n\nMethod that defines the special dayjs Scheduler will scroll to automatically, when the time window contains that dayjs.\n\n### Scheduler.propTypes\n\n#### schedulerData\n\n```js\nschedulerData: PropTypes.object.isRequired;\n```\n\nView model of the Scheduler component, provides data.\n\n#### parentRef\n\n```js\nparentRef: PropTypes.object;\n```\n\nref of the component that is the parent of the Scheduler component\n\n#### prevClick\n\n```js\nprevClick: PropTypes.func.isRequired;\nprevClick(schedulerData);\n```\n\nCallback function fired when the left point bracket '\u003c' is clicked.\n\n#### nextClick\n\n```js\nnextClick: PropTypes.func.isRequired;\nnextClick(schedulerData);\n```\n\nCallback function fired when the right point bracket '\u003e' is clicked.\n\n#### onViewChange\n\n```js\nonViewChange: PropTypes.func.isRequired;\nonViewChange(schedulerData, view);\n```\n\nCallback function fired when the Scheduler view changed. `view` is a json such as { viewType: ViewType.Month,\nshowAgenda: true, isEventPerspective: false}.\n\n#### onSelectDate\n\n```js\nonSelectDate: PropTypes.func.isRequired;\nonSelectDate(schedulerData, date);\n```\n\nCallback function fired when a new date is selected. `date` is the new selected data, a string in `YYYY-MM-DD` format.\n\n#### eventItemClick\n\n```js\neventItemClick: PropTypes.func;\neventItemClick(schedulerData, event);\n```\n\nCallback function fired when you click an event item.\n\n#### updateEventStart\n\n```js\nupdateEventStart: PropTypes.func;\nupdateEventStart(schedulerData, event, newStart);\n```\n\nCallback function fired when resizing the start of the `event`, `newStart` is a string in `YYYY-MM-DD HH:mm:ss` format.\n\n#### updateEventEnd\n\n```js\nupdateEventEnd: PropTypes.func;\nupdateEventEnd(schedulerData, event, newEnd);\n```\n\nCallback function fired when resizing the end of the `event`, `newEnd` is a string in `YYYY-MM-DD HH:mm:ss` format.\n\n#### moveEvent\n\n```js\nmoveEvent: PropTypes.func;\nmoveEvent((schedulerData, event, slotId, slotName, newStart, newEnd));\n```\n\nCallback function fired when moving the `event`. `slotId`, `slotName` are the new `id` and `name` of the slot moving into,\nbut they won't change if the `SchedulerData.config.crossResourceMove` is `false`. `newStart`, `newEnd` are the new beginning\nand ending of the `event`.\n\n#### newEvent\n\n```js\nnewEvent: PropTypes.func;\nnewEvent(schedulerData, slotId, slotName, start, end, type, item);\n```\n\nCallback function fired when creating a new event, or dragging an external item and dropping it into the resource view or task\nview. `slotId` and `slotName` are the slot creating in or dropping into, `start`, `end` are the beginning and ending of the\nevent. If it's a drag\u0026drop operation, the `type` is the DnDType of DnDSource registered to Scheduler, and the `item` is the\nexternal item.\n\n#### leftCustomHeader, rightCustomHeader\n\n```js\nleftCustomHeader: PropTypes.object;\nrightCustomHeader: PropTypes.object;\n```\n\nComponent you need to put in the Scheduler header, it could be a div or a react component. Refer\nto [this example](https://stephenchou1017.github.io/scheduler/#/customheader).\n\n#### conflictOccurred\n\n```js\nconflictOccurred: PropTypes.func;\nconflictOccurred(schedulerData, action, event, type, slotId, slotName, start, end);\n```\n\nCallback function fired when there is a conflict. This could happen when creating, resizing or moving an event, and when  \n `SchedulerData.config.checkConflict` is `true`.\n\n#### eventItemTemplateResolver\n\n```js\neventItemTemplateResolver: PropTypes.func;\neventItemTemplateResolver(schedulerData, event, bgColor, isStart, isEnd, mustAddCssClass, mustBeHeight, agendaMaxEventWidth);\n```\n\nUse this function, you can customize the event style. Refer to [this example](https://stephenchou1017.github.io/scheduler/#/customeventstyle).\n\n### eventItemPopoverTemplateResolver\n\n```js\neventItemPopoverTemplateResolver: PropTypes.func;\neventItemPopoverTemplateResolver(schedulerData, eventItem, title, start, end, statusColor);\n```\n\nUse this function, you can customize the event's popover style. Refer to [this example](https://stephenchou1017.github.io/scheduler/#/custompopover).\n\n#### slotItemTemplateResolver\n\n```js\nslotItemTemplateResolver: PropTypes.func;\nslotItemTemplateResolver(schedulerData, slot, slotClickedFunc, width, clsName);\n```\n\nUse this function, you can customize the left slot style.\n\n#### nonAgendaCellHeaderTemplateResolver\n\n```js\nnonAgendaCellHeaderTemplateResolver: PropTypes.func;\nnonAgendaCellHeaderTemplateResolver(schedulerData, item, formattedDateItems, style);\n```\n\nUse this function, you can customize the table header cell style. Refer to [this example](https://stephenchou1017.github.io/scheduler/#/customtableheaders).\n\n#### onScrollLeft, onScrollRight\n\n```js\nonScrollLeft: PropTypes.func;\nonScrollLeft(schedulerData, schedulerContent, maxScrollLeft);\nonScrollRight: PropTypes.func;\nonScrollRight(schedulerData, schedulerContent, maxScrollLeft);\n```\n\nCallback function fired when the scheduler content div scrolls to leftmost or rightmost. Refer to [this example](https://stephenchou1017.github.io/scheduler/#/infinitescroll).\n\n#### onScrollTop, onScrollBottom\n\n```js\nonScrollTop: PropTypes.func;\nonScrollTop(schedulerData, schedulerContent, maxScrollTop);\nonScrollBottom: PropTypes.func;\nonScrollBottom(schedulerData, schedulerContent, maxScrollTop);\n```\n\nCallback function fired when the scheduler content div scrolls to topmost or bottommost. Refer to [this example](https://stephenchou1017.github.io/scheduler/#/infinitescroll).\n\n#### slotClickedFunc\n\n```js\nslotClickedFunc: PropTypes.func;\n```\n\nIf it's set, slots will be clickable, and will fire this function when a slot is clicked. Refer\nto [this example](https://stephenchou1017.github.io/scheduler/#/resourceclickable).\n\n#### dndSources\n\n```js\ndndSources: PropTypes.array;\n```\n\nDnDSource array that registered to Scheduler. Use [DnDSource](https://github.com/react-scheduler/react-big-schedule/blob/master/src/components/DnDSource.js),\nwe can simplify the drag and drop coding in React-Big-Scheduler. Refer\nto [this example](https://stephenchou1017.github.io/scheduler/#/draganddrop).\n\n#### onSetAddMoreState\n\n```js\nonSetAddMoreState: PropTypes.func;\nonSetAddMoreState(newState);\n```\n\nCallback function fired when a '+N more' is clicked, is used to control the visibility and the position of the `AddMorePopover`.\n`newState` is a json such as {headerItem: headerItem, left: 20, top: 20, height: 100}. Refer\nto [this example](https://stephenchou1017.github.io/scheduler/#/addmore).\n\n#### subtitleGetter\n\n```js\nsubtitleGetter: PropTypes.func;\nsubtitleGetter(schedulerData, event);\n```\n\nUse this function, you can display a subtitle in the `EventItemPopover`.\n\n#### viewEventClick\n\n```js\nviewEventClick: PropTypes.func;\nviewEventClick(schedulerData, event);\n```\n\nCallback function fired when you click one operation link in the `EventItemPopover`. The operation link won't appear if this\nfunction isn't set.\n\n#### viewEventText\n\n```js\nviewEventText: PropTypes.string;\n```\n\nText of one operation link in the `EventItemPopover`. The operation link won't appear if this text isn't set.\n\n#### viewEvent2Click\n\n```js\nviewEvent2Click: PropTypes.func;\nviewEvent2Click(schedulerData, event);\n```\n\nCallback function fired when you click the other operation link in the `EventItemPopover`. The other operation link won't\nappear if this function isn't set.\n\n#### viewEvent2Text\n\n```js\nviewEvent2Text: PropTypes.string;\n```\n\nText of the other operation link in the `EventItemPopover`. The other operation link won't appear if this text isn't set.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freact-scheduler%2Freact-big-schedule","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freact-scheduler%2Freact-big-schedule","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freact-scheduler%2Freact-big-schedule/lists"}