Skip to content

Fix broken example screens links #1146

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 24, 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
2 changes: 1 addition & 1 deletion generatedTypes/components/actionBar/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { ButtonProps } from '../button';
* @description: Quick actions bar, each action support Button component props
* @modifiers: margin, padding
* @gif: https://media.giphy.com/media/xULW8DwxkniFDMw7TO/giphy.gif
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ActionBarScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ActionBarScreen.tsx
*/
export declare type ActionBarProps = {
/**
Expand Down
2 changes: 1 addition & 1 deletion generatedTypes/components/avatar/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ export declare type AvatarPropTypes = AvatarProps;
* @extendsnotes: (when passing onPress)
* @extendslink: docs/TouchableOpacity
* @image: https://user-images.githubusercontent.com/33805983/34480603-197d7f64-efb6-11e7-9feb-db8ba756f055.png
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/AvatarsScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/AvatarsScreen.tsx
*/
declare class Avatar extends PureComponent<AvatarProps> {
styles: ReturnType<typeof createStyles>;
Expand Down
2 changes: 1 addition & 1 deletion generatedTypes/components/badge/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ export declare type BadgeProps = ViewProps & TouchableOpacityProps & {
* @extends: Animatable.View
* @extendslink: https://github.com/oblador/react-native-animatable
* @image: https://user-images.githubusercontent.com/33805983/34480753-df7a868a-efb6-11e7-9072-80f5c110a4f3.png
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/BadgesScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/BadgesScreen.tsx
*/
declare class Badge extends PureComponent<BadgeProps> {
styles: ReturnType<typeof createStyles>;
Expand Down
2 changes: 1 addition & 1 deletion generatedTypes/components/carousel/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ declare type DefaultProps = Partial<CarouselProps>;
/**
* @description: Carousel for scrolling pages horizontally
* @gif: https://media.giphy.com/media/l0HU7f8gjpRlMRhKw/giphy.gif, https://media.giphy.com/media/3oFzmcjX9OhpyckhcQ/giphy.gif
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/CarouselScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/CarouselScreen.tsx
* @extends: ScrollView
* @extendsLink: https://facebook.github.io/react-native/docs/scrollview
* @notes: This is screed width Component
Expand Down
2 changes: 1 addition & 1 deletion generatedTypes/components/modal/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export interface ModalProps extends RNModalProps {
* @extends: Modal
* @extendslink: https://facebook.github.io/react-native/docs/modal.html
* @gif: https://media.giphy.com/media/3oFzmfSX8KgvctI4Ks/giphy.gif
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ModalScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ModalScreen.tsx
*/
declare class Modal extends Component<ModalProps> {
static displayName: string;
Expand Down
2 changes: 1 addition & 1 deletion generatedTypes/components/tabController/PageCarousel.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import _ from 'lodash';
import Animated from 'react-native-reanimated';
/**
* @description: TabController's Page Carousel
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TabControllerScreen/index.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TabControllerScreen/index.tsx
* @notes: You must pass `asCarousel` flag to TabController and render your TabPages inside a PageCarousel
*/
declare class PageCarousel extends PureComponent {
Expand Down
2 changes: 1 addition & 1 deletion generatedTypes/components/tabController/TabBarItem.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ interface Props extends TabControllerItemProps {
}
/**
* @description: TabController's TabBarItem
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TabControllerScreen/index.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TabControllerScreen/index.tsx
* @notes: Must be rendered as a direct child of TabController.TabBar.
*/
export default class TabBarItem extends PureComponent<Props> {
Expand Down
2 changes: 1 addition & 1 deletion generatedTypes/components/tabController/TabPage.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export interface TabControllerPageProps {
}
/**
* @description: TabController's TabPage
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TabControllerScreen/index.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TabControllerScreen/index.tsx
*/
export default class TabPage extends PureComponent<TabControllerPageProps> {
static displayName: string;
Expand Down
2 changes: 1 addition & 1 deletion generatedTypes/components/tabController/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ interface StateProps {
}
/**
* @description: A performant solution for a tab controller with lazy load mechanism
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TabControllerScreen/index.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TabControllerScreen/index.tsx
* @notes: This component is based on react-native-gesture-handler
* @important: On Android, if using react-native-navigation, make sure to wrap your screen with gestureHandlerRootHOC
* @importantLink: https://kmagiera.github.io/react-native-gesture-handler/docs/getting-started.html#with-wix-react-native-navigation-https-githubcom-wix-react-native-navigation
Expand Down
2 changes: 1 addition & 1 deletion src/components/actionBar/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import Button, {ButtonProps} from '../button';
* @description: Quick actions bar, each action support Button component props
* @modifiers: margin, padding
* @gif: https://media.giphy.com/media/xULW8DwxkniFDMw7TO/giphy.gif
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ActionBarScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ActionBarScreen.tsx
*/

export type ActionBarProps = {
Expand Down
2 changes: 1 addition & 1 deletion src/components/avatar/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ export type AvatarPropTypes = AvatarProps; //TODO: remove after ComponentPropTyp
* @extendsnotes: (when passing onPress)
* @extendslink: docs/TouchableOpacity
* @image: https://user-images.githubusercontent.com/33805983/34480603-197d7f64-efb6-11e7-9feb-db8ba756f055.png
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/AvatarsScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/AvatarsScreen.tsx
*/
class Avatar extends PureComponent<AvatarProps> {
styles: ReturnType<typeof createStyles>;
Expand Down
2 changes: 1 addition & 1 deletion src/components/badge/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ export type BadgeProps = ViewProps &
* @extends: Animatable.View
* @extendslink: https://github.com/oblador/react-native-animatable
* @image: https://user-images.githubusercontent.com/33805983/34480753-df7a868a-efb6-11e7-9072-80f5c110a4f3.png
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/BadgesScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/BadgesScreen.tsx
*/
class Badge extends PureComponent<BadgeProps> {
styles: ReturnType<typeof createStyles>;
Expand Down
2 changes: 1 addition & 1 deletion src/components/card/CardImage.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ type Props = CardImageProps & asCardChildProps;

/**
* @description: Card.Image, part of the Card component belongs inside a Card (better be a direct child)
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/CardsScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/CardsScreen.tsx
*/
class CardImage extends PureComponent<Props> {
static displayName = 'Card.Image';
Expand Down
2 changes: 1 addition & 1 deletion src/components/card/CardSection.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ type Props = CardSectionProps & asCardChildProps;

/**
* @description: Card.Section for rendering content easily inside a card
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/CardsScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/CardsScreen.tsx
*/
class CardSection extends PureComponent<Props> {
static displayName = 'Card.Section';
Expand Down
2 changes: 1 addition & 1 deletion src/components/card/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ type State = {
* @extendslink: docs/TouchableOpacity
* @modifiers: margin, padding
* @gif: https://media.giphy.com/media/l0HU9SKWmv0VTOYMM/giphy.gif
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/CardsScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/CardsScreen.tsx
*/
class Card extends PureComponent<PropTypes, State> {
static displayName = 'Card';
Expand Down
2 changes: 1 addition & 1 deletion src/components/carousel/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ type DefaultProps = Partial<CarouselProps>
/**
* @description: Carousel for scrolling pages horizontally
* @gif: https://media.giphy.com/media/l0HU7f8gjpRlMRhKw/giphy.gif, https://media.giphy.com/media/3oFzmcjX9OhpyckhcQ/giphy.gif
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/CarouselScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/CarouselScreen.tsx
* @extends: ScrollView
* @extendsLink: https://facebook.github.io/react-native/docs/scrollview
* @notes: This is screed width Component
Expand Down
2 changes: 1 addition & 1 deletion src/components/floatingButton/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ const gradientImage = () => require('./gradient.png');
/**
* @description: Hovering button with gradient background
* @modifiers: margin, background, color
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/FloatingButtonScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/FloatingButtonScreen.tsx
* @extends: Button
* @extendsLink: https://github.com/wix/react-native-ui-lib/blob/master/src/components/button/index.js
*/
Expand Down
2 changes: 1 addition & 1 deletion src/components/modal/TopBar.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ const DEFAULT_BUTTON_PROPS = {

/**
* @description: Modal.TopBar, inner component for configuring the Modal component's title, buttons and statusBar
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ModalScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ModalScreen.tsx
*/
class TopBar extends Component<ModalTopBarProps> {
static displayName = 'Modal.TopBar';
Expand Down
2 changes: 1 addition & 1 deletion src/components/modal/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ export interface ModalProps extends RNModalProps {
* @extends: Modal
* @extendslink: https://facebook.github.io/react-native/docs/modal.html
* @gif: https://media.giphy.com/media/3oFzmfSX8KgvctI4Ks/giphy.gif
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ModalScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ModalScreen.tsx
*/
class Modal extends Component<ModalProps> {
static displayName = 'Modal';
Expand Down
2 changes: 1 addition & 1 deletion src/components/pageControl/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ interface State {
/**
* @description: Page indicator, typically used in paged scroll-views
* @image: https://user-images.githubusercontent.com/33805983/34663655-76698110-f460-11e7-854b-243d27f66fec.png
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/PageControlScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/PageControlScreen.tsx
*/
class PageControl extends PureComponent<PageControlProps, State> {
static displayName = 'PageControl';
Expand Down
2 changes: 1 addition & 1 deletion src/components/panningViews/panListenerView.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ const DEFAULT_SWIPE_VELOCITY = 1.8;

/**
* @description: PanListenerView component created to making listening to swipe and drag events easier
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/PanListenerScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/PanListenerScreen.tsx
*/
class PanListenerView extends PureComponent<Props> {
static displayName = 'PanListenerView';
Expand Down
2 changes: 1 addition & 1 deletion src/components/panningViews/panResponderView.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ interface Props extends PanResponderViewProps {
* @description: panResponderView component created to making listening to swipe and drag events easier.
* @notes: Has to be used as a child of a PanningProvider that also has a PanListenerView.
* The PanListenerView is the one that sends the drag\swipe events.
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/PanResponderScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/PanResponderScreen.tsx
*/
class PanResponderView extends PureComponent<Props> {
static displayName = 'PanResponderView';
Expand Down
2 changes: 1 addition & 1 deletion src/components/tabController/PageCarousel.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ const {Code, block, call} = Animated;

/**
* @description: TabController's Page Carousel
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TabControllerScreen/index.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TabControllerScreen/index.tsx
* @notes: You must pass `asCarousel` flag to TabController and render your TabPages inside a PageCarousel
*/
class PageCarousel extends PureComponent {
Expand Down
2 changes: 1 addition & 1 deletion src/components/tabController/TabBar.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ interface Props extends TabControllerBarProps, BaseComponentInjectedProps, Forwa

/**
* @description: TabController's TabBar component
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TabControllerScreen/index.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TabControllerScreen/index.tsx
*/
const TabBar = (props: Props) => {
const {
Expand Down
2 changes: 1 addition & 1 deletion src/components/tabController/TabBarItem.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ interface Props extends TabControllerItemProps {

/**
* @description: TabController's TabBarItem
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TabControllerScreen/index.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TabControllerScreen/index.tsx
* @notes: Must be rendered as a direct child of TabController.TabBar.
*/
export default class TabBarItem extends PureComponent<Props> {
Expand Down
2 changes: 1 addition & 1 deletion src/components/tabController/TabPage.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export interface TabControllerPageProps {

/**
* @description: TabController's TabPage
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TabControllerScreen/index.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TabControllerScreen/index.tsx
*/
export default class TabPage extends PureComponent<TabControllerPageProps> {
static displayName = 'TabController.TabPage';
Expand Down
2 changes: 1 addition & 1 deletion src/components/tabController/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ interface StateProps {

/**
* @description: A performant solution for a tab controller with lazy load mechanism
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TabControllerScreen/index.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TabControllerScreen/index.tsx
* @notes: This component is based on react-native-gesture-handler
* @important: On Android, if using react-native-navigation, make sure to wrap your screen with gestureHandlerRootHOC
* @importantLink: https://kmagiera.github.io/react-native-gesture-handler/docs/getting-started.html#with-wix-react-native-navigation-https-githubcom-wix-react-native-navigation
Expand Down