Class Formeum<Values, ExtraContext>

Generate a typed formeum object context, hooks and components

Type Parameters

Values extends BaseValues
ExtraContext extends Record<string, unknown> = Record<never, never>

Hierarchy

Formeum

Constructors

constructor

new Formeum<Values, ExtraContext>(extraContextDefault: ExtraContext): Formeum<Values, ExtraContext>
Type Parameters
- Values extends BaseValues
- ExtraContext extends Record<string, unknown> = Record<never, never>
Parameters
- extraContextDefault: ExtraContext
Returns Formeum<Values, ExtraContext>
- Defined in src/lib/Formeum.ts:38

Properties

`Private` `Readonly` #cache

#cache: Partial<Record<keyof Formeum<Values, Record<never, never>>, any>> = {}

`Private` `Readonly` #extraContextDefault

#extraContextDefault: ExtraContext

Accessors

ContextMain

get ContextMain(): FastContext<ContextMainInterface<Values, ExtraContext>>
Returns FastContext<ContextMainInterface<Values, ExtraContext>>
- Defined in src/lib/Formeum.ts:49

FormCallbacks

get FormCallbacks(): ((props: FormCallbacksProps<Values, ExtraContext>) => ReactElement<any, string | JSXElementConstructor<any>>)
Returns ((props: FormCallbacksProps<Values, ExtraContext>) => ReactElement<any, string | JSXElementConstructor<any>>)
- - (props: FormCallbacksProps<Values, ExtraContext>): ReactElement<any, string | JSXElementConstructor<any>>
  - Get all form handler functions.
    
    Returns
    Parameters
    - props: FormCallbacksProps<Values, ExtraContext>
    Returns ReactElement<any, string | JSXElementConstructor<any>>
- Defined in src/lib/Formeum.ts:195

FormHTMLCheckbox

get FormHTMLCheckbox(): (<Name>(props: FormHTMLCheckboxProps<Values, Name>) => ReactElement<any, string | JSXElementConstructor<any>>)
Returns (<Name>(props: FormHTMLCheckboxProps<Values, Name>) => ReactElement<any, string | JSXElementConstructor<any>>)
- - <Name>(props: FormHTMLCheckboxProps<Values, Name>): ReactElement<any, string | JSXElementConstructor<any>>
  - Get the props for a HTML checkbox.
    
    Returns
    Type Parameters
    - Name extends string
    Parameters
    - props: FormHTMLCheckboxProps<Values, Name>
    Returns ReactElement<any, string | JSXElementConstructor<any>>
- Defined in src/lib/Formeum.ts:183

FormHTMLInput

get FormHTMLInput(): (<Name>(props: FormHTMLInputProps<Values, Name>) => ReactElement<any, string | JSXElementConstructor<any>>)
Returns (<Name>(props: FormHTMLInputProps<Values, Name>) => ReactElement<any, string | JSXElementConstructor<any>>)
- - <Name>(props: FormHTMLInputProps<Values, Name>): ReactElement<any, string | JSXElementConstructor<any>>
  - Get the props for a HTML input.
    
    Returns
    Type Parameters
    - Name extends string
    Parameters
    - props: FormHTMLInputProps<Values, Name>
    Returns ReactElement<any, string | JSXElementConstructor<any>>
- Defined in src/lib/Formeum.ts:177

FormHandler

get FormHandler(): ((props: FormHandlerProps<Values>) => ReactElement<any, string | JSXElementConstructor<any>>)
Returns ((props: FormHandlerProps<Values>) => ReactElement<any, string | JSXElementConstructor<any>>)
- - (props: FormHandlerProps<Values>): ReactElement<any, string | JSXElementConstructor<any>>
  - Get the form handler using the hook useFormHandler and render the context provider.
    
    Returns
    Parameters
    - props: FormHandlerProps<Values>
    Returns ReactElement<any, string | JSXElementConstructor<any>>
- Defined in src/lib/Formeum.ts:159

FormHandlerStateless

