Type Alias InteractionEvents

InteractionEvents: {
    afterRender?: ((parameters: {
        element: HTMLElement;
        interval: Interval;
        view: View;
    }) => Promise<void>);
    beforeRender?: ((parameters: {
        element: HTMLElement;
        interval: Interval;
        view: View;
    }) => Promise<void>);
    click?: ((parameters: ClndrItemEventParameters) => void);
    navigate?: ((parameters: NavigationEventParameters) => void);
    ready?: ((parameters: {
        element: HTMLElement;
        interval: Interval;
        view: View;
    }) => void);
    switchView?: ((parameters: {
        view: View;
    }) => Promise<void>);
}

Type declaration

  • OptionalafterRender?: ((parameters: {
        element: HTMLElement;
        interval: Interval;
        view: View;
    }) => Promise<void>)

    A callback triggered when the calendar is done rendering.

      • (parameters): Promise<void>

      • Parameters

        • parameters: {
              element: HTMLElement;
              interval: Interval;
              view: View;
          }
          • element: HTMLElement

            The calendar's root element.

          • interval: Interval

            The interval rendered.

          • view: View

            The view rendered.

        Returns Promise<void>

  • OptionalbeforeRender?: ((parameters: {
        element: HTMLElement;
        interval: Interval;
        view: View;
    }) => Promise<void>)

    A callback triggered when the calendar is about to render.

      • (parameters): Promise<void>

      • Parameters

        • parameters: {
              element: HTMLElement;
              interval: Interval;
              view: View;
          }
          • element: HTMLElement

            The calendar's root element.

          • interval: Interval

            The interval about to be rendered.

          • view: View

            The view about to be rendered.

        Returns Promise<void>

  • Optionalclick?: ((parameters: ClndrItemEventParameters) => void)

    A callback triggered whenever a calendar item is clicked. This may be a "valid" calendar item, or an empty placeholder item.

  • Optionalnavigate?: ((parameters: NavigationEventParameters) => void)

    Triggered whenever navigating the calendar, which is any navigation operation other than directly clicking a calendar item, i.e. clicking the "back" and "forward" buttons, clicking the "today" button etc.

  • Optionalready?: ((parameters: {
        element: HTMLElement;
        interval: Interval;
        view: View;
    }) => void)

    Callback triggered once the calendar has been initialized and rendered.

      • (parameters): void

      • Parameters

        • parameters: {
              element: HTMLElement;
              interval: Interval;
              view: View;
          }
          • element: HTMLElement

            The calendar's root element.

          • interval: Interval

            The interval that has been rendered initially.

          • view: View

            The view that has been rendered initially.

        Returns void

  • OptionalswitchView?: ((parameters: {
        view: View;
    }) => Promise<void>)

    Callback triggered whenever the view is switched. The callback is triggered before rendering, hence any update to the calendar events done in this callback, will be considered when rendering the new view.

      • (parameters): Promise<void>

      • Parameters

        • parameters: {
              view: View;
          }
          • view: View

            The view that is switched to.

        Returns Promise<void>

Settings

Member Visibility