@theredhead — Frontend Library - v1.0.0
    Preparing search index...

    Interface CalendarEvent<T>

    A single calendar event.

    interface CalendarEvent<T = unknown> {
        allDay?: boolean;
        color?: string;
        data?: T;
        end?: Date;
        id: string;
        start: Date;
        title: string;
    }

    Type Parameters

    • T = unknown

      Optional payload type for application-specific data attached to the event.

    Index

    Properties

    allDay? color? data? end? id start title

    Properties

    allDay?: boolean

    Whether the event spans the entire day. When true, the time portion of start / end is ignored in display logic.

    color?: string

    CSS colour string for the event swatch (hex, rgb, hsl, named). Falls back to the first palette colour when omitted.

    data?: T

    Optional arbitrary payload the consumer can attach.

    end?: Date

    End date-time of the event. When omitted, the event is treated as a single-day / point-in-time occurrence whose end equals its start.

    id: string

    Unique identifier for this event.

    start: Date

    Start date-time of the event.

    title: string

    Display title shown on the calendar.

    Settings

    Member Visibility

    On This Page

    Properties