Skip to content

Rename components props interface #1534

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 3 commits into from
Sep 12, 2021
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
6 changes: 3 additions & 3 deletions demo/src/screens/componentScreens/ModalScreen.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ import {Alert, StyleSheet} from 'react-native';
import {Navigation} from 'react-native-navigation';
import {Colors, Carousel, PageControl, Modal, View, Text} from 'react-native-ui-lib'; // eslint-disable-line

interface ModalScreenPropTypes {
interface ModalScreenProps {
componentId: string;
}

interface State {
currentPage?: number;
}

export default class ModalScreen extends Component<ModalScreenPropTypes, State> {
export default class ModalScreen extends Component<ModalScreenProps, State> {

static options() {
return {
Expand All @@ -22,7 +22,7 @@ export default class ModalScreen extends Component<ModalScreenPropTypes, State>
};
}

constructor(props: ModalScreenPropTypes) {
constructor(props: ModalScreenProps) {
super(props);

this.state = {
Expand Down
24 changes: 12 additions & 12 deletions generatedTypes/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,18 @@ export {
BackgroundColorModifier
} from './src/commons/new';
export {default as ActionBar, ActionBarProps} from './src/components/actionBar';
export {default as Avatar, AvatarPropTypes, AvatarProps} from './src/components/avatar';
export {default as Avatar, AvatarProps} from './src/components/avatar';
export {default as Badge, BadgeProps} from './src/components/badge';
export {default as Card, CardPropTypes, CardProps, CardSectionProps} from './src/components/card';
export {default as Card, CardProps, CardSectionProps} from './src/components/card';
export {default as ConnectionStatusBar, ConnectionStatusBarProps} from './src/components/connectionStatusBar';
export {default as Constants} from './src/helpers/Constants';
export {default as GradientSlider, GradientSliderProps} from './src/components/slider/GradientSlider';
export {default as View, ViewPropTypes, ViewProps} from './src/components/view';
export {default as Text, TextPropTypes, TextProps} from './src/components/text';
export {default as View, ViewProps} from './src/components/view';
export {default as Text, TextProps} from './src/components/text';
export {default as TouchableOpacity, TouchableOpacityProps} from './src/components/touchableOpacity';
export {default as Button, ButtonPropTypes, ButtonSize, ButtonProps} from './src/components/button';
export {default as Checkbox, CheckboxPropTypes, CheckboxProps} from './src/components/checkbox';
export {default as Chip, ChipPropTypes, ChipProps} from './src/components/chip';
export {default as Button, ButtonSize, ButtonProps} from './src/components/button';
export {default as Checkbox, CheckboxProps} from './src/components/checkbox';
export {default as Chip, ChipProps} from './src/components/chip';
export {default as ColorPicker, ColorPickerProps} from './src/components/colorPicker';
export {default as ColorPalette, ColorPaletteProps} from './src/components/colorPicker/ColorPalette';
export {default as ColorSwatch, ColorSwatchProps} from './src/components/colorPicker/ColorSwatch';
Expand All @@ -48,8 +48,8 @@ export {default as GridView, GridViewProps} from './src/components/gridView';
export {default as Hint, HintProps} from './src/components/hint';
export {default as Image, ImageProps} from './src/components/image';
export {default as Overlay, OverlayTypes} from './src/components/overlay';
export {default as RadioButton, RadioButtonPropTypes, RadioButtonProps} from './src/components/radioButton';
export {default as RadioGroup, RadioGroupPropTypes, RadioGroupProps} from './src/components/radioGroup';
export {default as RadioButton, RadioButtonProps} from './src/components/radioButton';
export {default as RadioGroup, RadioGroupProps} from './src/components/radioGroup';
export {default as SectionsWheelPicker, SectionsWheelPickerProps} from './src/components/sectionsWheelPicker';
export {default as SegmentedControl, SegmentedControlProps, SegmentedControlItemProps} from './src/components/segmentedControl';
export {default as Slider, SliderProps} from './src/components/slider';
Expand All @@ -74,9 +74,9 @@ export {
PanDirectionsProps,
PanningProviderDirection
} from './src/components/panningViews/panningProvider';
export {default as PanListenerView, PanListenerViewPropTypes, PanListenerViewProps} from './src/components/panningViews/panListenerView';
export {default as PanResponderView, PanResponderViewPropTypes, PanResponderViewProps} from './src/components/panningViews/panResponderView';
export {default as PanDismissibleView, PanDismissibleViewPropTypes, DismissibleAnimationPropTypes, PanDismissibleViewProps, DismissibleAnimationProps} from './src/components/panningViews/panDismissibleView';
export {default as PanListenerView, PanListenerViewProps} from './src/components/panningViews/panListenerView';
export {default as PanResponderView, PanResponderViewProps} from './src/components/panningViews/panResponderView';
export {default as PanDismissibleView, PanDismissibleViewProps, DismissibleAnimationProps} from './src/components/panningViews/panDismissibleView';
export {default as Dialog, DialogProps} from './src/components/dialog';
export {default as PageControl, PageControlProps} from './src/components/pageControl';
export {default as Carousel, CarouselProps, PageControlPosition} from './src/components/carousel';
Expand Down
1 change: 0 additions & 1 deletion generatedTypes/src/components/avatar/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,6 @@ export declare type AvatarProps = Pick<AccessibilityProps, 'accessibilityLabel'>
*/
testID?: string;
};
export declare type AvatarPropTypes = AvatarProps;
/**
* @description: Avatar component for displaying user profile images
* @extends: TouchableOpacity, Image
Expand Down
1 change: 0 additions & 1 deletion generatedTypes/src/components/button/ButtonTypes.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,6 @@ export declare type ButtonProps = TouchableOpacityProps & TypographyModifiers &
*/
animateTo?: ButtonAnimationDirection;
};
export declare type ButtonPropTypes = ButtonProps;
export declare type ButtonState = {
size?: number;
borderRadius?: number;
Expand Down
4 changes: 2 additions & 2 deletions generatedTypes/src/components/button/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import React, { PureComponent } from 'react';
import { LayoutChangeEvent, ImageStyle } from 'react-native';
import { ButtonSize, ButtonAnimationDirection, ButtonProps, ButtonPropTypes, ButtonState, Props } from './ButtonTypes';
export { ButtonSize, ButtonAnimationDirection, ButtonProps, ButtonPropTypes };
import { ButtonSize, ButtonAnimationDirection, ButtonProps, ButtonState, Props } from './ButtonTypes';
export { ButtonSize, ButtonAnimationDirection, ButtonProps };
declare class Button extends PureComponent<Props, ButtonState> {
static displayName: string;
static defaultProps: {
Expand Down
1 change: 0 additions & 1 deletion generatedTypes/src/components/card/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,6 @@ export declare type CardProps = ViewProps & TouchableOpacityProps & {
hideIndicator?: boolean;
};
};
export declare type CardPropTypes = CardProps;
declare const _default: React.ComponentClass<ViewProps & TouchableOpacityProps & {
/**
* card custom width
Expand Down
4 changes: 2 additions & 2 deletions generatedTypes/src/components/carousel/CarouselPresenter.d.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import {PropsWithChildren} from 'react';
import {CarouselProps, CarouselState} from './types';
import { PropsWithChildren } from 'react';
import { CarouselProps, CarouselState } from './types';
export declare function getChildrenLength(props: PropsWithChildren<CarouselProps>): number;
export declare function calcOffset(props: CarouselProps, state: Omit<CarouselState, 'initialOffset' | 'prevProps'>): {
x: number;
Expand Down
12 changes: 6 additions & 6 deletions generatedTypes/src/components/carousel/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import React, {Component, RefObject, ReactNode, Key} from 'react';
import {ScrollView, LayoutChangeEvent, NativeSyntheticEvent, NativeScrollEvent} from 'react-native';
import {CarouselProps, CarouselState, PageControlPosition} from './types';
export {CarouselProps, PageControlPosition};
import React, { Component, RefObject, ReactNode, Key } from 'react';
import { ScrollView, LayoutChangeEvent, NativeSyntheticEvent, NativeScrollEvent } from 'react-native';
import { CarouselProps, CarouselState, PageControlPosition } from './types';
export { CarouselProps, PageControlPosition };
declare type DefaultProps = Partial<CarouselProps>;
/**
* @description: Carousel for scrolling pages horizontally
Expand Down Expand Up @@ -49,7 +49,7 @@ declare class Carousel extends Component<CarouselProps, CarouselState> {
getSnapToOffsets: () => number[] | undefined;
shouldUsePageWidth(): number | false | undefined;
shouldEnablePagination(): boolean | undefined;
onContainerLayout: ({nativeEvent: {layout: {width: containerWidth, height: containerHeight}}}: LayoutChangeEvent) => void;
onContainerLayout: ({ nativeEvent: { layout: { width: containerWidth, height: containerHeight } } }: LayoutChangeEvent) => void;
shouldAllowAccessibilityLayout(): boolean | undefined;
onContentSizeChange: () => void;
onMomentumScrollEnd: () => void;
Expand All @@ -64,7 +64,7 @@ declare class Carousel extends Component<CarouselProps, CarouselState> {
renderCarousel(): JSX.Element;
render(): JSX.Element;
}
export {Carousel};
export { Carousel };
declare const _default: React.ComponentClass<CarouselProps & {
useCustomTheme?: boolean | undefined;
}, any> & Carousel & {
Expand Down
12 changes: 7 additions & 5 deletions generatedTypes/src/components/carousel/types.d.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import {ScrollViewProps, StyleProp, ViewStyle, NativeSyntheticEvent, NativeScrollEvent, PointPropType, Animated} from 'react-native';
import {PageControlProps} from '../pageControl';
import { ScrollViewProps, StyleProp, ViewStyle, NativeSyntheticEvent, NativeScrollEvent, PointPropType, Animated } from 'react-native';
import { PageControlProps } from '../pageControl';
export declare enum PageControlPosition {
OVER = 'over',
UNDER = 'under'
OVER = "over",
UNDER = "under"
}
export interface CarouselProps extends ScrollViewProps {
/**
Expand Down Expand Up @@ -37,7 +37,9 @@ export interface CarouselProps extends ScrollViewProps {
/**
* callback for when page has changed
*/
onChangePage?: (newPageIndex: number, oldPageIndex: number, info: {isAutoScrolled: boolean}) => void;
onChangePage?: (newPageIndex: number, oldPageIndex: number, info: {
isAutoScrolled: boolean;
}) => void;
/**
* callback for onScroll event of the internal ScrollView
*/
Expand Down
1 change: 0 additions & 1 deletion generatedTypes/src/components/checkbox/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ export interface CheckboxProps extends TouchableOpacityProps {
*/
containerStyle?: StyleProp<ViewStyle>;
}
export declare type CheckboxPropTypes = CheckboxProps;
declare const _default: React.ComponentClass<CheckboxProps & {
useCustomTheme?: boolean | undefined;
}, any>;
Expand Down
1 change: 0 additions & 1 deletion generatedTypes/src/components/chip/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,6 @@ export declare type ChipProps = ViewProps & TouchableOpacityProps & {
*/
dismissContainerStyle?: StyleProp<ImageStyle>;
};
export declare type ChipPropTypes = ChipProps;
declare const _default: React.ComponentClass<ViewProps & TouchableOpacityProps & {
/**
* Chip's size. Number or a width and height object.
Expand Down
6 changes: 6 additions & 0 deletions generatedTypes/src/components/connectionStatusBar/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@ declare class ConnectionStatusBar extends PureComponent<ConnectionStatusBarProps
}
export { ConnectionStatusBar };
declare const _default: React.ComponentClass<ConnectionStatusBarProps & {
/**
* @description: Top bar to show a "no internet" connection status. Note: Run on real device for best results
* @image: https://user-images.githubusercontent.com/33805983/34683190-f3b1904c-f4a9-11e7-9d46-9a340bd35448.png, https://user-images.githubusercontent.com/33805983/34484206-edc6c6e4-efcb-11e7-88b2-cd394c19dd5e.png
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ConnectionStatusBarScreen.tsx
* @notes: The component requires installing the '@react-native-community/netinfo' native library
*/
useCustomTheme?: boolean | undefined;
}, any> & typeof ConnectionStatusBar;
export default _default;
58 changes: 36 additions & 22 deletions generatedTypes/src/components/listItem/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,25 +1,39 @@
import React from 'react';
import ListItemPart from 'src/components/listItem/ListItemPart';
import {ListItemProps} from './types';
export {ListItemProps};

declare class ListItem extends Component<ListItemProps, State> {
static displayName: string;
static Part: typeof ListItemPart;
constructor(props: ListItemProps);
onHideUnderlay(): void;
onShowUnderlay(): void;
setPressed(isPressed: boolean): void;
renderViewContainer: () => JSX.Element;
renderCustomContainer(Container: React.ComponentType): JSX.Element;
renderChildren(): React.DetailedReactHTMLElement<any, HTMLElement>[] | null | undefined;
render(): JSX.Element;
import React, { Component } from 'react';
import ListItemPart from './ListItemPart';
import { ListItemProps } from './types';
declare type ListItemState = {
pressed: boolean;
};
declare class ListItem extends Component<ListItemProps, ListItemState> {
static displayName: string;
static defaultProps: {
height: number;
containerElement: React.ComponentClass<import("../../components/touchableOpacity").TouchableOpacityProps & {
useCustomTheme?: boolean | undefined;
}, any>;
underlayColor: string;
};
static Part: typeof ListItemPart;
styles: {
container: {
backgroundColor: string;
};
innerContainer: {
flexDirection: "row";
height: string | number | undefined;
};
};
constructor(props: ListItemProps);
onHideUnderlay(): void;
onShowUnderlay(): void;
setPressed(isPressed: boolean): void;
renderViewContainer: () => JSX.Element;
renderCustomContainer: (Container: React.ComponentType) => JSX.Element;
renderChildren: () => JSX.Element;
render(): JSX.Element;
}
declare const _default: React.ComponentClass<
ListItemProps & {
export { ListItemProps };
declare const _default: React.ComponentClass<ListItemProps & {
useCustomTheme?: boolean | undefined;
},
any
> &
typeof ListItem;
}, any> & typeof ListItem;
export default _default;
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ export interface DismissibleAnimationProps {
*/
duration?: number;
}
export declare type DismissibleAnimationPropTypes = DismissibleAnimationProps;
export interface PanDismissibleViewProps {
/**
* Additional styling
Expand Down Expand Up @@ -47,6 +46,5 @@ export interface PanDismissibleViewProps {
*/
allowDiagonalDismiss?: boolean;
}
export declare type PanDismissibleViewPropTypes = PanDismissibleViewProps;
declare const _default: React.ComponentClass<PanDismissibleViewProps, any>;
export default _default;
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,5 @@ export interface PanListenerViewProps extends PanningProps, ViewProps {
*/
isClickable?: boolean;
}
export declare type PanListenerViewPropTypes = PanListenerViewProps;
declare const _default: React.ComponentClass<PanListenerViewProps, any>;
export default _default;
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,5 @@ export interface PanResponderViewProps extends ViewProps {
*/
isAnimated?: boolean;
}
export declare type PanResponderViewPropTypes = PanResponderViewProps;
declare const _default: React.ComponentClass<PanResponderViewProps, any>;
export default _default;
1 change: 0 additions & 1 deletion generatedTypes/src/components/radioButton/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ export declare type RadioButtonProps = RadioGroupContextProps & ViewProps & {
*/
containerStyle?: StyleProp<ViewStyle>;
};
export declare type RadioButtonPropTypes = RadioButtonProps;
declare const _default: React.ComponentClass<RadioGroupContextProps & ViewProps & {
/**
* The identifier value of the radio button. must be different than other RadioButtons in the same group
Expand Down
1 change: 0 additions & 1 deletion generatedTypes/src/components/radioGroup/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ export declare type RadioGroupProps = ViewProps & {
*/
onValueChange?: ((value?: string) => void) | ((value?: number) => void) | ((value?: boolean) => void) | ((value?: any) => void);
};
export declare type RadioGroupPropTypes = RadioGroupProps;
interface RadioGroupState {
initialValue?: RadioGroupProps['initialValue'];
value?: RadioGroupProps['initialValue'];
Expand Down
4 changes: 1 addition & 3 deletions generatedTypes/src/components/scrollBar/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,6 @@ declare const Item: {
displayName: string;
};
declare const _default: React.ComponentClass<ScrollBarProps & {
useCustomTheme?: boolean | undefined; /**
* Whether to use a FlatList. NOTE: you must pass 'data' and 'renderItem' props as well
*/
useCustomTheme?: boolean | undefined;
}, any> & typeof ScrollBar;
export default _default;
1 change: 0 additions & 1 deletion generatedTypes/src/components/text/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ export declare type TextProps = RNTextProps & TypographyModifiers & ColorsModifi
textAlign?: string;
style?: StyleProp<TextStyle | Animated.AnimatedProps<TextStyle>>;
};
export declare type TextPropTypes = TextProps;
declare type PropsTypes = BaseComponentInjectedProps & ForwardRefInjectedProps & TextProps;
/**
* @description: A wrapper for Text component with extra functionality like modifiers support
Expand Down
1 change: 0 additions & 1 deletion generatedTypes/src/components/view/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ export interface ViewProps extends Omit<RNViewProps, 'style'>, ContainerModifier
backgroundColor?: string;
style?: StyleProp<ViewStyle | Animated.AnimatedProps<ViewStyle>>;
}
export declare type ViewPropTypes = ViewProps;
declare const _default: React.ComponentClass<ViewProps & {
useCustomTheme?: boolean | undefined;
}, any>;
Expand Down
1 change: 0 additions & 1 deletion src/components/avatar/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,6 @@ export type AvatarProps = Pick<AccessibilityProps, 'accessibilityLabel'> & {
*/
testID?: string;
};
export type AvatarPropTypes = AvatarProps; //TODO: remove after ComponentPropTypes deprecation;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove from generatedTypes


/**
* @description: Avatar component for displaying user profile images
Expand Down
2 changes: 0 additions & 2 deletions src/components/button/ButtonTypes.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -142,8 +142,6 @@ export type ButtonProps = TouchableOpacityProps &
animateTo?: ButtonAnimationDirection;
};

export type ButtonPropTypes = ButtonProps; //TODO: remove after ComponentPropTypes deprecation;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove from generatedTypes


export type ButtonState = {
size?: number;
borderRadius?: number;
Expand Down
4 changes: 2 additions & 2 deletions src/components/button/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ import TouchableOpacity from '../touchableOpacity';
import Text from '../text';
import Image from '../image';

import {ButtonSize, ButtonAnimationDirection, ButtonProps, ButtonPropTypes, ButtonState, Props, DEFAULT_PROPS} from './ButtonTypes';
export {ButtonSize, ButtonAnimationDirection, ButtonProps, ButtonPropTypes};
import {ButtonSize, ButtonAnimationDirection, ButtonProps, ButtonState, Props, DEFAULT_PROPS} from './ButtonTypes';
export {ButtonSize, ButtonAnimationDirection, ButtonProps};

import {PADDINGS, HORIZONTAL_PADDINGS, MIN_WIDTH, DEFAULT_SIZE, DISABLED_COLOR} from './ButtonConstants';

Expand Down
1 change: 0 additions & 1 deletion src/components/card/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,6 @@ export type CardProps = ViewProps &
hideIndicator?: boolean;
};
};
export type CardPropTypes = CardProps; //TODO: remove after ComponentPropTypes deprecation;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove from generatedTypes


type PropTypes = BaseComponentInjectedProps &
ForwardRefInjectedProps &
Expand Down
1 change: 0 additions & 1 deletion src/components/checkbox/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,6 @@ export interface CheckboxProps extends TouchableOpacityProps {
*/
containerStyle?: StyleProp<ViewStyle>;
}
export type CheckboxPropTypes = CheckboxProps; //TODO: remove after ComponentPropTypes deprecation;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove from generatedTypes


interface CheckboxState {
isChecked: Animated.Value;
Expand Down
1 change: 0 additions & 1 deletion src/components/chip/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,6 @@ export type ChipProps = ViewProps & TouchableOpacityProps & {
*/
dismissContainerStyle?: StyleProp<ImageStyle>;
}
export type ChipPropTypes = ChipProps; //TODO: remove after ComponentPropTypes deprecation;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove from generatedTypes


const DEFAULT_SIZE = 26;

Expand Down
Loading