Skip to content

TextField - ClearButton - fix right margin #3482

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 2 commits into from
Jan 27, 2025
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
11 changes: 4 additions & 7 deletions src/components/textField/ClearButton.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ import {StyleSheet} from 'react-native';
import {useAnimatedStyle, useSharedValue, withTiming, Easing} from 'react-native-reanimated';
import {useDidUpdate} from '../../hooks';
import Assets from '../../assets';
import {Spacings, Colors} from '../../style';
import {Colors} from '../../style';
import View from '../view';
import Button from '../button';
import FieldContext from './FieldContext';
import {TextFieldProps} from './types';
import {ClearButtonProps} from './types';

const hitSlop = {top: 20, bottom: 20, left: 20, right: 20};
const NON_VISIBLE_POSITION = 18;
Expand All @@ -17,7 +17,7 @@ const TIMING_CONFIG = {
easing: Easing.bezier(0.33, 1, 0.68, 1)
};

const ClearButton = ({testID, onClear, onChangeText}: Pick<TextFieldProps, 'onClear' | 'testID' | 'onChangeText'>) => {
const ClearButton = ({testID, onClear, onChangeText, clearButtonStyle}: ClearButtonProps) => {
const {hasValue} = useContext(FieldContext);
const animatedValue = useSharedValue(hasValue ? VISIBLE_POSITION : NON_VISIBLE_POSITION);
const animatedOpacity = useSharedValue(hasValue ? 1 : 0);
Expand All @@ -29,7 +29,7 @@ const ClearButton = ({testID, onClear, onChangeText}: Pick<TextFieldProps, 'onCl
};
});

const style = useMemo(() => [styles.container, animatedStyle], [animatedStyle]);
const style = useMemo(() => [clearButtonStyle, animatedStyle], [clearButtonStyle, animatedStyle]);

const animate = useCallback(() => {
const toValue = hasValue ? VISIBLE_POSITION : NON_VISIBLE_POSITION;
Expand Down Expand Up @@ -64,9 +64,6 @@ const ClearButton = ({testID, onClear, onChangeText}: Pick<TextFieldProps, 'onCl
};

const styles = StyleSheet.create({
container: {
marginHorizontal: Spacings.s3
},
clearIcon: {
tintColor: Colors.$textNeutralLight
}
Expand Down
8 changes: 7 additions & 1 deletion src/components/textField/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ const TextField = (props: InternalTextFieldProps) => {
centered,
readonly = false,
showMandatoryIndication,
clearButtonStyle,
...others
} = usePreset(props);

Expand Down Expand Up @@ -208,7 +209,12 @@ const TextField = (props: InternalTextFieldProps) => {
</View>
)}
{showClearButton && (
<ClearButton onClear={onClear} testID={`${props.testID}.clearButton`} onChangeText={onChangeText}/>
<ClearButton
onClear={onClear}
testID={`${props.testID}.clearButton`}
onChangeText={onChangeText}
clearButtonStyle={clearButtonStyle}
/>
)}
{trailingAccessory}
{/* </View> */}
Expand Down
2 changes: 2 additions & 0 deletions src/components/textField/presets/outline.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import {BorderRadiuses, Colors, Spacings} from '../../../style';
import underline from './underline';

const styles = StyleSheet.create({
clearButtonStyle: {marginLeft: Spacings.s3},
field: {
borderWidth: 1,
borderColor: Colors.$outlineDisabled,
Expand All @@ -14,5 +15,6 @@ const styles = StyleSheet.create({

export default {
...underline,
clearButtonStyle: styles.clearButtonStyle,
fieldStyle: styles.field
};
2 changes: 2 additions & 0 deletions src/components/textField/presets/underline.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ const styles = StyleSheet.create({
lineHeight: undefined,
height: Typography?.text70?.lineHeight
},
clearButtonStyle: {marginHorizontal: Spacings.s3},
floatingPlaceholder: {...Typography.text70}
});

Expand All @@ -37,5 +38,6 @@ export default {
labelColor: colorByState,
fieldStyle: styles.field,
style: styles.input,
clearButtonStyle: styles.clearButtonStyle,
floatingPlaceholderStyle: styles.floatingPlaceholder
};
16 changes: 12 additions & 4 deletions src/components/textField/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,17 @@ export interface MandatoryIndication {
showMandatoryIndication?: boolean;
}

export interface ClearButtonProps extends Pick<TextInputProps, 'testID' | 'onChangeText'> {
/**
* On clear button callback
*/
onClear?: () => void;
/**
* The style of the clear button
*/
clearButtonStyle?: StyleProp<ViewStyle>;
}

export interface LabelProps extends MandatoryIndication, Pick<ValidationMessageProps, 'enableErrors'> {
/**
* Field label
Expand Down Expand Up @@ -190,6 +201,7 @@ export type TextFieldProps = MarginModifiers &
LabelProps &
Omit<FloatingPlaceholderProps, 'testID'> &
MandatoryIndication &
Omit<ClearButtonProps, 'testID' | 'onChangeText'> &
// We're declaring these props explicitly here for react-docgen (which can't read hooks)
// FieldStateProps &
ValidationMessageProps &
Expand All @@ -214,10 +226,6 @@ export type TextFieldProps = MarginModifiers &
* Should show a clear button when there is a value
*/
showClearButton?: boolean;
/**
* On clear button callback
*/
onClear?: () => void;
/**
* Text to display under the input
*/
Expand Down