@progress/kendo-vue-scheduler 5.3.0-dev.202409130647 → 5.3.0-develop.1

package/dist/esm/Scheduler.d.ts

@@ -1,337 +0,0 @@
-import { DefineComponent, RecordPropsDefinition, ComponentOptions, Vue2type } from './additionalTypes';
-declare type DefaultData<V> = object | ((this: V) => {});
-declare type DefaultMethods<V> = {
-    [key: string]: (this: V, ...args: any[]) => any;
-};
-import { DataItem, EditableProp, SchedulerGroup, SchedulerResource, SchedulerModelFields, SchedulerViewProps } from './models/main';
-/**
- * Represents the props of the [Kendo UI for Vue Scheduler component]({% slug overview_scheduler %}).
- */
-export interface SchedulerProps {
-    /**
-     * Specifies the `id` of the wrapping element of the Scheduler.
-     */
-    id?: string;
-    /**
-     * Specifies the `tabIndex` attribute of the wrapping element of the Scheduler.
-     */
-    tabIndex?: number;
-    /**
-     * Specifies the `role` attribute of the Scheduler wrapping element.
-     *
-     * For more information, refer to the [Scheduler Accessibility Compliance]({% slug accessibility_scheduler %}) article
-     */
-    role?: string;
-    /**
-     * The `aria-labelledby` attribute to be applied to the Scheduler component.
-     *
-     * For more information, refer to the [Scheduler Accessibility Compliance]({% slug accessibility_scheduler %}) article
-     */
-    ariaLabelledby?: string;
-    /**
-     * The `aria-label` attribute to be applied to the Scheduler component.
-     *
-     * For more information, refer to the [Scheduler Accessibility Compliance]({% slug accessibility_scheduler %}) article
-     */
-    ariaLabel?: string;
-    /**
-     * Specifies the `className` attribute of the wrapping element of the Scheduler.
-     */
-    className?: string;
-    /**
-     * Overrides the default item. Specifying the `item` property of a specific view will override this property.
-     *
-     * The default component is: [SchedulerItem]({% slug api_scheduler_scheduleritemprops %})
-     *
-     * For more information on customizing the scheduler items, refer to the [Item Customization]({% slug scheduler_custom_event %}) article.
-     */
-    item?: any;
-    /**
-     * Overrides the default viewItem. Specifying the `viewItem` property of a specific view will override this property.
-     *
-     * The default component is: [SchedulerViewItem]({% slug api_scheduler_schedulerviewitem %})
-     *
-     * For more information on customizing the scheduler items, refer to the [Item Customization]({% slug scheduler_custom_event %}) article.
-     */
-    viewItem?: any;
-    /**
-     * Overrides the default editItem. Specifying the `editItem` property of a specific view will override this property.
-     *
-     * The default component is: [SchedulerEditItem]({% slug api_scheduler_scheduleredititem %})
-     *
-     * For more information on customizing the scheduler items, refer to the [Item Customization]({% slug scheduler_custom_event %}) article.
-     */
-    editItem?: any;
-    /**
-     * Overrides the default task. Specifying the `task` property of a specific view will override this property.
-     * Currently, the `task` is being used in the [AgendaView]({% slug agenda_view_scheduler %}) only.
-     *
-     * The default component is: [SchedulerTask]({% slug api_scheduler_schedulertaskprops %})
-     *
-     * For more information on customizing the scheduler tasks, refer to the [Task Customization]({% slug overview_agenda_view_scheduler %}) article.
-     */
-    task?: any;
-    /**
-     *
-     *  Represents component based on the DateHeaderCellProps.
-     */
-    dateHeaderCell?: any;
-    /**
-     *
-     *  Represents component based on the TimeHeaderCellProps.
-     */
-    timeHeaderCell?: any;
-    /**
-     * Overrides the default viewTask. Specifying the `viewTask` property of a specific view will override this property.
-     * Currently, the `viewTask` is being used in the [AgendaView]({% slug agenda_view_scheduler %}) only.
-     *
-     * The default component is: [SchedulerViewTask]({% slug api_scheduler_schedulerviewtask %})
-     *
-     * For more information on customizing the scheduler tasks, refer to the [Task Customization]({% slug overview_agenda_view_scheduler %}) article.
-     */
-    viewTask?: any;
-    /**
-     * Overrides the default editTask. Specifying the `editTask` property of a specific view will override this property.
-     * Currently, the `viewTask` is being used in the [AgendaView]({% slug agenda_view_scheduler %}) only.
-     *
-     * The default component is: [SchedulerEditTask]({% slug api_scheduler_scheduleredittaskprops %})
-     *
-     * For more information on customizing the scheduler tasks, refer to the [Task Customization]({% slug overview_agenda_view_scheduler %}) article.
-     */
-    editTask?: any;
-    /**
-     * Overrides the default header component of the Scheduler.
-     *
-     * The default component is: [SchedulerHeader]({% slug api_scheduler_schedulerheader %})
-     *
-     * For more information on customizing the scheduler header, refer to the [Header Customization]({% slug overview_header_footer_scheduler %}) article.
-     */
-    header?: any;
-    /**
-     * Overrides the default footer component of the Scheduler.
-     *
-     * The default component is: [Scheduler]({% slug api_scheduler_schedulerfooterprops %})
-     *
-     * For more information on customizing the scheduler footer, refer to the [Footer Customization]({% slug overview_header_footer_scheduler %}) article.
-     */
-    footer?: any;
-    /**
-     * Overrides the default slot component. Specifying the `slot` property of a specific view will override this property.
-     *
-     * The default component is: [SchedulerSlot]({% slug api_scheduler_schedulerslotprops %})
-     *
-     * For more information on customizing the scheduler slots, refer to the [Slot Customization]({% slug scheduler_custom_slot %}) article.
-     */
-    slotRender?: any;
-    /**
-     * Overrides the default viewSlot component. Specifying the `viewSlot` property of a specific view will override this property.
-     *
-     * The default component is: [SchedulerViewSlot]({% slug api_scheduler_schedulerviewslotprops %})
-     *
-     * For more information on customizing the scheduler slots, refer to the [Slot Customization]({% slug scheduler_custom_slot %}) article.
-     */
-    viewSlot?: any;
-    /**
-     * Overrides the default editSlot component. Specifying the `editSlot` property of a specific view will override this property.
-     *
-     * The default component is: [SchedulerEditSlot]({% slug api_scheduler_schedulereditslot %})
-     *
-     * For more information on customizing the scheduler slots, refer to the [Slot Customization]({% slug scheduler_custom_slot %}) article.
-     */
-    editSlot?: any;
-    /** @hidden */
-    form?: any;
-    /** @hidden */
-    resizeHint?: any;
-    /** @hidden */
-    dialogProps?: any;
-    /** @hidden */
-    formProps?: any;
-    /**
-     * Sets the currently visible views.
-     */
-    views?: SchedulerViewProps[];
-    /**
-     * Sets the currently selected view. The value is matched with the `name` property of the view.
-     */
-    view?: string;
-    /**
-     * Sets the data of the Scheduler component. The data is then parsed and rendered as a visual Scheduler items.
-     */
-    dataItems?: DataItem[];
-    /**
-     * Sets if the Scheduler component is editable. The value can be either a `boolean` or an Object to specify different types of editing.
-     */
-    editable?: EditableProp | boolean;
-    /**
-     * Sets the initially selected view.
-     *
-     * For more information refer to the [Scheduler Views]({% slug views_scheduler %}) article.
-     *
-     * Sets the initially selected view. The available values are:
-     * * `day`
-     * * `week`
-     * * `month`
-     * * `agenda`
-     * * `timeline`
-     */
-    defaultView?: string;
-    /**
-     * Sets the current selected `Date`. The current selected date is passed to the selected view and transformed in to a range.
-     */
-    date?: Date;
-    /**
-     * Sets a default selected `Date`. The `defaultDate` property is used to specify the initial rendered date, while still remaining in an uncontrolled mode.
-     */
-    defaultDate?: Date;
-    /**
-     * Function that returns custom validator for the form.
-     */
-    validator?: Function;
-    /**
-     * Function that returns custom initial values for the fields of the form.
-     */
-    modifyInitialFormValues?: Function;
-    /**
-     * Force a `rtl` mode. For more information refer to [RTL Support]({% slug globalization_scheduler %}#toc-right-to-left-support)
-     */
-    rtl?: boolean;
-    /**
-     * Sets the `height` of the Scheduler.
-     */
-    height?: number | string;
-    /**
-     * Specifies the id of the timezone that will be displayed in the Scheduler.
-     * For example, `Europe/Sofia`.
-     *
-     * Defaults to `Etc/UTC`.
-     */
-    timezone?: string;
-    /**
-     * Specifies the groups of the Scheduler.
-     */
-    group?: SchedulerGroup;
-    /**
-     * Specifies the resources of the Scheduler.
-     */
-    resources?: SchedulerResource[];
-    /**
-     * The names of the model fields from which the Scheduler will read its data
-     * ([see example]({% slug data_binding_scheduler %})).
-     */
-    modelFields?: SchedulerModelFields;
-    /**
-     * Called when new `date` is selected.
-     */
-    onDateChange?: (args: SchedulerDateChangeEvent) => void;
-    /**
-     * Called when new `view` is selected. [(see example)]({% slug views_scheduler %}#toc-controlling-the-selected-view)
-     */
-    onViewChange?: (args: SchedulerViewChangeEvent) => void;
-    /**
-     * Called each time when editing occurs.
-     * To enable editing set the `editable` property to `true` or an [`EditableProp`]({% slug api_scheduler_editableprop %})
-     *
-     * For more information refer to the [Scheduler Editing]({% slug editing_scheduler %}) article.
-     */
-    onDataChange?: (event: SchedulerDataChangeEvent) => void;
-}
-/**
- * Specifies the available [DataAction]({% slug api_scheduler_data_action %}) types.
- */
-export declare enum DATA_ACTION {
-    create = 0,
-    update = 1,
-    remove = 2
-}
-/**
- * Specifies the action which can be dispatched through the [SchedulerDataContext]({% slug api_scheduler_schedulerdatacontext %}).
- *
- * For more information refer to the [Scheduler Context]({% slug context_scheduler %}) article.
- */
-export interface DataAction {
-    /**
-     * The `type` of the action. The available types are:
-     * - `create`
-     * - `update`
-     * - `remove`
-     */
-    type: DATA_ACTION;
-    /**
-     * Specifies if the action should be applied to the whole series of a recurring item. If the item is not recurring, set `series` to `false`.
-     */
-    series: boolean;
-    /**
-     * Specifies the `dataItem` being edited.
-     */
-    dataItem: DataItem;
-}
-/** @hidden */
-export interface DateChangeEvent {
-    target: any;
-    event: any;
-}
-/**
- * Called every time the user changes the selected `date`.
- * The value is a JavaScript `Date` object.
- * For more information, refer to the article on
- * [date selection]({% slug date_selection_scheduler %}).
- */
-export interface SchedulerDateChangeEvent {
-    value: Date;
-}
-/**
- * Called every time the user changes the provided `data`.
- *
- * For more information, refer to the [Scheduler Data Binding]({% slug data_binding_scheduler %}) article.
- */
-export interface SchedulerDataChangeEvent {
-    created: DataItem[];
-    updated: DataItem[];
-    deleted: DataItem[];
-}
-/** @hidden */
-export interface ActiveViewNameChangeEvent {
-    event: any;
-    target: any;
-}
-/**
- * Called every time the user changes the active `view`.
- *
- * For more information, refer to the [Scheduler Views]({% slug views_scheduler %}) article.
- */
-export interface SchedulerViewChangeEvent {
-    value: string;
-}
-/**
- * @hidden
- */
-export interface SchedulerState {
-}
-/**
- * @hidden
- */
-export interface SchedulerComputed {
-    [key: string]: any;
-}
-/**
- * @hidden
- */
-export interface SchedulerMethods {
-    [key: string]: any;
-}
-/**
- * @hidden
- */
-export interface SchedulerData {
-}
-/**
- * @hidden
- */
-export interface SchedulerAll extends Vue2type, SchedulerMethods, SchedulerData, SchedulerComputed, SchedulerState {
-}
-/** @hidden */
-declare let SchedulerVue2: ComponentOptions<SchedulerAll, DefaultData<SchedulerData>, DefaultMethods<SchedulerAll>, SchedulerComputed, RecordPropsDefinition<SchedulerProps>>;
-/** @hidden */
-declare const Scheduler: DefineComponent<SchedulerProps, any, SchedulerData, SchedulerComputed, SchedulerMethods, {}, {}, {}, string, SchedulerProps, SchedulerProps, {}>;
-export { Scheduler, SchedulerVue2 };