Class: Input ‹SS›#

Type parameters#

▪ SS

Hierarchy#

Component‹InputProps, State›

↳ Input

Index#

Constructors#

constructor

Properties#

Accessors#

Methods#

Object literals#

state

Constructors#

constructor#

+ new Input(props: Readonly‹InputProps› | InputProps): Input

Inherited from PageLayout.constructor

Defined in node_modules/@types/react/index.d.ts:473

Parameters:

Name	Type
`props`	Readonly‹InputProps› \| InputProps

Returns: Input

+ new Input(props: InputProps, context: any): Input

Inherited from PageLayout.constructor

Defined in node_modules/@types/react/index.d.ts:475

deprecated

see https://reactjs.org/docs/legacy-context.html

Parameters:

Name	Type
`props`	InputProps
`context`	any

Returns: Input

Properties#

context#

• context: any

Inherited from PageLayout.context

Defined in node_modules/@types/react/index.d.ts:473

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>

see https://reactjs.org/docs/context.html

input#

• input: InputElement

Defined in src/renderer/components/input/input.tsx:58

props#

• props: Readonly‹InputProps› & Readonly‹object›

Inherited from PageLayout.props

Defined in node_modules/@types/react/index.d.ts:498

refs#

• refs: object

Inherited from PageLayout.refs

Defined in node_modules/@types/react/index.d.ts:504

deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Type declaration:#

[ key: string]: ReactInstance

validators#

• validators: InputValidator[] = []

Defined in src/renderer/components/input/input.tsx:59

`Static` `Optional` contextType#

▪ contextType? : Context‹any›

Inherited from PageLayout.contextType

Defined in node_modules/@types/react/index.d.ts:455

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}</>;
  }
}

see https://reactjs.org/docs/context.html#classcontexttype

`Static` defaultProps#

▪ defaultProps: object = defaultProps as object

Defined in src/renderer/components/input/input.tsx:56

Accessors#

isUncontrolled#

• get isUncontrolled(): boolean

Defined in src/renderer/components/input/input.tsx:258

Returns: boolean

showMaxLenIndicator#

• get showMaxLenIndicator(): boolean

Defined in src/renderer/components/input/input.tsx:252

Returns: boolean

Methods#

`Optional` UNSAFE_componentWillMount#

▸ UNSAFE_componentWillMount(): void

Inherited from PageLayout.UNSAFE_componentWillMount

Defined in node_modules/@types/react/index.d.ts:711

Called immediately before mounting occurs, and before Component#render. Avoid introducing any side-effects or subscriptions in this method.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use componentDidMount or the constructor instead

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns: void

`Optional` UNSAFE_componentWillReceiveProps#

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹InputProps›, nextContext: any): void

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

Defined in node_modules/@types/react/index.d.ts:743

Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

Calling Component#setState generally does not trigger this method.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use static getDerivedStateFromProps instead

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters:

Name	Type
`nextProps`	Readonly‹InputProps›
`nextContext`	any

Returns: void

`Optional` UNSAFE_componentWillUpdate#

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹InputProps›, nextState: Readonly‹State›, nextContext: any): void

Inherited from PageLayout.UNSAFE_componentWillUpdate

Defined in node_modules/@types/react/index.d.ts:771

Called immediately before rendering when new props or state is received. Not called for the initial render.

Note: You cannot call Component#setState here.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use getSnapshotBeforeUpdate instead

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters:

Name	Type
`nextProps`	Readonly‹InputProps›
`nextState`	Readonly‹State›
`nextContext`	any

Returns: void

bindRef#

▸ bindRef(elem: InputElement): void

Defined in src/renderer/components/input/input.tsx:285

Parameters:

Name	Type
`elem`	InputElement

Returns: void

blur#

▸ blur(): void

Defined in src/renderer/components/input/input.tsx:95

Returns: void

`Optional` componentDidCatch#

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

Inherited from PageLayout.componentDidCatch