get FormHandlerStateless(): ((props: FormHandlerStatelessProps<Values>) => ReactElement<any, string | JSXElementConstructor<any>>)
Returns ((props: FormHandlerStatelessProps<Values>) => ReactElement<any, string | JSXElementConstructor<any>>)
- - (props: FormHandlerStatelessProps<Values>): ReactElement<any, string | JSXElementConstructor<any>>
  - Get the form handler using the hook useFormHandlerStateless and render the context provider.
    
    Returns
    Parameters
    - props: FormHandlerStatelessProps<Values>
    Returns ReactElement<any, string | JSXElementConstructor<any>>
- Defined in src/lib/Formeum.ts:165

FormReactInput

get FormReactInput(): (<Name>(props: FormReactInputProps<Values, Name>) => ReactElement<any, string | JSXElementConstructor<any>>)
Returns (<Name>(props: FormReactInputProps<Values, Name>) => ReactElement<any, string | JSXElementConstructor<any>>)
- - <Name>(props: FormReactInputProps<Values, Name>): ReactElement<any, string | JSXElementConstructor<any>>
  - Get the props for a React input.
    
    Returns
    Type Parameters
    - Name extends string
    Parameters
    - props: FormReactInputProps<Values, Name>
    Returns ReactElement<any, string | JSXElementConstructor<any>>
- Defined in src/lib/Formeum.ts:189

FormValues

get FormValues(): ((props: FormValuesProps<Values>) => ReactElement<any, string | JSXElementConstructor<any>>)
Returns ((props: FormValuesProps<Values>) => ReactElement<any, string | JSXElementConstructor<any>>)
- - (props: FormValuesProps<Values>): ReactElement<any, string | JSXElementConstructor<any>>
  - Get all the form values.
    
    Returns
    Parameters
    - props: FormValuesProps<Values>
    Returns ReactElement<any, string | JSXElementConstructor<any>>
- Defined in src/lib/Formeum.ts:171

useChangeHandler

get useChangeHandler(): (<Name>(arg: UseChangeHandlerArg<Name>) => UseChangeHandlerReturn<Values, Name>)
Returns (<Name>(arg: UseChangeHandlerArg<Name>) => UseChangeHandlerReturn<Values, Name>)
- - <Name>(arg: UseChangeHandlerArg<Name>): UseChangeHandlerReturn<Values, Name>
  - Get native change handlers for a field.
    
    Returns
    Type Parameters
    - Name extends string
    Parameters
    - arg: UseChangeHandlerArg<Name>
    Returns UseChangeHandlerReturn<Values, Name>
- Defined in src/lib/Formeum.ts:105

useCurrentContext

get useCurrentContext(): (() => Readonly<MutableRefObject<ContextMainInterface<Values, ExtraContext>>>)
Returns (() => Readonly<MutableRefObject<ContextMainInterface<Values, ExtraContext>>>)
- - (): Readonly<MutableRefObject<ContextMainInterface<Values, ExtraContext>>>
  - Use the context as a ref object, and never trigger a re-render.
    
    Returns
    
    Returns Readonly<MutableRefObject<ContextMainInterface<Values, ExtraContext>>>
- Defined in src/lib/Formeum.ts:61

useFieldBlur

get useFieldBlur(): (<Name>(arg: UseFieldTouchedArg<Name>) => UseFieldBlurReturn)
Returns (<Name>(arg: UseFieldTouchedArg<Name>) => UseFieldBlurReturn)
- - <Name>(arg: UseFieldTouchedArg<Name>): UseFieldBlurReturn
  - Handle the blur logic. Handles touch on blur and validate on blur.
    
    Returns
    Type Parameters
    - Name extends string
    Parameters
    - arg: UseFieldTouchedArg<Name>
    Returns UseFieldBlurReturn
- Defined in src/lib/Formeum.ts:111

useFieldChangeValue

get useFieldChangeValue(): (<Name>(arg: UseFieldChangeValueArg<Name>) => UseFieldChangeValueReturn<Values, Name>)
Returns (<Name>(arg: UseFieldChangeValueArg<Name>) => UseFieldChangeValueReturn<Values, Name>)
- - <Name>(arg: UseFieldChangeValueArg<Name>): UseFieldChangeValueReturn<Values, Name>
  - Logic around changing fields value.
    
    Returns
    Type Parameters
    - Name extends string
    Parameters
    - arg: UseFieldChangeValueArg<Name>
    Returns UseFieldChangeValueReturn<Values, Name>
- Defined in src/lib/Formeum.ts:87

useFieldDisabled

get useFieldDisabled(): (() => UseFieldDisabledReturn)
Returns (() => UseFieldDisabledReturn)
- - (): UseFieldDisabledReturn
  - Handle the disabled logic. Handles disabled while submitting.
    
    Returns
    
    Returns UseFieldDisabledReturn
- Defined in src/lib/Formeum.ts:117

useFieldError

get useFieldError(): (<Name>(arg: UseFieldErrorArg<Name>) => UseFieldErrorReturn)
Returns (<Name>(arg: UseFieldErrorArg<Name>) => UseFieldErrorReturn)
- - <Name>(arg: UseFieldErrorArg<Name>): UseFieldErrorReturn
  - Get or change the fields error.
    
    Returns
    Type Parameters
    - Name extends string
    Parameters
    - arg: UseFieldErrorArg<Name>
    Returns UseFieldErrorReturn
- Defined in src/lib/Formeum.ts:99

useFieldFocus

get useFieldFocus(): (<Name>(arg: UseFieldTouchedArg<Name>) => UseFieldFocusReturn)
Returns (<Name>(arg: UseFieldTouchedArg<Name>) => UseFieldFocusReturn)
- - <Name>(arg: UseFieldTouchedArg<Name>): UseFieldFocusReturn
  - Handle the focus logic. Handles touch on focus and validate on focus logic.
    
    Returns
    Type Parameters
    - Name extends string
    Parameters
    - arg: UseFieldTouchedArg<Name>
    Returns UseFieldFocusReturn
- Defined in src/lib/Formeum.ts:123

useFieldRef

get useFieldRef(): (<Name>(arg: UseFieldTouchedArg<Name>) => UseFieldRefReturn)
Returns (<Name>(arg: UseFieldTouchedArg<Name>) => UseFieldRefReturn)
- - <Name>(arg: UseFieldTouchedArg<Name>): UseFieldRefReturn
  - Handle field logic which requires the native element.
    
    Returns
    Type Parameters
    - Name extends string
    Parameters
    - arg: UseFieldTouchedArg<Name>
    Returns UseFieldRefReturn
- Defined in src/lib/Formeum.ts:129

useFieldTouched

get useFieldTouched(): (<Name>(arg: UseFieldTouchedArg<Name>) => UseFieldTouchedReturn)
Returns (<Name>(arg: UseFieldTouchedArg<Name>) => UseFieldTouchedReturn)
- - <Name>(arg: UseFieldTouchedArg<Name>): UseFieldTouchedReturn
  - Check and change if the field has been touched or not.
    
    Returns
    Type Parameters
    - Name extends string
    Parameters
    - arg: UseFieldTouchedArg<Name>
    Returns UseFieldTouchedReturn
- Defined in src/lib/Formeum.ts:81

useFieldValue

get useFieldValue(): (<Name>(arg: UseFieldValueArg<Name>) => UseFieldValueReturn<Values, Name>)
Returns (<Name>(arg: UseFieldValueArg<Name>) => UseFieldValueReturn<Values, Name>)
- - <Name>(arg: UseFieldValueArg<Name>): UseFieldValueReturn<Values, Name>
  - Logic around a fields value. Handles getting the field value out of the main context, the initial value, changing the value and if the value has changed.
    
    Returns
    Type Parameters
    - Name extends string
    Parameters
    - arg: UseFieldValueArg<Name>
    Returns UseFieldValueReturn<Values, Name>
- Defined in src/lib/Formeum.ts:93

useFormCallbacks

