API na Scheduler don React

Shigo da shi

import-scheduler.tsx

import { NuiScheduler, type NuiSchedulerHandle } from '@needless-ui/react/scheduler';

NuiScheduler

Events a wata, mako, rana, ajanda ko timeline.

NuiScheduler: Kadarori
Suna	Iri	Na asali	Bayani
`events`Prop	`NuiSchedulerEvent<T>[]`	`[]`	Events da za a nuna.
`resources`Prop	`NuiSchedulerResource[]`	`[]`	Ɗakuna, mutane ko injuna: layukan timeline, da ginshiƙan rana da na mako.
`view` `defaultView` `onViewChange`Yanayi	`'month' \| 'week' \| 'day' \| 'agenda' \| 'timeline'`	`'week'`	Kallon da ake nunawa.
`views`Prop	`NuiSchedulerView[]`	`all`	Nau’o’in kallo da mutane za su iya sauyawa a tsakaninsu. Idan ba a saita ba, duka ne, amma timeline sai da resources.
`timelineSpan`Prop	`'day' \| 'week' \| 'month'`	`'day'`	Abin da timeline ke nunawa: rana bisa slots ɗinta, ko mako ko wata bisa kwanakinsu.
`date` `defaultDate` `onDateChange`Yanayi	`NuiDate`	`today`	Ranar da ake nunawa, da inda focus na allon madannai yake. Ku ba da `defaultDate` idan server ne ke nuna jadawalin: ranar yau a server ba lallai ta zama ranar yau ga mai karatu ba.
`slotMinutes`Prop	`number`	`30`	Mintunan kowane layi a grid na lokaci, ko na kowane ginshiƙi a timeline na rana.
`snapMinutes`Prop	`number`	`slotMinutes`	Matakin da events ke matsawa da sauya tsawo da shi.
`dayStart, dayEnd`Prop	`number`	`0, 24`	Sa’ar farko da ta ƙarshe da grid na lokaci ke nunawa.
`scrollHour`Prop	`number`	`8`	Sa’ar da grid na lokaci ke buɗewa a kanta.
`agendaDays`Prop	`number`	`30`	Kwanakin da ajanda ke dubawa a gaba.
`businessHours`Prop	`NuiSchedulerHours[]`		Sa’o’in aiki, kamar `{ days: [1, 2, 3, 4, 5], start: '09:00', end: '17:00' }`. Sauran lokaci yana da inuwa.
`weekends`Prop	`boolean`	`true`	Yana nuna ƙarshen mako. Idan an kashe shi, kowane kallo yana cire ƙarshen mako na yankin.
`weekNumbers`Prop	`boolean`	`false`	Yana nuna lambobin mako na ISO a cikin wata, da kuma saman lokuta.
`editable`Prop	`boolean`	`false`	Ana iya matsar da events da sauya tsawonsu, da linzami da allon madannai.
`selectable`Prop	`boolean`	`false`	Ana iya zaɓar lokaci a kan grid, don ƙirƙirar events.
`allow`Prop	`(time) => boolean`		Yana yanke hukunci ko matsarwa, sauya tsawo ko zaɓin lokaci zai iya faruwa.
`toolbar`Prop	`boolean \| ((toolbar: NuiSchedulerToolbar) => ReactNode)`	`true`	Yana nuna toolbar, ko ya zana naku daga abin da aka ba shi.
`firstDay`Prop	`1 … 7`		Ranar farko ta mako, 1 ita ce Litinin. Idan ba a saita ba, ta yankin ce.
`headingLevel`Prop	`number`	`2`	Matakin heading na take; kwanakin ajanda suna sauka mataki ɗaya.
`locale`Prop	`string`	`'en-US'`	Yana tsara kwanaki da lokuta.
`labels`Prop	`Partial<NuiSchedulerLabels>`		Kowane rubutu da jadawalin ke nunawa ko sanarwa, don fassarawa.
`corners`Prop	`NuiCorners`		Siffar kusurwoyinsa: `round`, `squircle`, `bevel`, `scoop`, `notch` ko `square`.
`radius`Prop	`NuiRadius`		Girman kusurwoyinsa: `none`, `small`, `medium`, `large` ko `full`.
`density`Prop	`NuiDensity`		Yawan sararin da yake ɗauka: `compact`, `regular` ko `roomy`.
`renderEvent`Render prop	`(event, { time }) => ReactNode`		Ku zana events da kanku, daga event ɗin da lokacinsa a matsayin rubutu.
`renderResource`Render prop	`(resource) => ReactNode`		Ku zana taken resources da kanku.
`onEventClick`Callback	`(event: NuiSchedulerEvent<T>) => void`		Ana kiransa da event da aka danna, ko aka buɗe da Enter.
`onEventChange`Callback	`({ event, start, end, resource? }) => void`		Ana kiransa da sabbin lokutan event bayan an matsar da shi ko an sauya tsawonsa, da resources ɗinsa idan sun canza. Ku sabunta `events` don riƙe canjin.
`onSlotSelect`Callback	`({ start, end, allDay, resource? }) => void`		Ana kiransa da lokacin da aka zaɓa a kan grid, da resource ɗinsa.
`onRangeChange`Callback	`({ start, end }) => void`		Ana kiransa da rana ta farko da ta ƙarshe da ake nunawa idan sun canza, don ku ɗauko events ɗinsu.
`ref`Prop	`Ref<NuiSchedulerHandle>`		Abin da `ref` na jadawalin ke kaiwa: sauya shafi, don toolbar naku.
`previous, next, goToday`Method	`() => void`		Suna nuna shafin baya ko na gaba, ko yau, don toolbar naku.
`title`Kadara	`string`		Abin da ake nunawa, kamar yadda taken toolbar ke faɗa.

