@wix/editor-react-components 1.2764.0 → 1.2766.0

package/dist/site/components/TextInput/TextInput.types.d.ts

@@ -1,119 +1,52 @@
 import { A11y, Direction } from '@wix/editor-react-types';
-import { CorvidTypes } from '../../../types/vendored/editor-elements-types-corvid';
-import { DefaultCompPlatformProps } from '../../../types/vendored/editor-elements-types-thunderbolt';
-import { IReadOnlyPropSDK } from '../../../common/sdk/props-factories/readOnlyPropsSDKFactory';
-import { IRequiredPropSDK } from '../../../common/sdk/props-factories/requiredPropsSDKFactory';
-import { IValidationPropSDK, IValidationPropSDKProps, IValidationPropsSDKActions, IValidationPropsImperativeActions } from '../../../common/sdk/props-factories/validationPropsSDKFactory';
-import { ITextInputPropSDK, ITextInputPropsSDKActions } from '../../../common/sdk/props-factories/textInputPropsSDKFactory';
-import { IValuePropsSDK } from '../../../common/sdk/props-factories/valuePropsSDKFactory';
-import { IFocusPropsSDKActions, IFocusPropsSDK, IFocusPropsImperativeActions } from '../../../common/sdk/props-factories/focusPropsSDKFactory';
-import { IDisabledPropSDK } from '../../../common/sdk/props-factories/disablePropsSDKFactory';
-import { IClickPropsSDKActions, IClickPropSDK } from '../../../common/sdk/props-factories/clickPropsSDKFactory';
-import { IChangePropsSDKActions } from '../../../common/sdk/props-factories/changePropsSDKFactory';
-import { IElementPropsSDKActions, IElementPropsSDK, ToJSONBase } from '../../../common/sdk/props-factories/elementPropsSDKFactory';
-import { IAccessibilityPropSDK, IAccessibilityPropSDKProps } from '../../../common/sdk/props-factories/accessibilitySDKFactories/types';
-import { ILabelPropSDK } from '../../../common/sdk/props-factories/labelPropsSDKFactory';
-import { HydrationSDKAction } from '../../../common/sdk/props-factories/hydrationSDKFactory';
-import { ErrorMessageType, ViewerTranslations } from '../../../types/vendored/editor-elements-types-components';
-import { IValidationControllerProps } from '../../../utils/controllerUtils';
-import { LogicalAlignment, PhysicalAlignment, WithInherit } from '../../../utils/direction.types';
-import { InlineErrorMessageTranslationKeys } from '../../../common/InlineErrorMessage/InlineErrorMessage';
-import { FieldValidationProps } from '../../../utils/validation/types';
 import type * as React from 'react';
