Class FormComponent<P, C, S, SS>`Abstract`

See

https://github.com/idea2app/MobX-React-helper?tab=readme-ov-file#abstract-form-component

Type Parameters

P extends FormComponentProps<any> = FormComponentProps
C = unknown
S = {}
SS = any

Hierarchy (View Summary)

ObservedComponent<P, C, S, SS>
- FormComponent

Index

Constructors

Properties

Accessors

innerValue observedContext observedProps observedState value

Methods

componentDidMount componentDidUpdate componentWillUnmount emitValue reset

Constructors

constructor

new FormComponent<
    P extends FormComponentProps<any> = FormComponentProps<string>,
    C = unknown,
    S = {},
    SS = any,
>(
    props: P,
): FormComponent<P, C, S, SS>
Type Parameters
- P extends FormComponentProps<any> = FormComponentProps<string>
- C = unknown
- S = {}
- SS = any
Parameters
- props: P
Returns FormComponent<P, C, S, SS>
Inherited from ObservedComponent.constructor
- Defined in node_modules/.pnpm/@types+react@19.2.18/node_modules/@types/react/index.d.ts:958
new FormComponent<
    P extends FormComponentProps<any> = FormComponentProps<string>,
    C = unknown,
    S = {},
    SS = any,
>(
    props: P,
    context: any,
): FormComponent<P, C, S, SS>
Type Parameters
- P extends FormComponentProps<any> = FormComponentProps<string>
- C = unknown
- S = {}
- SS = any
Parameters
- props: P
- context: any
  value of the parent Context specified in contextType.
Returns FormComponent<P, C, S, SS>
Inherited from ObservedComponent.constructor
- Defined in node_modules/.pnpm/@types+react@19.2.18/node_modules/@types/react/index.d.ts:966

Properties

ref

ref: RefObject<HTMLFieldElement> = ...

Accessors

innerValue

innerValue: P["defaultValue"]

observedContext

observedContext: C

observedProps

observedProps: Readonly<P>

observedState

observedState: Readonly<S>

value

get value(): P["value"]
Returns P["value"]
- Defined in src/FormComponent.ts:35

Methods

componentDidMount

componentDidMount(): void
Called immediately after a component is mounted. Setting state here will trigger re-rendering.

Returns void
Overrides ObservedComponent.componentDidMount
- Defined in src/FormComponent.ts:53

componentDidUpdate

componentDidUpdate(
    prevProps: Readonly<Props>,
    prevState: Readonly<State>,
    snapshot?: SS,
): 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<Props>
- prevState: Readonly<State>
- Optionalsnapshot: SS
Returns void
Inherited from ObservedComponent.componentDidUpdate
- Defined in src/MobX-modern.ts:93

componentWillUnmount

componentWillUnmount(): 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
Overrides ObservedComponent.componentWillUnmount
- Defined in src/FormComponent.ts:65

emitValue

emitValue(value: P["value"]): any
Parameters
- value: P["value"]
Returns any
- Defined in src/FormComponent.ts:47

reset

reset(): P["defaultValue"]
Returns P["defaultValue"]
- Defined in src/FormComponent.ts:51