export interface DateFormatterParams {
  /**
   * The date to format.
   */
  date: Date;

  /**
   * The users preferred locale.
   */
  locale?: string;

  /**
   * The start day number of the week
   */
  weekStartsOn?: number;

  /**
   * An array of day indexes (0 = sunday, 1 = monday etc) that will be hidden on the view
   */
  excludeDays?: number[];

  /**
   * The number of days in a week. Can be used to create a shorter or longer week view.
   * The first day of the week will always be the `viewDate`
   */
  daysInWeek?: number;
}

/**
 * If using a completely custom date formatter then it should implement this interface.
 */
export interface CalendarDateFormatterInterface {
  /**
   * The month view header week day labels
   */
  monthViewColumnHeader(params: DateFormatterParams): string;

  /**
   * The month view cell day number
   */
  monthViewDayNumber(params: DateFormatterParams): string;

  /**
   * The month view title
   */
  monthViewTitle(params: DateFormatterParams): string;

  /**
   * The week view header week day labels
   */
  weekViewColumnHeader(params: DateFormatterParams): string;

  /**
   * The week view sub header day and month labels
   */
  weekViewColumnSubHeader(params: DateFormatterParams): string;

  /**
   * The week view title
   */
  weekViewTitle(params: DateFormatterParams): string;

  /**
   * The time formatting down the left hand side of the day view
   */
  weekViewHour(params: DateFormatterParams): string;

  /**
   * The time formatting down the left hand side of the day view
   */
  dayViewHour(params: DateFormatterParams): string;

  /**
   * The day view title
   */
  dayViewTitle(params: DateFormatterParams): string;
}