-type ResolverType = 'scale' | 'fixed';
-type Spx = {
-    refWidth: number;
-    resolverType: ResolverType;
+/**
+ * Per-element className overrides. Keys match the manifest element keys — the
+ * Viewer resolves the active design state (Hover / Focus / Error / Disabled) to
+ * a class token and delivers it here, so every one of these has to reach the
+ * matching DOM node or the state silently does nothing.
+ */
+export type TextInputElementProps = {
+    label?: {
+        className?: string;
+    };
+    input?: {
+        className?: string;
+    };
+    helperText?: {
+        className?: string;
+    };
+    errorMessage?: {
+        className?: string;
+    };
 };
-export type ITextInputImperativeActions = IFocusPropsImperativeActions & IValidationPropsImperativeActions;
-export type ITextInputProps = ITextInputMapperProps & DefaultCompPlatformProps & IValidationPropSDKProps & FieldValidationProps<string> & IChangePropsSDKActions<HTMLInputElement> & Partial<ITextInputPropsSDKActions<HTMLInputElement>> & Partial<IFocusPropsSDKActions> & Partial<IClickPropsSDKActions> & Partial<IValidationPropsSDKActions<ITextInputProps>> & Partial<IElementPropsSDKActions> & Partial<HydrationSDKAction> & ITextInputControllerProps & IAccessibilityPropSDKProps & {
-    a11y?: Pick<A11y, 'ariaLabel'>;
-    ref?: React.Ref<ITextInputImperativeActions>;
+export type ITextInputProps = ITextInputMapperProps & {
+    id: string;
     autoFocus?: boolean;
     className?: string;
     dataTestId?: string;
-} & {
     contentRef?: React.Ref<HTMLDivElement>;
-} & {
-    componentViewMode?: string;
-} & Partial<ViewerTranslations<'phoneFormatLengthValidationError' | 'phoneFormatDefaultValidationError' | 'phoneFormatComplexPhoneDefaultValidationError' | InlineErrorMessageTranslationKeys>>;
-export type ITextInputOwnSDK = {
-    max?: number | null;
-    min?: number | null;
-    inputType: TextInputType;
-    numberSpinnerHidden?: boolean;
-    showNumberSpinner: () => Promise<void>;
-    hideNumberSpinner: () => Promise<void>;
-    toJSON(): ToJSONBase & Pick<ITextInputProps, 'readOnly' | 'required' | 'value' | 'max' | 'min' | 'inputType'>;
+    elementProps?: TextInputElementProps;
+    wix?: {
+        presetsWrapperProps?: Record<string, unknown>;
+    };
 };
-export type ITextInputOwnSDKFactory = CorvidTypes.CorvidSDKFactory<ITextInputProps, ITextInputOwnSDK, any, ITextInputImperativeActions>;
-export type ITextInputSDK = ITextInputOwnSDK & IDisabledPropSDK & IRequiredPropSDK & IReadOnlyPropSDK & ITextInputPropSDK & ILabelPropSDK & IFocusPropsSDK & IClickPropSDK & IElementPropsSDK & IValuePropsSDK<ITextInputProps['value']> & IAccessibilityPropSDK & IValidationPropSDK;
-export type ITextInputSDKFactory = CorvidTypes.CorvidSDKFactory<ITextInputProps, ITextInputSDK>;
-export type ITextInputCorvidModel = CorvidTypes.ICorvidModel<ITextInputSDKFactory>;
-export type TextInputCSSVars = {
-    '--fntlbl': string;
-    '--fnt': string;
-    '--direction'?: string;
-    '--align': string;
-    '--labelDirection': string;
-    '--inputDirection': string;
-    '--errorDirection': string;
-    '--textPadding': string;
-    '--textPadding_start': string;
-    '--textPadding_end': string;
-    '--labelPadding_start': string;
-    '--labelPadding_end': string;
-    '--labelMarginBottom': string;
-    '--inputHeight'?: string;
-    '--requiredIndicationDisplay'?: 'none' | 'inline';
-    height?: string;
-};
-export type TextInputPreviewCSSVars = TextInputCSSVars & {
-    '--height': string;
-    height: `var(--height)`;
-};
-export type TextInputAutocomplete = 'on' | 'off';
 export type ITextInputMapperProps = {
-    skin: TextInputSkin;
-    value: string;
-    defaultValue?: string;
-    inputType: TextInputType;
+    a11y?: A11y;
+    /** Controlled value. Omission renders an empty input; edits require a parent update. */
+    value?: string;
+    onValueChange?: (value: string) => void;
     label?: string;
     placeholder?: string;
-    tooltip?: string;
-    description?: string;
+    helperText?: string;
+    errorMessage?: string;
+    /**
+     * Editor-only: the `previewError` functional state forces the error message
+     * part visible while a designer is styling it.
+     */
+    previewError?: boolean;
+    /** The one direction for the whole component — label, input and messages. */
     direction?: Direction;
-    labelDirection?: Direction;
-    inputDirection?: Direction;
     readOnly: boolean;
-    required: boolean;
-    isDisabled: boolean;
-    pattern?: string;
-    phoneFormat?: string;
-    autoComplete: boolean;
-    prefix?: string;
-    name?: string;
-    autoComplete_?: TextInputAutocomplete | null;
-    autocompleteToken?: string;
-    minLength?: number | null;
-    maxLength?: number | null;
-    min?: number | null;
-    max?: number | null;
-    step?: number | null;
-    numberSpinnerHidden?: boolean | undefined;
-    errorMessageType?: ErrorMessageType;
-    textInputAutoFillFixEnabled?: boolean;
-};
-export type ITextInputControllerProps = ITextInputMapperProps & Partial<IValidationControllerProps>;
-export type TextInputSkin = 'AppsTextInputSkin' | 'ResponsiveTextInputSkin';
-export type TextInputType = 'text' | 'password' | 'number' | 'email' | 'url' | 'tel' | 'search';
-export type TextInputAlignment = PhysicalAlignment;
-export type TextInputDefaultTextType = 'none' | 'initialText' | 'placeholderText' | 'placeholderAndInitialText';
-export type TextInputStyleProperties = Record<string, string> & {
-    spx: Spx;
-    align: LogicalAlignment;
-    labelAlign: WithInherit<LogicalAlignment>;
-    inputAlign: WithInherit<LogicalAlignment>;
-    errorAlign: WithInherit<LogicalAlignment>;
+    disabled: boolean;
 };
-export {};