get useFormCallbacks(): (() => UseFormCallbacksReturn<Values, ExtraContext>)
Returns (() => UseFormCallbacksReturn<Values, ExtraContext>)
- - (): UseFormCallbacksReturn<Values, ExtraContext>
  - Get all functions from the form handler. Will never trigger a re-render.
    
    Returns
    
    Returns UseFormCallbacksReturn<Values, ExtraContext>
- Defined in src/lib/Formeum.ts:153

useFormHandler

get useFormHandler(): ((arg: UseFormHandlerArg<Values>) => UseFormHandlerReturn<Values, ExtraContext>)
Returns ((arg: UseFormHandlerArg<Values>) => UseFormHandlerReturn<Values, ExtraContext>)
- - (arg: UseFormHandlerArg<Values>): UseFormHandlerReturn<Values, ExtraContext>
  - The base form handler logic as an uncontrolled component, i.e. all state is handled.
    
    Returns
    Parameters
    - arg: UseFormHandlerArg<Values>
    Returns UseFormHandlerReturn<Values, ExtraContext>
- Defined in src/lib/Formeum.ts:75

useFormHandlerStateless

get useFormHandlerStateless(): ((arg: UseFormHandlerStatelessArg<Values>) => UseFormHandlerStatelessReturn<Values, ExtraContext>)
Returns ((arg: UseFormHandlerStatelessArg<Values>) => UseFormHandlerStatelessReturn<Values, ExtraContext>)
- - (arg: UseFormHandlerStatelessArg<Values>): UseFormHandlerStatelessReturn<Values, ExtraContext>
  - The base form handler logic as a controlled component, i.e. stateless.
    
    Returns
    Parameters
    - arg: UseFormHandlerStatelessArg<Values>
    Returns UseFormHandlerStatelessReturn<Values, ExtraContext>
- Defined in src/lib/Formeum.ts:67

useHTMLCheckbox

get useHTMLCheckbox(): (<Name>(arg: UseHTMLCheckboxArg<Values, Name>) => UseHTMLCheckboxReturn<Values, Name>)
Returns (<Name>(arg: UseHTMLCheckboxArg<Values, Name>) => UseHTMLCheckboxReturn<Values, Name>)
- - <Name>(arg: UseHTMLCheckboxArg<Values, Name>): UseHTMLCheckboxReturn<Values, Name>
  - Get the props to use for a native HTML checkbox input as a boolean value.
    
    Returns
    Type Parameters
    - Name extends string
    Parameters
    - arg: UseHTMLCheckboxArg<Values, Name>
    Returns UseHTMLCheckboxReturn<Values, Name>
- Defined in src/lib/Formeum.ts:141

useHTMLInput

get useHTMLInput(): (<Name>(__namedParameters: UseHTMLInputArg<Values, Name>) => UseHTMLInputReturn<Values, Name>)
Returns (<Name>(__namedParameters: UseHTMLInputArg<Values, Name>) => UseHTMLInputReturn<Values, Name>)
- - <Name>(__namedParameters: UseHTMLInputArg<Values, Name>): UseHTMLInputReturn<Values, Name>
  - Get the props to be used on a native HTML input, textarea or select element.
    
    Returns
    Type Parameters
    - Name extends string
    Parameters
    - __namedParameters: UseHTMLInputArg<Values, Name>
    Returns UseHTMLInputReturn<Values, Name>
- Defined in src/lib/Formeum.ts:135

useMainContext

get useMainContext(): ((arg: UseMainContextArg<Values, ExtraContext>) => UseMainContextReturn<Values, ExtraContext>)
Returns ((arg: UseMainContextArg<Values, ExtraContext>) => UseMainContextReturn<Values, ExtraContext>)
- - (arg: UseMainContextArg<Values, ExtraContext>): UseMainContextReturn<Values, ExtraContext>
  - Use the form context.
    
    Returns
    Parameters
    - arg: UseMainContextArg<Values, ExtraContext>
    Returns UseMainContextReturn<Values, ExtraContext>
- Defined in src/lib/Formeum.ts:55

useReactInput

