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<IIgrInputProps> & 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 autocomplete(): string
  • The autocomplete attribute of the control.

    Returns string

  • set autocomplete(v): void
  • Parameters

    • v: string

    Returns void

  • get autofocus(): boolean
  • The autofocus attribute of the control.

    Returns boolean

  • set autofocus(v): void
  • Parameters

    • v: boolean

    Returns void

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

  • set blur(ev): void
  • Parameters

    Returns void

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

    Returns boolean

  • set disabled(v): void
  • Parameters

    • v: boolean

    Returns void

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

  • set focus(ev): void
  • Parameters

    Returns void

  • get inputmode(): InputInputmode
  • The input mode attribute of the control.

    Returns InputInputmode

  • set inputmode(v): void
  • Parameters

    Returns void

  • get invalid(): boolean
  • Controls 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 max(): string
  • The max attribute of the control.

    Returns string

  • set max(v): void
  • Parameters

    • v: string

    Returns void

  • get maxlength(): number
  • The maxlength attribute of the control.

    Returns number

  • set maxlength(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns string

  • set min(v): void
  • Parameters

    • v: string

    Returns void

  • get minlength(): number
  • The minlength attribute of the control.

    Returns number

  • set minlength(v): void
  • Parameters

    • v: number

    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 pattern(): string
  • The pattern attribute of the control.

    Returns string

  • set pattern(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns string

  • set placeholder(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 required(): boolean
  • Makes the control a required field.

    Returns boolean

  • set required(v): void
  • Parameters

    • v: boolean

    Returns void

  • get size(): SizableComponentSize
  • Returns SizableComponentSize

  • set size(v): void
  • Parameters

    Returns void

  • get step(): number
  • The step attribute of the control.

    Returns number

  • set step(v): void
  • Parameters

    • v: number

    Returns void

  • get tabIndex(): number
  • Returns number

  • set tabIndex(v): void
  • Parameters

    • v: number

    Returns void

  • get type(): InputType
  • The type attribute of the control.

    Returns InputType

  • set type(v): void
  • Parameters

    Returns void

  • get value(): string
  • The value of the control.

    Returns string

  • set value(v): void
  • Parameters

    • v: string

    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

  • 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

    • prevProps: Readonly<IIgrInputProps>
    • prevState: Readonly<{}>
    • Optional snapshot: any

    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>

  • Checks for validity of the control and shows the browser message if it's 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

  • Decrements the numeric value of the input by one or more steps.

    Parameters

    • n: number

    Returns void

  • Increments the numeric value of the input by one or more steps.

    Parameters

    • n: number

    Returns void