@fullcalendar/interaction

  • Version 6.1.0
  • Published
  • 323 kB
  • No dependencies
  • MIT license

Install

npm i @fullcalendar/interaction
yarn add @fullcalendar/interaction
pnpm add @fullcalendar/interaction

Overview

Calendar functionality for event drag-n-drop, event resizing, date clicking, and date selecting

Index

Variables

variable _default

const _default: PluginDef;

    variable LISTENER_REFINERS

    const LISTENER_REFINERS: {
    dateClick: Identity<(arg: DateClickArg) => void>;
    eventDragStart: Identity<(arg: EventDragStartArg) => void>;
    eventDragStop: Identity<(arg: EventDragStopArg) => void>;
    eventDrop: Identity<(arg: EventDropArg) => void>;
    eventResizeStart: Identity<(arg: EventResizeStartArg) => void>;
    eventResizeStop: Identity<(arg: EventResizeStopArg) => void>;
    eventResize: Identity<(arg: EventResizeDoneArg) => void>;
    drop: Identity<(arg: DropArg) => void>;
    eventReceive: Identity<(arg: EventReceiveArg) => void>;
    eventLeave: Identity<(arg: EventLeaveArg) => void>;
    };

      variable OPTION_REFINERS

      const OPTION_REFINERS: { fixedMirrorParent: Identity<HTMLElement> };

        Classes

        class Draggable

        class ExternalDraggable {}

          constructor

          constructor(el: HTMLElement, settings?: ExternalDraggableSettings);

            property dragging

            dragging: FeaturefulElementDragging;

              property handleDragStart

              handleDragStart: (ev: PointerDragEvent) => void;

                property handlePointerDown

                handlePointerDown: (ev: PointerDragEvent) => void;

                  property settings

                  settings: ExternalDraggableSettings;

                    method destroy

                    destroy: () => void;

                      class ThirdPartyDraggable

                      class ThirdPartyDraggable {}

                        constructor

                        constructor(
                        containerOrSettings?: EventTarget | ThirdPartyDraggableSettings,
                        settings?: ThirdPartyDraggableSettings
                        );

                          property dragging

                          dragging: InferredElementDragging;

                            method destroy

                            destroy: () => void;

                              Interfaces

                              interface DateClickArg

                              interface DateClickArg extends DatePointApi {}

                                property dayEl

                                dayEl: HTMLElement;

                                  property jsEvent

                                  jsEvent: MouseEvent;

                                    property view

                                    view: ViewApi;

                                      interface DropArg

                                      interface DropArg extends DatePointApi {}

                                        property draggedEl

                                        draggedEl: HTMLElement;

                                          property jsEvent

                                          jsEvent: MouseEvent;

                                            property view

                                            view: ViewApi;

                                              interface EventResizeDoneArg

                                              interface EventResizeDoneArg extends EventChangeArg {}

                                                property el

                                                el: HTMLElement;

                                                  property endDelta

                                                  endDelta: Duration;

                                                    property jsEvent

                                                    jsEvent: MouseEvent;

                                                      property startDelta

                                                      startDelta: Duration;

                                                        property view

                                                        view: ViewApi;

                                                          Type Aliases

                                                          type EventDragStartArg

                                                          type EventDragStartArg = EventDragArg;

                                                            type EventDragStopArg

                                                            type EventDragStopArg = EventDragArg;

                                                              type EventLeaveArg

                                                              type EventLeaveArg = EventReceiveLeaveArg;

                                                                type EventReceiveArg

                                                                type EventReceiveArg = EventReceiveLeaveArg;

                                                                  type EventResizeStartArg

                                                                  type EventResizeStartArg = EventResizeStartStopArg;

                                                                    type EventResizeStopArg

                                                                    type EventResizeStopArg = EventResizeStartStopArg;

                                                                      Package Files (1)

                                                                      Dependencies (0)

                                                                      No dependencies.

                                                                      Dev Dependencies (0)

                                                                      No dev dependencies.

                                                                      Peer Dependencies (1)

                                                                      Badge

                                                                      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@fullcalendar/interaction.

                                                                      • Markdown
                                                                        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@fullcalendar/interaction)
                                                                      • HTML
                                                                        <a href="https://www.jsdocs.io/package/@fullcalendar/interaction"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>