Yanayi yana aiki kamar inputs na React da kansu: ku ba da ƙima, ku sabunta ta daga callback ɗinta na on…Change, ko ku ba da ƙimar default…, ku bar component ɗin ya riƙe ta.

Props na keɓancewa da ba ku saita ba suna bin attribute na data-nui-* mafi kusa. Ku duba jagorar keɓancewa.

NuiSchedulerToolbar

Abin da function na toolbar ke samu, don zana toolbar naku.

NuiSchedulerToolbar: Kadarori
Suna	Iri	Bayani
`title`Kadara	`string`	Abin da ake nunawa, kamar yadda taken toolbar ke faɗa.
`view, views`Kadara	`NuiSchedulerView, NuiSchedulerView[]`	Kallon da ake nunawa, da nau’o’in kallon da ake bayarwa.
`setView, previous, next, goToday`Method	`(view?) => void`	Suna sauya kallo, suna nuna shafin baya ko na gaba, ko yau.

NuiSchedulerEvent

Event ɗaya. Ƙarshen event mai lokaci ba ya ciki; ƙarshen event na duk yini shi ne ranarsa ta ƙarshe.

NuiSchedulerEvent: Kadarori
Suna	Iri	Na asali	Bayani
`id, title`Kadara	`string`		Key ɗinsa, da abin da yake nunawa.
`start, end`Kadara	`NuiDateTime \| NuiDate`		Kwanan wata da lokaci, ko kwanan wata kawai ga events na duk yini.
`allDay`Kadara	`boolean`		Idan ba a saita ba, ko `start` ba shi da lokaci.
`tone`Kadara	`'accent' \| 'neutral' \| 'success' \| 'warning' \| 'danger'`	`'accent'`	Palette ɗinsa.
`color, class`Kadara	`string`		Kowane launi na CSS, wanda ke rinjayar tone ɗinsa, da classes don ba shi salo.
`resource`Kadara	`string \| string[]`		Resources ɗin da yake da alaƙa da su.
`rrule`Kadara	`string`		Dokar maimaitawa daga RFC 5545, kamar `FREQ=WEEKLY;BYDAY=MO`.
`exdate`Kadara	`string[]`		Lokutan farawa na maimaitawa da aka cire.
`recurrenceId`Kadara	`NuiDateTime \| NuiDate`		A kan maimaitawar da jadawalin ke ba da rahotonta: farkon da dokar maimaitawa ta ba ta.
`editable`Kadara	`boolean`		Ko ana iya matsar da shi, ko mene ne jadawalin ya ce.
`data`Kadara	`T`		Duk wani abu da za a ajiye tare da shi.

NuiSchedulerResource

Ɗaki, mutum ko inji da events ke da alaƙa da shi.

NuiSchedulerResource: Kadarori
Suna	Iri	Bayani
`id, title`Kadara	`string`	Key ɗinsa, da sunan da yake nunawa.
`tone, color`Kadara	`NuiSchedulerTone, string`	Launukan events ɗinsa, sai dai idan suna da nasu.
`businessHours`Kadara	`NuiSchedulerHours[]`	Lokacin da yake samuwa, maimakon sa’o’in aiki na jadawalin.
`data`Kadara	`R`	Duk wani abu da za a ajiye tare da shi.

Helpers

Functions don events masu maimaituwa da fayilolin iCalendar.

Helpers: Kadarori
Suna	Iri	Bayani
`nuiSchedulerOccurrences`Method	`(event, first, last) => NuiSchedulerEvent[]`	Event kamar yadda yake bayyana a kwanakin da aka bayar: kowace maimaitawa ta event mai maimaituwa.
`nuiSchedulerRule`Method	`(text: string) => NuiSchedulerRule \| null`	Yana karanta dokar maimaitawa, ko yana dawo da null.
`nuiSchedulerToIcs`Method	`(events, options?) => string`	Yana rubuta events a matsayin fayil na iCalendar.
`nuiSchedulerFromIcs`Method	`(text, { timeZone? }) => NuiSchedulerEvent[]`	Yana karanta events na fayil na iCalendar, tare da lokutansu a yankin lokaci ɗaya.