get useReactInput(): (<Name>(__namedParameters: UseReactInputArg<Name>) => UseReactInputReturn<Values, Name>)
Returns (<Name>(__namedParameters: UseReactInputArg<Name>) => UseReactInputReturn<Values, Name>)
- - <Name>(__namedParameters: UseReactInputArg<Name>): UseReactInputReturn<Values, Name>
  - Get the props to be used on a React style input, i.e. the change event should contain just the field value in the first argument rather than a change event.
    
    Returns
    Type Parameters
    - Name extends string
    Parameters
    - __namedParameters: UseReactInputArg<Name>
    Returns UseReactInputReturn<Values, Name>
- Defined in src/lib/Formeum.ts:147

Methods

`Private` #getItemFromCache

#getItemFromCache<Key, T>(name: Key, backup: (() => T)): T
Type Parameters
- Key extends keyof Formeum<Values, Record<never, never>>
- T
Parameters
- name: Key
- backup: (() => T)
  - - (): T
    - Returns T
Returns T
- Defined in src/lib/Formeum.ts:42

Class Formeum<Values, ExtraContext>

Type Parameters

Values extends BaseValues

ExtraContext extends Record<string, unknown> = Record<never, never>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Values extends BaseValues

ExtraContext extends Record<string, unknown> = Record<never, never>

Parameters

extraContextDefault: ExtraContext

Returns Formeum<Values, ExtraContext>

Properties

Private Readonly #cache

Private Readonly #extraContextDefault

Accessors

ContextMain

Returns FastContext<ContextMainInterface<Values, ExtraContext>>

FormCallbacks

Returns ((props: FormCallbacksProps<Values, ExtraContext>) => ReactElement<any, string | JSXElementConstructor<any>>)

Returns

Parameters

props: FormCallbacksProps<Values, ExtraContext>

Returns ReactElement<any, string | JSXElementConstructor<any>>

FormHTMLCheckbox

Returns (<Name>(props: FormHTMLCheckboxProps<Values, Name>) => ReactElement<any, string | JSXElementConstructor<any>>)

Returns

Type Parameters

Name extends string

Parameters

props: FormHTMLCheckboxProps<Values, Name>

Returns ReactElement<any, string | JSXElementConstructor<any>>

FormHTMLInput

Returns (<Name>(props: FormHTMLInputProps<Values, Name>) => ReactElement<any, string | JSXElementConstructor<any>>)

Returns

Type Parameters

Name extends string

Parameters

props: FormHTMLInputProps<Values, Name>

Returns ReactElement<any, string | JSXElementConstructor<any>>

FormHandler

Returns ((props: FormHandlerProps<Values>) => ReactElement<any, string | JSXElementConstructor<any>>)

Returns

Parameters

props: FormHandlerProps<Values>

Returns ReactElement<any, string | JSXElementConstructor<any>>

FormHandlerStateless

Returns ((props: FormHandlerStatelessProps<Values>) => ReactElement<any, string | JSXElementConstructor<any>>)

Returns

Parameters

props: FormHandlerStatelessProps<Values>

Returns ReactElement<any, string | JSXElementConstructor<any>>

FormReactInput

Returns (<Name>(props: FormReactInputProps<Values, Name>) => ReactElement<any, string | JSXElementConstructor<any>>)

Returns

Type Parameters

Name extends string

Parameters

props: FormReactInputProps<Values, Name>

Returns ReactElement<any, string | JSXElementConstructor<any>>

FormValues

Returns ((props: FormValuesProps<Values>) => ReactElement<any, string | JSXElementConstructor<any>>)

Returns

Parameters

props: FormValuesProps<Values>

Returns ReactElement<any, string | JSXElementConstructor<any>>

useChangeHandler

Returns (<Name>(arg: UseChangeHandlerArg<Name>) => UseChangeHandlerReturn<Values, Name>)

Returns

Type Parameters

Name extends string

Parameters

arg: UseChangeHandlerArg<Name>

Returns UseChangeHandlerReturn<Values, Name>

`Private` `Readonly` #cache

`Private` `Readonly` #extraContextDefault