@progress/kendo-vue-scheduler 3.5.0 → 3.5.1-dev.202208150613

package/dist/esm/items/SchedulerEditItem.d.ts

@@ -0,0 +1,357 @@
+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, SchedulerItemDragEvent, SchedulerItemMouseEvent, SchedulerItemKeyboardEvent, SchedulerItemFocusEvent } from '../models';
+import { SchedulerOccurrenceDialogStateChangeEvent } from '../components/SchedulerOccurrenceDialog';
+import { SchedulerFormStateChangeEvent } from '../components/SchedulerForm';
+import { SchedulerRemoveDialogStateChangeEvent } from '../components/SchedulerRemoveDialog';
+import { DataAction } from '../Scheduler';
+import { SchedulerViewItemProps } from './SchedulerViewItem';
+import { SchedulerItemsFocusAction, SchedulerSlotsFocusAction } from '../hooks';
+import { SchedulerItemFormItemAction } from './hooks/use-form-item';
+import { SchedulerItemShowOccurrenceDialogAction } from './hooks/use-show-occurrence-dialog';
+import { SchedulerItemRemoveItemAction } from './hooks/use-remove-item';
+import { SchedulerItemShowRemoveDialogAction } from './hooks/use-show-remove-item-dialog';
+import { SchedulerItemDragItemAction } from './hooks/use-drag-item';
+import { SchedulerItemResizeItemAction } from './hooks/use-resize-item';
+import { SchedulerItemSeriesAction } from './hooks/use-series';
+import { SchedulerItemsSelectAction } from '../hooks/use-items-selection';
+import { SchedulerSlotsSelectAction } from '../hooks/use-slots-selection';
+export interface SchedulerEditItemStateChangeEvent<T> {
+    value: T;
+}
+/**
+ * Represents the available SchedulerEditItem` actions.
+ *
+ * Can be one of:
+ * - [SchedulerItemDragItemAction]({% slug api_scheduler_scheduleritemdragitemaction %})
+ * - [SchedulerItemResizeItemAction]({% slug api_scheduler_scheduleritemresizeitemaction %})
+ * - [SchedulerItemRemoveItemAction]({% slug api_scheduler_scheduleritemremoveitemaction %})
+ * - [SchedulerItemShowRemoveDialogAction]({% slug api_scheduler_scheduleritemshowremovedialogaction %})
+ * - [SchedulerItemShowOccurrenceDialogAction]({% slug api_scheduler_scheduleritemshowoccurrencedialogaction %})
+ * - [SchedulerItemSeriesAction]({% slug api_scheduler_scheduleritemseriesaction %})
+ * - [SchedulerItemsFocusAction]({% slug api_scheduler_scheduleritemsfocusaction %})
+ * - [SchedulerItemsSelectAction]({% slug api_scheduler_scheduleritemsselectaction %})
+ * - [SchedulerSlotsFocusAction]({% slug api_scheduler_schedulerslotsfocusaction %})
+ * - [SchedulerSlotsSelectAction]({% slug api_scheduler_schedulerslotsselectaction %})
+ *
+ * The following `falsy` values will be ignored:
+ * - `null`
+ * - `false`
+ * - `undefined`
+ */
+export declare type SchedulerEditItemAction = SchedulerItemFormItemAction | SchedulerItemDragItemAction | SchedulerItemResizeItemAction | SchedulerItemRemoveItemAction | SchedulerItemShowRemoveDialogAction | SchedulerItemShowOccurrenceDialogAction | SchedulerItemSeriesAction | SchedulerItemsFocusAction | SchedulerItemsSelectAction | SchedulerSlotsFocusAction | SchedulerSlotsSelectAction | null | false | undefined;
+/**
+ * Represents the props of the Kendo UI for Vue [SchedulerEditItem]() component.
+ */
+export interface SchedulerEditItemProps extends SchedulerViewItemProps {
+    /**
+     * Overrides the default component responsible for positioning the item inside the view.
+     *
+     * The default Component is: [SchedulerViewItem]({% slug api_scheduler_schedulerviewitem %}).
+     */
+    viewItem?: any;
+    /**
+     * Overrides the default component responsible for visualizing the `dragItem`.
+     *
+     * The default Component is: [SchedulerDrag]({% slug api_scheduler_schedulerdrag %}).
+     */
+    drag?: any;
+    /**
+     * Overrides the default component responsible for visualizing the `resizeItem`.
+     *
+     * The default Component is: [SchedulerResize]({% slug api_scheduler_schedulerresize %}).
+     */
+    resize?: any;
+    /**
+     * Overrides the default component responsible for visualizing the `formItem`.
+     *
+     * The default Component is: [SchedulerForm]({% slug api_scheduler_schedulerform %}).
+     */
+    form?: any;
+    /**
+     * Overrides the default component responsible for visualizing the `removeItem` and confirming the `remove` action.
+     *
+     * The default Component is: [SchedulerRemoveDialog]({% slug api_scheduler_schedulerremovedialog %}).
+     */
+    removeDialog?: any;
+    /**
+     * Overrides the default component responsible for the selection between `occurrence` and `series` edit.
+     *
+     * The default Component is: [SchedulerOccurrenceDialog]({% slug api_scheduler_scheduleroccurrencedialog %}).
+     */
+    occurrenceDialog?: any;
+    /**
+     * Called when the item has been removed or manipulated though dragging, resizing or an external form.
+     */
+    onDataaction?: (action: DataAction, event?: any) => void;
+    /**
+     * Setting this property will force the `formItem` to be in controlled state, allowing further customization.
+     */
+    formItem?: DataItem | null;
+    /**
+     * Called every time the `formItem` changes.
+     */
+    onFormItemChange?: (event: SchedulerEditItemStateChangeEvent<DataItem | null>) => void;
+    /**
+     * Setting this property will force the `dragItem` to be in controlled state, allowing further customization.
+     */
+    dragItem?: DataItem | null;
+    /**
+     * Called every time the `dragItem` changes.
+     */
+    onDragItemChange?: (event: SchedulerEditItemStateChangeEvent<DataItem | null>) => void;
+    /**
+     * Setting this property will force the `resizeItem` to be in controlled state, allowing further customization.
+     */
+    resizeItem?: DataItem | null;
+    /**
+     * Called every time the `resize` changes.
+     */
+    onResizeItemChange?: (event: SchedulerEditItemStateChangeEvent<DataItem | null>) => void;
+    /**
+     * Setting this property will force the `removeItem` to be in controlled state, allowing further customization.
+     *
+     * Specifies the DataItem which should be removed from the `data` set.
+     * The `removeItem` is passed as property to the `removeDialog` and `occurrenceDialog` component;
+     */
+    removeItem?: DataItem | null;
+    /**
+     * Called every time the `removeItem` changes.
+     */
+    onRemoveItemChange?: (event: SchedulerEditItemStateChangeEvent<DataItem | null>) => void;
+    /**
+     * Setting this property will force the `showOccurrenceDialog` to be in controlled state, allowing further control over the display of the `occurrenceDialog` component.
+     */
+    showOccurrenceDialog?: boolean;
+    /**
+     * Called every time the `showOccurrenceDialog` changes.
+     */
+    onShowOccurrenceDialogChange?: (event: SchedulerEditItemStateChangeEvent<boolean>) => void;
+    /**
+     * Setting this property will force the `showRemoveDialog` to be in controlled state, allowing further control over the display of the `removeDialog` component.
+     */
+    showRemoveDialog?: boolean;
+    /**
+     * Called every time the `showRemoveDialog` changes.
+     */
+    onShowRemoveDialogChange?: (event: SchedulerEditItemStateChangeEvent<boolean>) => void;
+    /**
+     * Indicates if the editing should be applied to the whole `series` or to a single `occurrence` when the item is recurring.
+     *
+     * By default, the `series` prop is set to `null` and additional selection is done through the `occurrence` dialog.
+     * If set ot either `true` or `false`:
+     * - `true` &mdash; indicates that the editing should always be applied to the whole `series`
+     * - `false` &mdash; indicates that the editing should always be applied to a single `occurrence`.
+     */
+    series?: boolean | null;
+    /**
+     * Called every time the `series` changes.
+     */
+    onSeriesChange?: (event: SchedulerEditItemStateChangeEvent<boolean | null>) => void;
+    /**
+     * Called whenever the `occurence` option is selected from the `OccurrenceDialog`.
+     */
+    onOccurrenceClick?: (event: SchedulerOccurrenceDialogStateChangeEvent<any>) => void;
+    /**
+     * An action callback. Used to define the component behavior on occurrence click.
+     *
+     * Internal state change will be triggered depending on the specific action types.
+     */
+    onOccurrenceClickAction?: (event: SchedulerOccurrenceDialogStateChangeEvent<any>, props: SchedulerEditItemProps, state: SchedulerEditItemState) => SchedulerEditItemAction | (SchedulerEditItemAction)[];
+    /**
+     * Called whenever the `series` option is selected from the `OccurrenceDialog`.
+     */
+    onSeriesClick?: (event: SchedulerOccurrenceDialogStateChangeEvent<any>) => void;
+    /**
+     * An action callback. Used to define the component behavior on series click.
+     *
+     * Internal state change will be triggered depending on the specific action types.
+     */
+    onSeriesClickAction?: (event: SchedulerOccurrenceDialogStateChangeEvent<any>, props: SchedulerEditItemProps, state: SchedulerEditItemState) => SchedulerEditItemAction | (SchedulerEditItemAction)[];
+    /**
+     * Called whenever the `confirm` option is selected from the `RemoveDialog`.
+     */
+    onRemoveConfirm?: (event: SchedulerRemoveDialogStateChangeEvent<any>) => void;
+    /**
+     * An action callback. Used to define the component behavior on remove confirm click.
+     *
+     * Internal state change will be triggered depending on the specific action types.
+     */
+    onRemoveConfirmAction?: (event: SchedulerRemoveDialogStateChangeEvent<any>, props: SchedulerEditItemProps, state: SchedulerEditItemState) => SchedulerEditItemAction | (SchedulerEditItemAction)[];
+    /**
+     * Called whenever the `form` is submitted.
+     */
+    onFormSubmit?: (event: SchedulerFormStateChangeEvent<DataItem | null>) => void;
+    /**
+     * An action callback. Used to define the component behavior on form submit.
+     *
+     * Internal state change will be triggered depending on the specific action types.
+     */
+    onFormSubmitAction?: (event: SchedulerFormStateChangeEvent<DataItem | null>, props: SchedulerEditItemProps, state: SchedulerEditItemState) => SchedulerEditItemAction | (SchedulerEditItemAction)[];
+    /**
+     * Called whenever the current edit is canceled.
+     */
+    onCancel?: (event: SchedulerFormStateChangeEvent<null> | SchedulerOccurrenceDialogStateChangeEvent<null>) => void;
+    /**
+     * An action callback. Used to define the component behavior on cancel.
+     *
+     * Internal state change will be triggered depending on the specific action types.
+     */
+    onCancelAction?: (event: SchedulerFormStateChangeEvent<null> | SchedulerOccurrenceDialogStateChangeEvent<null>, props: SchedulerEditItemProps, state: SchedulerEditItemState) => SchedulerEditItemAction | (SchedulerEditItemAction)[];
+    /**
+     * An action callback. Used to define the component behavior on click.
+     *
+     * Internal state change will be triggered depending on the specific action types.
+     */
+    onClickAction?: (event: SchedulerItemMouseEvent, props: SchedulerEditItemProps, state: SchedulerEditItemState) => SchedulerEditItemAction | (SchedulerEditItemAction)[];
+    /**
+     * An action callback. Used to define the component behavior on mouse down.
+     *
+     * Internal state change will be triggered depending on the specific action types.
+     */
+    onMouseDownAction?: (event: SchedulerItemMouseEvent, props: SchedulerEditItemProps, state: SchedulerEditItemState) => SchedulerEditItemAction | (SchedulerEditItemAction)[];
+    /**
+     * An action callback. Used to define the component behavior on mouse up.
+     *
+     * Internal state change will be triggered depending on the specific action types.
+     */
+    onMouseUpAction?: (event: SchedulerItemMouseEvent, props: SchedulerEditItemProps, state: SchedulerEditItemState) => SchedulerEditItemAction | (SchedulerEditItemAction)[];
+    /**
+     * An action callback. Used to define the component behavior on double click.
+     *
+     * Internal state change will be triggered depending on the specific action types.
+     */
+    onDoubleClickAction?: (event: SchedulerItemMouseEvent, props: SchedulerEditItemProps, state: SchedulerEditItemState) => SchedulerEditItemAction | (SchedulerEditItemAction)[];
+    /**
+     * An action callback. Used to define the component behavior on remove click.
+     *
+     * Internal state change will be triggered depending on the specific action types.
+     */
+    onRemoveClickAction?: (event: SchedulerItemMouseEvent, props: SchedulerEditItemProps, state: SchedulerEditItemState) => SchedulerEditItemAction | (SchedulerEditItemAction)[];
+    /**
+     * An action callback. Used to define the component behavior on key down.
+     *
+     * Internal state change will be triggered depending on the specific action types.
+     */
+    onKeyDownAction?: (event: SchedulerItemKeyboardEvent, props: SchedulerEditItemProps, state: SchedulerEditItemState) => SchedulerEditItemAction | (SchedulerEditItemAction)[];
+    /**
+     * An action callback. Used to define the component behavior on key up.
+     *
+     * Internal state change will be triggered depending on the specific action types.
+     */
+    onKeyUpAction?: (event: SchedulerItemKeyboardEvent, props: SchedulerEditItemProps, state: SchedulerEditItemState) => SchedulerEditItemAction | (SchedulerEditItemAction)[];
+    /**
+     * An action callback. Used to define the component behavior on focus.
+     *
+     * Internal state change will be triggered depending on the specific action types.
+     */
+    onFocusAction?: (event: SchedulerItemFocusEvent, props: SchedulerEditItemProps, state: SchedulerEditItemState) => SchedulerEditItemAction | (SchedulerEditItemAction)[];
+    /**
+     * An action callback. Used to define the component behavior on blur.
+     *
+     * Internal state change will be triggered depending on the specific action types.
+     */
+    onBlurAction?: (event: SchedulerItemFocusEvent, props: SchedulerEditItemProps, state: SchedulerEditItemState) => SchedulerEditItemAction | (SchedulerEditItemAction)[];
+    /**
+     * An action callback. Used to define the component behavior on press.
+     *
+     * Internal state change will be triggered depending on the specific action types.
+     */
+    onPressAction?: (event: SchedulerItemDragEvent, props: SchedulerEditItemProps, state: SchedulerEditItemState) => SchedulerEditItemAction | (SchedulerEditItemAction)[];
+    /**
+     * An action callback. Used to define the component behavior on drag.
+     *
+     * Internal state change will be triggered depending on the specific action types.
+     */
+    onDragAction?: (event: SchedulerItemDragEvent, props: SchedulerEditItemProps, state: SchedulerEditItemState) => SchedulerEditItemAction | (SchedulerEditItemAction)[];
+    /**
+     * An action callback. Used to define the component behavior on release.
+     *
+     * Internal state change will be triggered depending on the specific action types.
+     */
+    onReleaseAction?: (event: SchedulerItemDragEvent, props: SchedulerEditItemProps, state: SchedulerEditItemState) => SchedulerEditItemAction | (SchedulerEditItemAction)[];
+    /**
+     * An action callback. Used to define the component behavior on resize press.
+     *
+     * Internal state change will be triggered depending on the specific action types.
+     */
+    onResizePressAction?: (event: SchedulerItemDragEvent, props: SchedulerEditItemProps, state: SchedulerEditItemState) => SchedulerEditItemAction | (SchedulerEditItemAction)[];
+    /**
+     * An action callback. Used to define the component behavior on resize start drag.
+     *
+     * Internal state change will be triggered depending on the specific action types.
+     */
+    onResizeStartDragAction?: (event: SchedulerItemDragEvent, props: SchedulerEditItemProps, state: SchedulerEditItemState) => SchedulerEditItemAction | (SchedulerEditItemAction)[];
+    /**
+     * An action callback. Used to define the component behavior on resize end drag.
+     *
+     * Internal state change will be triggered depending on the specific action types.
+     */
+    onResizeEndDragAction?: (event: SchedulerItemDragEvent, props: SchedulerEditItemProps, state: SchedulerEditItemState) => SchedulerEditItemAction | (SchedulerEditItemAction)[];
+    /**
+     * An action callback. Used to define the component behavior on resize release.
+     *
+     * Internal state change will be triggered depending on the specific action types.
+     */
+    onResizeReleaseAction?: (event: SchedulerItemDragEvent, props: SchedulerEditItemProps, state: SchedulerEditItemState) => SchedulerEditItemAction | (SchedulerEditItemAction)[];
+}
+/**
+ * @hidden
+ */
+export interface SchedulerEditItemState {
+    selected: boolean;
+    series: boolean | null;
+    formItem: DataItem | null;
+    dragItem: DataItem | null;
+    resizeItem: DataItem | null;
+    removeItem: DataItem | null;
+    showRemoveDialog: DataItem | null;
+    showOccurrenceDialog: DataItem | null;
+}
+/**
+ * @hidden
+ */
+export interface SchedulerEditItemHandle {
+    element: HTMLDivElement | null;
+    props: SchedulerEditItemProps;
+}
+/**
+ * @hidden
+ */
+export interface SchedulerEditItemState {
+}
+/**
+ * @hidden
+ */
+export interface SchedulerEditItemComputed {
+    [key: string]: any;
+    currentTabIndex: number | undefined | null;
+}
+/**
+ * @hidden
+ */
+export interface SchedulerEditItemMethods {
+    [key: string]: any;
+}
+/**
+ * @hidden
+ */
+export interface SchedulerEditItemData {
+}
+/**
+ * @hidden
+ */
+export interface SchedulerEditItemAll extends Vue2type, SchedulerEditItemMethods, SchedulerEditItemData, SchedulerEditItemComputed, SchedulerEditItemState {
+}
+/**
+ * @hidden
+ */
+declare let SchedulerEditItemVue2: ComponentOptions<SchedulerEditItemAll, DefaultData<SchedulerEditItemData>, DefaultMethods<SchedulerEditItemAll>, SchedulerEditItemComputed, RecordPropsDefinition<SchedulerEditItemProps>>;
+/**
+ * @hidden
+ */
+declare const SchedulerEditItem: DefineComponent<SchedulerEditItemProps, any, SchedulerEditItemData, SchedulerEditItemComputed, SchedulerEditItemMethods, {}, {}, {}, string, SchedulerEditItemProps, SchedulerEditItemProps, {}>;
+export { SchedulerEditItem, SchedulerEditItemVue2 };