Defined in node_modules/@types/react/index.d.ts:640

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

Parameters:

Name	Type
`error`	Error
`errorInfo`	ErrorInfo

Returns: void

componentDidMount#

▸ componentDidMount(): void

Overrides WizardLayout.componentDidMount

Defined in src/renderer/components/input/input.tsx:262

Returns: void

componentDidUpdate#

▸ componentDidUpdate(prevProps: InputProps): void

Overrides PageLayout.componentDidUpdate

Defined in src/renderer/components/input/input.tsx:267

Parameters:

Name	Type
`prevProps`	InputProps

Returns: void

`Optional` componentWillMount#

▸ componentWillMount(): void

Inherited from PageLayout.componentWillMount

Defined in node_modules/@types/react/index.d.ts:697

Called immediately before mounting occurs, and before Component#render. Avoid introducing any side-effects or subscriptions in this method.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns: void

`Optional` componentWillReceiveProps#

▸ componentWillReceiveProps(nextProps: Readonly‹InputProps›, nextContext: any): void

Inherited from PageLayout.componentWillReceiveProps

Defined in node_modules/@types/react/index.d.ts:726

Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

Calling Component#setState generally does not trigger this method.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters:

Name	Type
`nextProps`	Readonly‹InputProps›
`nextContext`	any

Returns: void

`Optional` componentWillUnmount#

▸ componentWillUnmount(): void

Inherited from WizardLayout.componentWillUnmount

Defined in node_modules/@types/react/index.d.ts:635

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

`Optional` componentWillUpdate#

▸ componentWillUpdate(nextProps: Readonly‹InputProps›, nextState: Readonly‹State›, nextContext: any): void

Inherited from PageLayout.componentWillUpdate

Defined in node_modules/@types/react/index.d.ts:756

Called immediately before rendering when new props or state is received. Not called for the initial render.

Note: You cannot call Component#setState here.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters:

Name	Type
`nextProps`	Readonly‹InputProps›
`nextState`	Readonly‹State›
`nextContext`	any

Returns: void

focus#

▸ focus(): void

Defined in src/renderer/components/input/input.tsx:91

Returns: void

forceUpdate#

▸ forceUpdate(callback?: function): void

Inherited from PageLayout.forceUpdate

Defined in node_modules/@types/react/index.d.ts:490

Parameters:

▪Optional callback: function

▸ (): void

Returns: void

`Optional` getSnapshotBeforeUpdate#

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹InputProps›, prevState: Readonly‹State›): SS | null

Inherited from PageLayout.getSnapshotBeforeUpdate

Defined in node_modules/@types/react/index.d.ts:676

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:

Name	Type
`prevProps`	Readonly‹InputProps›
`prevState`	Readonly‹State›

Returns: SS | null

getValue#

▸ getValue(): string

Defined in src/renderer/components/input/input.tsx:82

Returns: string

isValid#

▸ isValid(): boolean

Defined in src/renderer/components/input/input.tsx:67

Returns: boolean

onBlur#

▸ onBlur(evt: FocusEvent‹InputElement›): void

Defined in src/renderer/components/input/input.tsx:208

Parameters:

Name	Type
`evt`	FocusEvent‹InputElement›

Returns: void

onChange#

▸ onChange(evt: ChangeEvent‹any›): void

Defined in src/renderer/components/input/input.tsx:217

Parameters:

Name	Type
`evt`	ChangeEvent‹any›

Returns: void

onFocus#

▸ onFocus(evt: FocusEvent‹InputElement›): void

Defined in src/renderer/components/input/input.tsx:199

Parameters:

Name	Type
`evt`	FocusEvent‹InputElement›

Returns: void

onKeyDown#

▸ onKeyDown(evt: KeyboardEvent‹any›): void

Defined in src/renderer/components/input/input.tsx:236

Parameters:

Name	Type
`evt`	KeyboardEvent‹any›

Returns: void

