Represents a calendar that lets users to select a date value in a variety of different ways. when calendar orientation is vertical.

Hierarchy

Hierarchy

Constructors

Properties

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
props: Readonly<IIgrCalendarProps> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: Readonly<{}>
contextType?: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
static contextType = Ctx
context!: React.ContextType<typeof Ctx>
render () {
return <>My context's value: {this.context}</>;
}
}

Accessors

  • get activeDate(): Date
  • Sets the date which is shown in view and is highlighted. By default it is the current date.

    Returns Date

  • set activeDate(v): void
  • Parameters

    • v: Date

    Returns void

  • get disabledDates(): IDateRangeDescriptor[]
  • Gets/sets disabled dates.

    Returns IDateRangeDescriptor[]

  • set disabledDates(v): void
  • Parameters

    • v: IDateRangeDescriptor[]

    Returns void

  • get hideHeader(): boolean
  • Determines whether the calendar hides its header. Even if set to false, the header is not displayed for multiple selection.

    Returns boolean

  • set hideHeader(v): void
  • Parameters

    • v: boolean

    Returns void

  • get hideOutsideDays(): boolean
  • Controls the visibility of the dates that do not belong to the current month.

    Returns boolean

  • set hideOutsideDays(v): void
  • Parameters

    • v: boolean

    Returns void

  • get locale(): string
  • Sets the locale used for formatting and displaying the dates in the calendar.

    Returns string

  • set locale(v): void
  • Parameters

    • v: string

    Returns void

  • get orientation(): CalendarOrientation
  • The orientation of the multiple months displayed in days view.

    Returns CalendarOrientation

  • set orientation(v): void
  • Parameters

    Returns void

  • get selection(): CalendarBaseSelection
  • Sets the type of date selection.

    Returns CalendarBaseSelection

  • set selection(v): void
  • Parameters

    Returns void

  • get showWeekNumbers(): boolean
  • Show/hide the week numbers.

    Returns boolean

  • set showWeekNumbers(v): void
  • Parameters

    • v: boolean

    Returns void

  • get specialDates(): IDateRangeDescriptor[]
  • Gets/sets special dates.

    Returns IDateRangeDescriptor[]

  • set specialDates(v): void
  • Parameters

    • v: IDateRangeDescriptor[]

    Returns void

  • get value(): Date
  • Returns Date

  • set value(v): void
  • Parameters

    • v: Date

    Returns void

  • get values(): Date[]
  • Returns Date[]

  • set values(v): void
  • Parameters

    • v: Date[]

    Returns void

  • get visibleMonths(): number
  • The number of months displayed in days view.

    Returns number

  • set visibleMonths(v): void
  • Parameters

    • v: number

    Returns void

  • get weekStart(): CalendarBaseWeekStart
  • Sets the start day of the week.

    Returns CalendarBaseWeekStart

  • set weekStart(v): void
  • Parameters

    Returns void

Methods

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    Returns void

  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

  • Parameters

    • name: string

    Returns any

  • Parameters

    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns any

  • Returns DOMElement<{
        children: any[];
        className: string;
        ref: ((ref) => void);
        style: {};
    }, any>

  • Parameters

    • element: any

    Returns void

  • Type parameters

    Type Parameters

    • K extends never

    Parameters

    • state: {} | ((prevState, props) => {} | Pick<{}, K>) | Pick<{}, K>
    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean