File

src/lib/dl-date-time-picker/dl-date-time-picker-model.ts

Description

Interface that represents the model for every view in a date/time picker.

Index

Properties

Properties

activeDate
activeDate: number
Type : number

The date value of the currently active cell in the model.

leftButton
leftButton: literal type
Type : literal type

Represent the configuration for the left button.

rightButton
rightButton: literal type
Type : literal type

Represents the configuration for the right button.

rowLabels
rowLabels: string[]
Type : string[]
Optional

Optional row labels. Used to include the weekday labels in the day view

rows
rows: Array<literal type>
Type : Array<literal type>

The rows in the current view.

upButton
upButton: literal type
Type : literal type
Optional

Represent the configuration for the up button.

viewLabel
viewLabel: string
Type : string

The label displayed in the top-center of the date/time picker

viewName
viewName: string
Type : string

The name of the view represented by this model.

import {DateButton} from './dl-date-time-picker-date-button';

/**
 * Interface that represents the model for every view in a date/time picker.
 */
export interface DlDateTimePickerModel {
  /**
   * The date value of the currently active cell in the model.
   */
  activeDate: number;
  /**
   * Represent the configuration for the left button.
   */
  leftButton: {
    /**
     * The value for the model to the left of this model.
     */
    value: number;

    /**
     * The accessible label for the left button.
     * Used by screen readers.
     */
    ariaLabel: string;

    /**
     * The classes to add to the left button
     */
    classes: {};
  };
  /**
   * Represents the configuration for the right button.
   */
  rightButton: {

    /**
     * The value for the model to the right this model.
     */
    value: number;

    /**
     * The accessible label for the right button.
     * Used by screen readers.
     */
    ariaLabel: string;

    /**
     * The classes to add to the up button
     */
    classes: {};
  };
  /**
   * Optional row labels.
   * Used to include the weekday labels in the `day` view
   */
  rowLabels?: string[];
  /**
   * The rows in the current view.
   */
  rows: Array<{
    /**
     * The cells in the current row.
     */
    cells: Array<DateButton>
  }>;
  /**
   * Represent the configuration for the up button.
   */
  upButton?: {

    /**
     * The value for the model above this model.
     */
    value: number;

    /**
     * The accessible label for the up button.
     * Used by screen readers.
     */
    ariaLabel: string;

    /**
     * The classes to add to the up button
     */
    classes: {};
  };
  /**
   * The label displayed in the top-center of the date/time picker
   */
  viewLabel: string;
  /**
   * The name of the view represented by this model.
   */
  viewName: string;
}

results matching ""

    No results matching ""