deprecate children, migrate picker props (#3078)

* deprecate children, migrate picker props

* deprecation of onShow prop

Author: adids1221

src/components/picker/helpers/usePickerMigrationWarnings.tsx

@@ -1,27 +1,34 @@
 import {useEffect} from 'react';
-import _ from 'lodash';
 import {LogService} from '../../../services';
-import {PickerProps, PickerModes} from '../types';
+import {PickerProps} from '../types';
 
-// @ts-expect-error TODO: Remove this whole file when migration is completed
-type UsePickerMigrationWarnings = Pick<PickerProps, 'value' | 'mode' | 'useNativePicker'>;
+// TODO: Remove this whole file when migration is completed
+type UsePickerMigrationWarnings = Pick<
+  PickerProps,
+  'children' | 'migrate' | 'getItemLabel' | 'getItemValue' | 'onShow'
+>;
 
 const usePickerMigrationWarnings = (props: UsePickerMigrationWarnings) => {
-  const {value, mode, useNativePicker} = props;
+  const {children, migrate, getItemLabel, getItemValue, onShow} = props;
   useEffect(() => {
-    if (mode === PickerModes.SINGLE && Array.isArray(value)) {
-      LogService.warn('Picker in SINGLE mode cannot accept an array for value');
+    if (children) {
+      LogService.warn(`UILib Picker will stop supporting the 'children' prop in the next major version, please pass 'items' prop instead`);
     }
-    if (mode === PickerModes.MULTI && !Array.isArray(value)) {
-      LogService.warn('Picker in MULTI mode must accept an array for value');
+
+    if (migrate) {
+      LogService.warn(`UILib Picker will stop supporting the 'migrate' prop in the next major version, please stop using it. The picker uses the new implementation by default.`);
+    }
+
+    if (getItemLabel) {
+      LogService.warn(`UILib Picker will stop supporting the 'getItemLabel' prop in the next major version, please pass the 'getItemLabel' prop to the specific item instead`);
     }
 
-    if (_.isPlainObject(value)) {
-      LogService.warn('UILib Picker will stop supporting passing object as value in the next major version. Please use either string or a number as value');
+    if (getItemValue) {
+      LogService.warn(`UILib Picker will stop supporting the 'getItemValue' prop in the next major version, please stop using it. The value will be extract from 'items' prop instead`);
     }
 
-    if (useNativePicker) {
-      LogService.warn(`UILib Picker will stop supporting the 'useNativePicker' prop soon, please pass instead the 'useWheelPicker' prop and handle relevant TextField migration if required to`);
+    if (onShow) {
+      LogService.warn(`UILib Picker will stop supporting the 'onShow' prop in the next major version, please pass the 'onShow' prop from the 'pickerModalProps' instead`);
     }
   }, []);
 };

src/components/picker/index.tsx

@@ -3,7 +3,6 @@
 // TODO: deprecate getItemLabel prop
 // TODO: Add initialValue prop
 // TODO: consider deprecating renderCustomModal prop
-// TODO: deprecate onShow cause it's already supported by passing it in pickerModalProps
 import _ from 'lodash';
 import React, {useMemo, useState, useRef, useCallback, useEffect} from 'react';
 import {LayoutChangeEvent} from 'react-native';
@@ -23,7 +22,7 @@ import usePickerSelection from './helpers/usePickerSelection';
 import usePickerLabel from './helpers/usePickerLabel';
 import usePickerSearch from './helpers/usePickerSearch';
 import useImperativePickerHandle from './helpers/useImperativePickerHandle';
-// import usePickerMigrationWarnings from './helpers/usePickerMigrationWarnings';
+import usePickerMigrationWarnings from './helpers/usePickerMigrationWarnings';
 import {extractPickerItems} from './PickerPresenter';
 import {
   PickerProps,
@@ -107,8 +106,8 @@ const Picker = React.forwardRef((props: PickerProps, ref) => {
 
   const pickerExpandable = useRef<ExpandableOverlayMethods>(null);
 
-  // TODO: Remove
-  // usePickerMigrationWarnings({value, mode});
+  // TODO:  Remove this when migration is completed, starting of v8
+  usePickerMigrationWarnings({children, migrate, getItemLabel, getItemValue});
 
   const pickerRef = useImperativePickerHandle(ref, pickerExpandable);
   const {

src/components/picker/types.tsx

@@ -55,6 +55,7 @@ export type PickerBaseProps = Omit<NewTextFieldProps, 'value' | 'onChange'> & {
    */
   useDialog?: boolean;
   /**
+   * @deprecated
    * Temporary prop required for migration to Picker's new API
    */
   migrate?: boolean;
@@ -172,6 +173,7 @@ export type PickerBaseProps = Omit<NewTextFieldProps, 'value' | 'onChange'> & {
    */
   containerStyle?: StyleProp<ViewStyle>;
   /**
+   * @deprecated
    * Callback for modal onShow event
    */
   onShow?: () => void;
@@ -187,6 +189,9 @@ export type PickerBaseProps = Omit<NewTextFieldProps, 'value' | 'onChange'> & {
    * Component test id
    */
   testID?: string;
+  /**
+   * @deprecated
+   */
   children?: ReactNode | undefined;
 };