A date time input is an input field that lets you set and edit the date and time in a chosen input element using customizable display and input formats.

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<IIgrDateTimeInputProps> & 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 blur(): ((s, e) => void)
  • Returns ((s, e) => void)

  • set blur(ev): void
  • Parameters

    Returns void

  • get disabled(): boolean
  • The disabled state of the component

    Returns boolean

  • set disabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get displayFormat(): string
  • Format to display the value in when not editing. Defaults to the input format if not set.

    Returns string

  • set displayFormat(v): void
  • Parameters

    • v: string

    Returns void

  • get focus(): ((s, e) => void)
  • Returns ((s, e) => void)

  • set focus(ev): void
  • Parameters

    Returns void

  • get inputFormat(): string
  • Returns string

  • set inputFormat(v): void
  • Parameters

    • v: string

    Returns void

  • get invalid(): boolean
  • Control the validity of the control.

    Returns boolean

  • set invalid(v): void
  • Parameters

    • v: boolean

    Returns void

  • get label(): string
  • The label for the control.

    Returns string

  • set label(v): void
  • Parameters

    • v: string

    Returns void

  • get locale(): string
  • The locale settings used to display the value.

    Returns string

  • set locale(v): void
  • Parameters

    • v: string

    Returns void

  • get max(): Date
  • The maximum value required for the input to remain valid.

    Returns Date

  • set max(v): void
  • Parameters

    • v: Date

    Returns void

  • get maxValue(): Date
  • The maximum value required for the input to remain valid.

    Deprecated

    Use the max property instead.

    Returns Date

  • set maxValue(v): void
  • Parameters

    • v: Date

    Returns void

  • get min(): Date
  • The minimum value required for the input to remain valid.

    Returns Date

  • set min(v): void
  • Parameters

    • v: Date

    Returns void

  • get minValue(): Date
  • The minimum value required for the input to remain valid.

    Deprecated

    Use the min property instead.

    Returns Date

  • set minValue(v): void
  • Parameters

    • v: Date

    Returns void

  • get name(): string
  • The name attribute of the control.

    Returns string

  • set name(v): void
  • Parameters

    • v: string

    Returns void

  • get outlined(): boolean
  • Whether the control will have outlined appearance.

    Returns boolean

  • set outlined(v): void
  • Parameters

    • v: boolean

    Returns void

  • get placeholder(): string
  • The placeholder attribute of the control.

    Returns string

  • set placeholder(v): void
  • Parameters

    • v: string

    Returns void

  • get prompt(): string
  • The prompt symbol to use for unfilled parts of the mask.

    Returns string

  • set prompt(v): void
  • Parameters

    • v: string

    Returns void

  • get readOnly(): boolean
  • Makes the control a readonly field.

    Returns boolean

  • set readOnly(v): void
  • Parameters

    • v: boolean

    Returns void

  • get readonly(): boolean
  • Makes the control a readonly field.

    Deprecated

    Use the readOnly property instead.

    Returns boolean

  • set readonly(v): void
  • Parameters

    • v: boolean

    Returns void

  • get required(): boolean
  • Makes the control a required field in a form context.

    Returns boolean

  • set required(v): void
  • Parameters

    • v: boolean

    Returns void

  • get size(): SizableComponentSize
  • Deprecated

    Use the --ig-size CSS custom property instead.

    Returns SizableComponentSize

  • set size(v): void
  • Parameters

    Returns void

  • get spinDelta(): IgrDatePartDeltas
  • Delta values used to increment or decrement each date part on step actions. All values default to 1.

    Returns IgrDatePartDeltas

  • set spinDelta(v): void
  • Parameters

    Returns void

  • get spinLoop(): boolean
  • Sets whether to loop over the currently spun segment.

    Returns boolean

  • set spinLoop(v): void
  • Parameters

    • v: boolean

    Returns void

  • get value(): Date
  • Returns Date

  • set value(v): void
  • Parameters

    • v: Date

    Returns void

Methods

  • Removes focus from the control.

    Returns void

  • Checks for validity of the control and emits the invalid event if it invalid.

    Returns void

  • Clears the input element of user input.

    Returns void

  • 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<any, Element>

  • Checks for validity of the control and shows the browser message if it invalid.

    Returns void

  • Selects all text within the input.

    Returns void

  • Sets a custom validation message for the control. As long as message is not empty, the control is considered invalid.

    Parameters

    • message: string

    Returns void

  • Parameters

    • element: any

    Returns void

  • Parameters

    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

  • Parameters

    • datePart: DatePart
    • Optional delta: number

    Returns void

  • Parameters

    • datePart: DatePart
    • Optional delta: number

    Returns void