React کے لیے Scheduler کا API ریفرنس

امپورٹ

import-scheduler.tsx

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

NuiScheduler

مہینے، ہفتے، دن، ایجنڈا یا ٹائم لائن میں ایونٹس۔

NuiScheduler: پراپرٹیز
نام	ٹائپ	ڈیفالٹ	تفصیل
`events`پراپ	`NuiSchedulerEvent<T>[]`	`[]`	دکھائے جانے والے ایونٹس۔
`resources`پراپ	`NuiSchedulerResource[]`	`[]`	کمرے، لوگ یا مشینیں: ٹائم لائن کی قطاریں، اور دن اور ہفتے کے کالم۔
`view` `defaultView` `onViewChange`اسٹیٹ	`'month' \| 'week' \| 'day' \| 'agenda' \| 'timeline'`	`'week'`	دکھایا جانے والا منظر۔
`views`پراپ	`NuiSchedulerView[]`	`all`	وہ منظر جن کے درمیان صارفین بدل سکتے ہیں۔ ڈیفالٹ طور پر سبھی، اور ٹائم لائن صرف ریسورسز ہونے پر۔
`timelineSpan`پراپ	`'day' \| 'week' \| 'month'`	`'day'`	ٹائم لائن کیا دکھاتی ہے: ایک دن اس کے سلاٹس کے حساب سے، یا ایک ہفتہ یا مہینہ اس کے دنوں کے حساب سے۔
`date` `defaultDate` `onDateChange`اسٹیٹ	`NuiDate`	`today`	دکھایا گیا دن، اور جہاں کی بورڈ فوکس ہے۔ جب سرور شیڈولر رینڈر کرے تو `defaultDate` پاس کریں: ضروری نہیں کہ سرور کا “آج” پڑھنے والے کا بھی “آج” ہو۔
`slotMinutes`پراپ	`number`	`30`	ٹائم گرڈ کی ہر قطار کے منٹ، یا ایک دن کی ٹائم لائن کے ہر کالم کے۔
`snapMinutes`پراپ	`number`	`slotMinutes`	وہ اسٹیپ جس سے ایونٹس منتقل اور ری سائز ہوتے ہیں۔
`dayStart, dayEnd`پراپ	`number`	`0, 24`	وہ گھنٹے جو ٹائم گرڈ دکھاتا ہے، کب سے کب تک۔
`scrollHour`پراپ	`number`	`8`	وہ گھنٹہ جس پر ٹائم گرڈ کھلتا ہے۔
`agendaDays`پراپ	`number`	`30`	ایجنڈا کتنے دن آگے تک دکھاتا ہے۔
`businessHours`پراپ	`NuiSchedulerHours[]`		کام کے اوقات، جیسے `{ days: [1, 2, 3, 4, 5], start: '09:00', end: '17:00' }`۔ باقی وقت سایہ دار ہوتا ہے۔
`weekends`پراپ	`boolean`	`true`	ویک اینڈ دکھاتا ہے۔ اس کے بغیر ہر منظر لوکیل کا ویک اینڈ چھوڑ دیتا ہے۔
`weekNumbers`پراپ	`boolean`	`false`	مہینے میں، اور اوقات کے اوپر، ISO کے مطابق ہفتوں کے نمبر دکھاتا ہے۔
`editable`پراپ	`boolean`	`false`	ایونٹس کو پوائنٹر اور کی بورڈ سے منتقل اور ری سائز کیا جا سکتا ہے۔
`selectable`پراپ	`boolean`	`false`	ایونٹس بنانے کے لیے گرڈ پر وقت چنا جا سکتا ہے۔
`allow`پراپ	`(time) => boolean`		طے کرتا ہے کہ منتقلی، ری سائز یا وقت کا انتخاب ہو سکتا ہے یا نہیں۔
`toolbar`پراپ	`boolean \| ((toolbar: NuiSchedulerToolbar) => ReactNode)`	`true`	ٹول بار دکھاتا ہے، یا جو کچھ اسے ملتا ہے اس سے آپ کا اپنا ٹول بار بناتا ہے۔
`firstDay`پراپ	`1 … 7`		ہفتے کا پہلا دن، جہاں 1 پیر ہے۔ ڈیفالٹ طور پر لوکیل کا۔
`headingLevel`پراپ	`number`	`2`	عنوان کی ہیڈنگ کا لیول؛ ایجنڈا کے دن ایک لیول نیچے ہوتے ہیں۔
`locale`پراپ	`string`	`'en-US'`	دن اور اوقات فارمیٹ کرتا ہے۔
`labels`پراپ	`Partial<NuiSchedulerLabels>`		شیڈولر کا دکھایا یا پڑھ کر سنایا جانے والا ہر متن، ترجمے کے لیے۔
`corners`پراپ	`NuiCorners`		اس کے کونوں کی شکل: `round`، `squircle`، `bevel`، `scoop`، `notch` یا `square`۔
`radius`پراپ	`NuiRadius`		اس کے کونے کتنے بڑے ہیں: `none`، `small`، `medium`، `large` یا `full`۔
`density`پراپ	`NuiDensity`		یہ کتنی جگہ لیتا ہے: `compact`، `regular` یا `roomy`۔
`renderEvent`رینڈر پراپ	`(event, { time }) => ReactNode`		ایونٹس خود بنائیں، ایونٹ اور متن کی صورت میں اس کے وقت سے۔
`renderResource`رینڈر پراپ	`(resource) => ReactNode`		ریسورسز کے ہیڈر خود بنائیں۔
`onEventClick`کال بیک	`(event: NuiSchedulerEvent<T>) => void`		کلک کیے گئے، یا Enter سے کھولے گئے ایونٹ کے ساتھ کال ہوتا ہے۔
`onEventChange`کال بیک	`({ event, start, end, resource? }) => void`		منتقل یا ری سائز ہونے کے بعد ایونٹ کے نئے اوقات کے ساتھ کال ہوتا ہے، اور اس کے ریسورسز کے ساتھ بھی، اگر وہ بدلے ہوں۔ تبدیلی برقرار رکھنے کے لیے `events` اپ ڈیٹ کریں۔
`onSlotSelect`کال بیک	`({ start, end, allDay, resource? }) => void`		گرڈ پر چنے گئے وقت اور اس کے ریسورس کے ساتھ کال ہوتا ہے۔
`onRangeChange`کال بیک	`({ start, end }) => void`		دکھائے گئے پہلے اور آخری دن کے ساتھ، ان کے بدلنے پر کال ہوتا ہے، تاکہ آپ ان کے ایونٹس لوڈ کر سکیں۔
`ref`پراپ	`Ref<NuiSchedulerHandle>`		شیڈولر کا `ref` کن چیزوں تک پہنچتا ہے: صفحے بدلنا، آپ کے اپنے ٹول بار کے لیے۔
`previous, next, goToday`میتھڈ	`() => void`		پچھلا یا اگلا صفحہ، یا آج کا دن دکھاتے ہیں، آپ کے اپنے ٹول بار کے لیے۔
`title`پراپرٹی	`string`		جو دکھایا جا رہا ہے، ٹول بار کے عنوان کے الفاظ میں۔