render#

▸ render(): Element‹›

Overrides void

Defined in src/renderer/components/input/input.tsx:289

Returns: Element‹›

select#

▸ select(): void

Defined in src/renderer/components/input/input.tsx:99

Returns: void

setDirty#

▸ setDirty(dirty: boolean): void

Defined in src/renderer/components/input/input.tsx:193

Parameters:

Name	Type	Default
`dirty`	boolean	true

Returns: void

setState#

▸ setState‹K›(state: function | S | object, callback?: function): void

Inherited from PageLayout.setState

Defined in node_modules/@types/react/index.d.ts:485

Type parameters:

▪ K: keyof State

Parameters:

▪ state: function | S | object

▪Optional callback: function

▸ (): void

Returns: void

setValidation#

▸ setValidation(errors: React.ReactNode[]): void

Defined in src/renderer/components/input/input.tsx:163

Parameters:

Name	Type
`errors`	React.ReactNode[]

Returns: void

setValue#

▸ setValue(value: string): void

Defined in src/renderer/components/input/input.tsx:71

Parameters:

Name	Type
`value`	string

Returns: void

`Optional` shouldComponentUpdate#

▸ shouldComponentUpdate(nextProps: Readonly‹InputProps›, nextState: Readonly‹State›, nextContext: any): boolean

Inherited from PageLayout.shouldComponentUpdate

Defined in node_modules/@types/react/index.d.ts:630

Called to determine whether the change in props and state should trigger a re-render.

Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

Parameters:

Name	Type
`nextProps`	Readonly‹InputProps›
`nextState`	Readonly‹State›
`nextContext`	any

Returns: boolean

validate#

▸ validate(value: string): Promise‹void›

Defined in src/renderer/components/input/input.tsx:119

Parameters:

Name	Type	Default
`value`	string	this.getValue()

Returns: Promise‹void›

Object literals#

state#

▪ state: object#

Overrides PageLayout.state

Defined in src/renderer/components/input/input.tsx:61

dirty#

• dirty: boolean = !!this.props.dirty

Defined in src/renderer/components/input/input.tsx:62

errors#

• errors: undefined[] = []

Defined in src/renderer/components/input/input.tsx:64

valid#

• valid: true = true

Defined in src/renderer/components/input/input.tsx:63

Class: Input ‹SS›#

Type parameters#

Hierarchy#

Index#

Constructors#

Properties#

Accessors#

Methods#

Object literals#

Constructors#

constructor#

Properties#

context#

input#

props#

refs#

Type declaration:#

validators#

Static Optional contextType#

Static defaultProps#

Accessors#

isUncontrolled#

showMaxLenIndicator#

Methods#

Optional UNSAFE_componentWillMount#

Optional UNSAFE_componentWillReceiveProps#

Optional UNSAFE_componentWillUpdate#

bindRef#

blur#

Optional componentDidCatch#

componentDidMount#

componentDidUpdate#

Optional componentWillMount#

Optional componentWillReceiveProps#

Optional componentWillUnmount#

Optional componentWillUpdate#

focus#

forceUpdate#

Optional getSnapshotBeforeUpdate#

getValue#

isValid#

onBlur#

onChange#

onFocus#

onKeyDown#

render#

select#

setDirty#

setState#

setValidation#

setValue#

Optional shouldComponentUpdate#

validate#

Object literals#

state#

▪ state: object#

dirty#

errors#

valid#

`Static` `Optional` contextType#

`Static` defaultProps#

`Optional` UNSAFE_componentWillMount#

`Optional` UNSAFE_componentWillReceiveProps#

`Optional` UNSAFE_componentWillUpdate#

`Optional` componentDidCatch#

`Optional` componentWillMount#

`Optional` componentWillReceiveProps#

`Optional` componentWillUnmount#

`Optional` componentWillUpdate#

`Optional` getSnapshotBeforeUpdate#

`Optional` shouldComponentUpdate#