TimelineKit API
    Preparing search index...

    Interface TimelineKitLocale

    Localization strings for all TimelineKit components.

    interface TimelineKitLocale {
        calendar: {
            addCalendar: string;
            agenda: string;
            allDay: string;
            ariaAgendaList?: string;
            ariaAllDayEvents?: string;
            ariaCalendar?: string;
            ariaCalendarGrid?: string;
            ariaGoToToday?: string;
            ariaMoreEvents?: (count: number) => string;
            ariaNavigation?: string;
            ariaNext?: string;
            ariaPrevious?: string;
            ariaRemoveCalendar?: (name: string) => string;
            ariaSelectMonthYear?: string;
            ariaSidebar?: string;
            ariaToggleCalendar?: (name: string) => string;
            ariaViewMode?: string;
            day: string;
            month: string;
            more: (count: number) => string;
            myCalendars: string;
            noEvents: string;
            today: string;
            week: string;
            weekNumber?: string;
            weekNumberShort?: string;
        };
        columns: {
            cost: string;
            end: string;
            length: string;
            name: string;
            progress: string;
            resources: string;
            start: string;
            work: string;
        };
        columnTooltips: { cost: string; work: string };
        constraints: Record<ConstraintType, string>;
        dateParser?: (value: string) => Date | null;
        export: {
            calendarsSheetName: string;
            eventsSheetName: string;
            linksSheetName: string;
            resourcesSheetName: string;
            tasksSheetName: string;
        };
        labels: {
            end: string;
            from: string;
            lag: string;
            length: string;
            progress: string;
            start: string;
            to: string;
            type: string;
        };
        language: string;
        linkTypes: Record<TaskLinkType, string>;
        scheduler: {
            addEvent: string;
            moveEvent: string;
            name: string;
            resizeEvent: string;
            resource: string;
            type: string;
        };
        tooltips: {
            addLink: string;
            addTask: string;
            addTaskPart: string;
            moveMilestone: string;
            moveTask: string;
            moveTaskPart: string;
            resizeTask: string;
            resizeTaskPart: string;
            setProgress: string;
        };
        warnings: {
            behindSchedule: string;
            behindScheduleByDays: (days: number) => string;
            behindScheduleByOneDay: string;
            constraintViolation: (constraintLabel: string, date: string) => string;
        };
    }
    Index

    Properties

    calendar columns columnTooltips constraints dateParser? export labels language linkTypes scheduler tooltips warnings

    Properties

    calendar: {
        addCalendar: string;
        agenda: string;
        allDay: string;
        ariaAgendaList?: string;
        ariaAllDayEvents?: string;
        ariaCalendar?: string;
        ariaCalendarGrid?: string;
        ariaGoToToday?: string;
        ariaMoreEvents?: (count: number) => string;
        ariaNavigation?: string;
        ariaNext?: string;
        ariaPrevious?: string;
        ariaRemoveCalendar?: (name: string) => string;
        ariaSelectMonthYear?: string;
        ariaSidebar?: string;
        ariaToggleCalendar?: (name: string) => string;
        ariaViewMode?: string;
        day: string;
        month: string;
        more: (count: number) => string;
        myCalendars: string;
        noEvents: string;
        today: string;
        week: string;
        weekNumber?: string;
        weekNumberShort?: string;
    }

    Type Declaration

    • addCalendar: string
    • agenda: string
    • allDay: string
    • OptionalariaAgendaList?: string
    • OptionalariaAllDayEvents?: string
    • OptionalariaCalendar?: string
    • OptionalariaCalendarGrid?: string
    • OptionalariaGoToToday?: string
    • OptionalariaMoreEvents?: (count: number) => string
    • OptionalariaNavigation?: string
    • OptionalariaNext?: string
    • OptionalariaPrevious?: string
    • OptionalariaRemoveCalendar?: (name: string) => string
    • OptionalariaSelectMonthYear?: string
    • OptionalariaSidebar?: string
    • OptionalariaToggleCalendar?: (name: string) => string
    • OptionalariaViewMode?: string
    • day: string
    • month: string
    • more: (count: number) => string
    • myCalendars: string
    • noEvents: string
    • today: string
    • week: string
    • OptionalweekNumber?: string

      Full label for week number (default: 'Week'). Used for aria-label.

    • OptionalweekNumberShort?: string

      Short label for week numbers (default: 'Wk'). Shown in headers when showWeekNumbers is enabled.

    columns: {
        cost: string;
        end: string;
        length: string;
        name: string;
        progress: string;
        resources: string;
        start: string;
        work: string;
    }
    columnTooltips: { cost: string; work: string }
    constraints: Record<ConstraintType, string>
    dateParser?: (value: string) => Date | null

    Optional custom date parser. Receives raw user input, returns Date or null.

    export: {
        calendarsSheetName: string;
        eventsSheetName: string;
        linksSheetName: string;
        resourcesSheetName: string;
        tasksSheetName: string;
    }
    labels: {
        end: string;
        from: string;
        lag: string;
        length: string;
        progress: string;
        start: string;
        to: string;
        type: string;
    }
    language: string

    BCP 47 language tag for Intl formatting (dates, numbers), e.g. 'en-US', 'cs-CZ', 'de-DE'

    linkTypes: Record<TaskLinkType, string>
    scheduler: {
        addEvent: string;
        moveEvent: string;
        name: string;
        resizeEvent: string;
        resource: string;
        type: string;
    }
    tooltips: {
        addLink: string;
        addTask: string;
        addTaskPart: string;
        moveMilestone: string;
        moveTask: string;
        moveTaskPart: string;
        resizeTask: string;
        resizeTaskPart: string;
        setProgress: string;
    }
    warnings: {
        behindSchedule: string;
        behindScheduleByDays: (days: number) => string;
        behindScheduleByOneDay: string;
        constraintViolation: (constraintLabel: string, date: string) => string;
    }

    Settings

    Member Visibility

    On This Page

    Properties