اسٹیٹ React کے اپنے ان پٹ فیلڈز کی طرح کام کرتی ہے: ویلیو پاس کریں اور اسے اس کے on…Change کال بیک سے اپ ڈیٹ کریں، یا default… ویلیو پاس کریں اور اسے کمپوننٹ کے پاس رہنے دیں۔

کسٹمائزیشن کے جو پراپس آپ سیٹ نہ کریں، وہ قریب ترین data-nui-* ایٹریبیوٹ کی پیروی کرتے ہیں۔ کسٹمائزیشن گائیڈ دیکھیں۔

NuiSchedulerToolbar

toolbar فنکشن کو کیا ملتا ہے، تاکہ آپ اپنا ٹول بار بنا سکیں۔

NuiSchedulerToolbar: پراپرٹیز
نام	ٹائپ	تفصیل
`title`پراپرٹی	`string`	جو دکھایا جا رہا ہے، ٹول بار کے عنوان کے الفاظ میں۔
`view, views`پراپرٹی	`NuiSchedulerView, NuiSchedulerView[]`	دکھایا جانے والا منظر، اور پیش کیے گئے منظر۔
`setView, previous, next, goToday`میتھڈ	`(view?) => void`	منظر بدلتے ہیں، پچھلا یا اگلا صفحہ دکھاتے ہیں، یا آج کا دن۔

