Skip to content
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

Convert OverlayTrigger to an arrow function to fix type issues #6709

Merged
merged 2 commits into from Oct 21, 2023
Merged

Convert OverlayTrigger to an arrow function to fix type issues #6709

merged 2 commits into from Oct 21, 2023

Conversation

snstanton
Copy link
Contributor

Fixes #6708

@kyletsang
Copy link
Member

OverlayTrigger is the only component that exports the propTypes in the d.ts file. Using a React.FC type here stops that from being emitted. Perhaps we should use that as well?

@snstanton
Copy link
Contributor Author

I've added the React.FC type and fixed up various type mismatches between the propTypes and the interface.

@kyletsang
Copy link
Member

Before:

import PropTypes from 'prop-types';
import * as React from 'react';
import { OverlayChildren, OverlayProps } from './Overlay';
export type OverlayTriggerType = 'hover' | 'click' | 'focus';
export type OverlayDelay = number | {
    show: number;
    hide: number;
};
export type OverlayInjectedProps = {
    onFocus?: (...args: any[]) => any;
};
export type OverlayTriggerRenderProps = OverlayInjectedProps & {
    ref: React.Ref<any>;
};
export interface OverlayTriggerProps extends Omit<OverlayProps, 'children' | 'target'> {
    children: React.ReactElement | ((props: OverlayTriggerRenderProps) => React.ReactNode);
    trigger?: OverlayTriggerType | OverlayTriggerType[];
    delay?: OverlayDelay;
    show?: boolean;
    defaultShow?: boolean;
    onToggle?: (nextShow: boolean) => void;
    flip?: boolean;
    overlay: OverlayChildren;
    target?: never;
    onHide?: never;
}
declare function OverlayTrigger({ trigger, overlay, children, popperConfig, show: propsShow, defaultShow, onToggle, delay: propsDelay, placement, flip, ...props }: OverlayTriggerProps): JSX.Element;
declare namespace OverlayTrigger {
    var propTypes: {
        children: PropTypes.Validator<NonNullable<NonNullable<((...args: any[]) => any) | PropTypes.ReactElementLike | null | undefined>>>;
        /**
         * Specify which action or actions trigger Overlay visibility
         *
         * The `click` trigger ignores the configured `delay`.
         *
         * @type {'hover' | 'click' |'focus' | Array<'hover' | 'click' |'focus'>}
         */
        trigger: PropTypes.Requireable<NonNullable<string | (string | null | undefined)[] | null | undefined>>;
        /**
         * A millisecond delay amount to show and hide the Overlay once triggered
         */
        delay: PropTypes.Requireable<NonNullable<number | PropTypes.InferProps<{
            show: PropTypes.Requireable<number>;
            hide: PropTypes.Requireable<number>;
        }> | null | undefined>>;
        /**
         * The visibility of the Overlay. `show` is a _controlled_ prop so should be paired
         * with `onToggle` to avoid breaking user interactions.
         *
         * Manually toggling `show` does **not** wait for `delay` to change the visibility.
         *
         * @controllable onToggle
         */
        show: PropTypes.Requireable<boolean>;
        /**
         * The initial visibility state of the Overlay.
         */
        defaultShow: PropTypes.Requireable<boolean>;
        /**
         * A callback that fires when the user triggers a change in tooltip visibility.
         *
         * `onToggle` is called with the desired next `show`, and generally should be passed
         * back to the `show` prop. `onToggle` fires _after_ the configured `delay`
         *
         * @controllable `show`
         */
        onToggle: PropTypes.Requireable<(...args: any[]) => any>;
        /**
          The initial flip state of the Overlay.
         */
        flip: PropTypes.Requireable<boolean>;
        /**
         * An element or text to overlay next to the target.
         */
        overlay: PropTypes.Requireable<NonNullable<((...args: any[]) => any) | PropTypes.ReactElementLike | null | undefined>>;
        /**
         * A Popper.js config object passed to the the underlying popper instance.
         */
        popperConfig: PropTypes.Requireable<object>;
        /**
         * @private
         */
        target: PropTypes.Requireable<null>;
        /**
         * @private
         */
        onHide: PropTypes.Requireable<null>;
        /**
         * The placement of the Overlay in relation to it's `target`.
         */
        placement: PropTypes.Requireable<string>;
    };
}
export default OverlayTrigger;

After:

import * as React from 'react';
import { OverlayChildren, OverlayProps } from './Overlay';
import { Placement } from './types';
export type OverlayTriggerType = 'hover' | 'click' | 'focus';
export type OverlayDelay = number | {
    show: number;
    hide: number;
};
export type OverlayInjectedProps = {
    onFocus?: (...args: any[]) => any;
};
export type OverlayTriggerRenderProps = OverlayInjectedProps & {
    ref: React.Ref<any>;
};
export interface OverlayTriggerProps extends Omit<OverlayProps, 'children' | 'target'> {
    children: React.ReactElement | ((props: OverlayTriggerRenderProps) => React.ReactNode);
    trigger?: OverlayTriggerType | OverlayTriggerType[];
    delay?: OverlayDelay;
    show?: boolean;
    defaultShow?: boolean;
    onToggle?: (nextShow: boolean) => void;
    flip?: boolean;
    overlay: OverlayChildren;
    target?: never;
    onHide?: never;
    placement?: Placement;
}
declare const OverlayTrigger: React.FC<OverlayTriggerProps>;
export default OverlayTrigger;

@kyletsang kyletsang merged commit 4e609e2 into react-bootstrap:master Oct 21, 2023
12 checks passed
@kyletsang
Copy link
Member

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

OverlayTrigger namespace propTypes does not match the OverlayTriggerProps interface
2 participants