react-bfm/types/index.d.ts

A basic field / form manager for React using hooks

/**
 * @deprecated Will be removed in v3.0.0. This is an internal implementation detail and should not be used directly.
 */
export { BFMHooksContext } from './context';
/**
 * @deprecated Will be removed in v3.0.0. This is an internal implementation detail and should not be used directly.
 */
export type { BFMHookContextType } from './context';
export { FIELD_KEY_INITIAL_VALUE, 
/**
 * @deprecated Will be removed in v3.0.0. This is an internal implementation detail.
 */
FIELD_KEY_INITIAL_VALUE_ERROR, FIELD_KEY_DIRTY, FIELD_KEY_ERROR, FIELD_KEY_FOCUS, FIELD_KEY_TOUCHED, FIELD_KEY_VALID, FIELD_KEY_VALUE, FIELD_KEY_VALUE_ON_FOCUS, } from './constants/field-keys';
export { FIELD_DEFAULT_DEFAULT_VALUE, 
/**
 * @deprecated Will be removed in v3.0.0. This is an internal implementation detail.
 */
FIELD_DEFAULT_DEFAULT_VALUE_ERROR, FIELD_DEFAULT_DIRTY, FIELD_DEFAULT_ERROR, FIELD_DEFAULT_FOCUS, FIELD_DEFAULT_TOUCHED, FIELD_DEFAULT_VALID, FIELD_DEFAULT_VALUE, FIELD_DEFAULT_VALUE_ON_FOCUS, } from './constants/field-defaults';
export { FIELD_STATE_DEFAULT, NAMESPACE_STATE_DEFAULT } from './constants/state-defaults';
export { clearField, resetField } from './field/actions';
export { getFieldInitialValue, getFieldError, getFieldValue, getFieldValueOnFocus, hasFieldFocus, isFieldDirty, isFieldTouched, isFieldValid, } from './field/getters';
export { useFieldError, useFieldHasFocus, useFieldIsDirty, useFieldIsTouched, useFieldIsValid, useFieldState, useFieldValue, useFieldValueOnFocus, } from './field/hooks';
export { checkedEventToValue, defaultDirtyCheck, defaultEventToValue, defaultValueToInput, 
/**
 * @deprecated Will be removed in v3.0.0. This is an internal implementation detail.
 */
mapFieldValueAndError, validateFieldName, validateNamespace, } from './helpers';
export { clearNamespace, resetNamespace } from './namespace/actions';
export { useNamespaceErrors, useNamespaceHasFocus, useNamespaceIsDirty, useNamespaceIsTouched, useNamespaceIsValid, useNamespaceKeyIsEvery, useNamespaceKeyIsSome, useNamespaceKeyValues, useNamespaceState, useNamespaceValues, useNamespaceValuesOnFocus, } from './namespace/hooks';
export { getNamespaceInitialValues, getNamespaceErrors, getNamespaceKeyIsEvery, getNamespaceKeyIsSome, getNamespaceKeyValues, getNamespaceValues, getNamespaceValuesOnFocus, hasNamespaceFocus, isNamespaceDirty, isNamespaceTouched, isNamespaceValid, } from './namespace/getters';
export type { ConnectFieldChangeHandler, FieldNameType, FieldStateType, DirtyCheckFunction, FieldStateKeyType, GetNamespaceType, NamespaceStateType, NamespaceType, SubscriberFieldCallbackType, SubscriberNamespaceCallbackType, TransformEventToValueFunction, TransformValueToInputFunction, UpdateFieldCallbackType, ValidatorFunction, } from './common';
export { getFieldState, getNamespaceState, initFieldState, removeField, createGetSnapshotFieldState, createGetSnapshotNamespaceState, createSubscribeToField, createSubscribeToNamespace, updateFieldStateWithCallback, } from './state';
export type { StateCreatorReturnType } from './state';
export { useConnectField } from './use-connect-field';
export type { ConnectFieldProps, ConnectFieldReturnProps, FactoryWithoutConnectFieldProps } from './use-connect-field';