NuiSchedulerEvent

ایک ایونٹ۔ وقت والے ایونٹ کا اختتام اس میں شامل نہیں ہوتا؛ پورے دن کے ایونٹ کا اختتام اس کا آخری دن ہوتا ہے۔

NuiSchedulerEvent: پراپرٹیز
نام	ٹائپ	ڈیفالٹ	تفصیل
`id, title`پراپرٹی	`string`		اس کی کلید، اور جو یہ دکھاتا ہے۔
`start, end`پراپرٹی	`NuiDateTime \| NuiDate`		تاریخیں اور اوقات، یا پورے دن کے ایونٹس کے لیے صرف تاریخیں۔
`allDay`پراپرٹی	`boolean`		ڈیفالٹ طور پر، کیا `start` میں وقت نہیں ہے۔
`tone`پراپرٹی	`'accent' \| 'neutral' \| 'success' \| 'warning' \| 'danger'`	`'accent'`	اس کا پیلیٹ۔
`color, class`پراپرٹی	`string`		کوئی بھی CSS رنگ، جو اس کے ٹون پر غالب رہتا ہے، اور اسے اسٹائل کرنے کے لیے کلاسز۔
`resource`پراپرٹی	`string \| string[]`		وہ ریسورسز جن سے یہ وابستہ ہے۔
`rrule`پراپرٹی	`string`		RFC 5545 کا دہرانے کا اصول، جیسے `FREQ=WEEKLY;BYDAY=MO`۔
`exdate`پراپرٹی	`string[]`		جو دہراؤ نہیں ہوتے، ان کے آغاز کے اوقات۔
`recurrenceId`پراپرٹی	`NuiDateTime \| NuiDate`		شیڈولر کے بتائے ہوئے کسی دہراؤ پر: وہ آغاز جو اسے اس کے اصول نے دیا۔
`editable`پراپرٹی	`boolean`		کیا اسے منتقل کیا جا سکتا ہے، شیڈولر کی سیٹنگ جو بھی ہو۔
`data`پراپرٹی	`T`		اس کے ساتھ رکھنے کے لیے کوئی بھی اور چیز۔

NuiSchedulerResource

کوئی کمرہ، شخص یا مشین، جس سے ایونٹس وابستہ ہوتے ہیں۔

NuiSchedulerResource: پراپرٹیز
نام	ٹائپ	تفصیل
`id, title`پراپرٹی	`string`	اس کی کلید، اور وہ نام جو یہ دکھاتا ہے۔
`tone, color`پراپرٹی	`NuiSchedulerTone, string`	اس کے ایونٹس کے رنگ، جب تک ان کے اپنے رنگ نہ ہوں۔
`businessHours`پراپرٹی	`NuiSchedulerHours[]`	یہ کب دستیاب ہے، شیڈولر کے کام کے اوقات کی جگہ۔
`data`پراپرٹی	`R`	اس کے ساتھ رکھنے کے لیے کوئی بھی اور چیز۔

Helpers

دہرائے جانے والے ایونٹس اور iCalendar فائلوں کے لیے فنکشنز۔

Helpers: پراپرٹیز
نام	ٹائپ	تفصیل
`nuiSchedulerOccurrences`میتھڈ	`(event, first, last) => NuiSchedulerEvent[]`	دیے گئے دنوں میں ایونٹ جیسا دکھتا ہے: دہرائے جانے والے ایونٹ کا ہر دہراؤ۔
`nuiSchedulerRule`میتھڈ	`(text: string) => NuiSchedulerRule \| null`	دہرانے کا اصول پڑھتا ہے، یا null لوٹاتا ہے۔
`nuiSchedulerToIcs`میتھڈ	`(events, options?) => string`	ایونٹس کو iCalendar فائل کے طور پر لکھتا ہے۔
`nuiSchedulerFromIcs`میتھڈ	`(text, { timeZone? }) => NuiSchedulerEvent[]`	iCalendar فائل کے ایونٹس پڑھتا ہے، ان کے اوقات ایک ہی ٹائم زون میں۔