Skip to content

Expose new impertive methods on picker #1988

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 19, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion demo/src/screens/componentScreens/PickerScreen.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ import {
PanningProvider,
Typography,
PickerProps,
DialogProps
PickerMethods,
DialogProps,
Button
} from 'react-native-ui-lib'; //eslint-disable-line
import contactsData from '../../data/conversations';
import {longOptions} from './PickerScreenLongOptions';
Expand All @@ -38,6 +40,7 @@ const filters = [
];

export default class PickerScreen extends Component {
picker = React.createRef<PickerMethods>();
state = {
itemsCount: 1,
// language: {value: 'java', label: 'Java'},
Expand Down Expand Up @@ -260,6 +263,8 @@ export default class PickerScreen extends Component {

<Picker
migrate
// @ts-expect-error
ref={this.picker}
migrateTextField
label="Language"
placeholder="Favorite Language"
Expand All @@ -270,13 +275,20 @@ export default class PickerScreen extends Component {
searchPlaceholder={'Search a language'}
searchStyle={{color: Colors.blue30, placeholderTextColor: Colors.grey50}}
marginT-s4
enableErrors={false}
// mode={Picker.modes.MULTI}
// useNativePicker
>
{_.map(options, option => (
<Picker.Item key={option.value} value={option.value} label={option.label} disabled={option.disabled}/>
))}
</Picker>
<Button
label="Open Picker Manually"
link
style={{alignSelf: 'flex-start'}}
onPress={() => this.picker.current?.openExpandable?.()}
/>
</View>
</ScrollView>
);
Expand Down
29 changes: 29 additions & 0 deletions src/components/picker/helpers/useImperativePickerHandle.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
import React, {useImperativeHandle, useRef} from 'react';
import {ExpandableOverlayMethods} from '../../../incubator/expandableOverlay';
import {TextFieldMethods} from '../../../incubator/TextField';

const useImperativePickerHandle = (ref: React.Ref<any>,
expandableRef: React.MutableRefObject<ExpandableOverlayMethods | null>) => {
const pickerRef = useRef<TextFieldMethods>();
useImperativeHandle(ref, () => {
// @ts-expect-error useRef return type is possible null therefor it throw TS error
const {isFocused, focus, blur, clear, validate} = pickerRef.current;
// @ts-expect-error useRef return type is possible null therefor it throw TS error
const {openExpandable, closeExpandable, toggleExpandable} = expandableRef.current;

return {
isFocused,
focus,
blur,
clear,
validate,
openExpandable,
closeExpandable,
toggleExpandable
};
});

return pickerRef;
};

export default useImperativePickerHandle;
14 changes: 8 additions & 6 deletions src/components/picker/new.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import {
ForwardRefInjectedProps,
BaseComponentInjectedProps
} from '../../commons/new';
import ExpandableOverlay, {ExpandableOverlayProps} from '../../incubator/expandableOverlay';
import ExpandableOverlay, {ExpandableOverlayProps, ExpandableOverlayMethods} from '../../incubator/expandableOverlay';
// @ts-expect-error
import {TextField} from '../inputs';
import TextFieldMigrator from '../textField/TextFieldMigrator';
Expand All @@ -26,8 +26,9 @@ import PickerContext from './PickerContext';
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 {PickerProps, PickerItemProps, PickerValue, PickerModes, PickerSearchStyle} from './types';
import {PickerProps, PickerItemProps, PickerValue, PickerModes, PickerSearchStyle, PickerMethods} from './types';

const Picker = (props: PropsWithChildren<PickerProps> & ForwardRefInjectedProps & BaseComponentInjectedProps) => {
const {
Expand Down Expand Up @@ -68,9 +69,11 @@ const Picker = (props: PropsWithChildren<PickerProps> & ForwardRefInjectedProps
const [selectedItemPosition, setSelectedItemPosition] = useState(0);
const [items] = useState(Picker.extractPickerItems(props));

const pickerExpandable = useRef<typeof ExpandableOverlay>();
const pickerExpandable = useRef<ExpandableOverlayMethods>(null);

usePickerMigrationWarnings({value, mode});

const pickerRef = useImperativePickerHandle(forwardedRef, pickerExpandable);
const {
filteredChildren,
setSearchValue,
Expand Down Expand Up @@ -199,7 +202,6 @@ const Picker = (props: PropsWithChildren<PickerProps> & ForwardRefInjectedProps
return (
<PickerContext.Provider value={contextValue}>
<ExpandableOverlay
// @ts-expect-error
ref={pickerExpandable}
modalProps={modalProps}
expandableContent={expandableModalContent}
Expand All @@ -216,7 +218,7 @@ const Picker = (props: PropsWithChildren<PickerProps> & ForwardRefInjectedProps
<TextFieldMigrator
migrate={migrateTextField}
customWarning="RNUILib Picker component's internal TextField will soon be replaced with a new implementation, in order to start the migration - please pass to Picker the 'migrateTextField' prop"
ref={forwardedRef}
ref={pickerRef}
// {...textInputProps}
{...others}
testID={`${testID}.input`}
Expand Down Expand Up @@ -251,6 +253,6 @@ Picker.extractPickerItems = (props: PropsWithChildren<PickerProps>) => {
return items;
};

export {PickerProps, PickerItemProps, PickerValue, PickerModes, PickerSearchStyle};
export {PickerProps, PickerItemProps, PickerValue, PickerModes, PickerSearchStyle, PickerMethods};
export {Picker}; // For tests
export default asBaseComponent<PickerProps, typeof Picker>(forwardRef(Picker));
5 changes: 4 additions & 1 deletion src/components/picker/types.tsx
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
import React, {PropsWithChildren, ReactNode} from 'react';
import {FlatListProps, StyleProp, ViewStyle, TextStyle} from 'react-native';
import {ExpandableOverlayProps} from '../../incubator/expandableOverlay';
import {ExpandableOverlayProps, ExpandableOverlayMethods} from '../../incubator/expandableOverlay';
import {ModalTopBarProps} from '../modal/TopBar';
// TODO: Replace with new TextField Props after migration to new TextField has completed
import {TextFieldProps} from '../../../typings/components/Inputs';
import {TextFieldMethods} from '../../incubator/TextField';

// Note: enum values are uppercase due to legacy
export enum PickerModes {
Expand Down Expand Up @@ -248,3 +249,5 @@ export type PickerItemsListProps = Pick<
| 'useSafeArea'
| 'testID'
>;

export type PickerMethods = TextFieldMethods & ExpandableOverlayMethods;
4 changes: 2 additions & 2 deletions src/incubator/TextField/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import {asBaseComponent, forwardRef} from '../../commons/new';
import View from '../../components/view';
import {Colors} from '../../style';
import {useMeasure} from '../../hooks';
import {TextFieldProps, InternalTextFieldProps, ValidationMessagePosition, FieldContextType} from './types';
import {TextFieldProps, InternalTextFieldProps, ValidationMessagePosition, FieldContextType, TextFieldMethods} from './types';
import {shouldHidePlaceholder} from './Presenter';
import Input from './Input';
import ValidationMessage from './ValidationMessage';
Expand Down Expand Up @@ -168,5 +168,5 @@ const TextField = (props: InternalTextFieldProps) => {
TextField.displayName = 'Incubator.TextField';
TextField.validationMessagePositions = ValidationMessagePosition;

export {TextFieldProps, FieldContextType, StaticMembers as TextFieldStaticMembers};
export {TextFieldProps, FieldContextType, StaticMembers as TextFieldStaticMembers, TextFieldMethods};
export default asBaseComponent<TextFieldProps, StaticMembers>(forwardRef(TextField as any));
8 changes: 8 additions & 0 deletions src/incubator/TextField/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -227,3 +227,11 @@ export type FieldContextType = {
disabled: boolean;
validateField: () => void;
};

export interface TextFieldMethods {
isFocused: () => void;
focus: () => void;
blur: () => void;
clear: () => void;
validate: () => boolean;
}
12 changes: 5 additions & 7 deletions src/incubator/expandableOverlay/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,16 @@ import View from '../../components/view';
import Modal, {ModalProps, ModalTopBarProps} from '../../components/modal';
import Dialog, {DialogProps} from '../../components/dialog';

export interface RenderCustomOverlayProps {
visible: boolean;
export interface ExpandableOverlayMethods {
openExpandable: () => void;
closeExpandable: () => void;
toggleExpandable: () => void;
}

export interface RenderCustomOverlayProps extends ExpandableOverlayMethods {
visible: boolean;
}

export type ExpandableOverlayProps = TouchableOpacityProps &
PropsWithChildren<{
/**
Expand Down Expand Up @@ -48,11 +51,6 @@ export type ExpandableOverlayProps = TouchableOpacityProps &
disabled?: boolean;
}>;

interface ExpandableOverlayMethods {
openExpandable: () => void;
closeExpandable: () => void;
}

const ExpandableOverlay = (props: ExpandableOverlayProps, ref: any) => {
const {
children,
Expand Down
3 changes: 2 additions & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,8 @@ export {
PickerItemProps,
PickerValue,
PickerModes,
PickerSearchStyle
PickerSearchStyle,
PickerMethods
} from './components/picker/new';
export {default as ProgressBar, ProgressBarProps} from './components/progressBar';
export {default as RadioButton, RadioButtonProps} from './components/radioButton';
Expand Down