Skip to content

chore: update ts define #692

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.

Sign up for GitHub

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 1 commit into from
Dec 21, 2021
Merged

chore: update ts define #692

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
67 changes: 27 additions & 40 deletions src/Select.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,50 +133,36 @@ export interface SharedSelectProps<OptionType extends BaseOptionType = DefaultOp
menuItemSelectedIcon?: RenderNode;
}

export interface SingleRawSelectProps<OptionType extends BaseOptionType = DefaultOptionType>
extends SharedSelectProps<OptionType> {
export interface SingleSelectProps<
ValueType = any,
OptionType extends BaseOptionType = DefaultOptionType,
> extends SharedSelectProps<OptionType> {
mode?: 'combobox';
labelInValue?: false;
value?: RawValueType | null;
defaultValue?: RawValueType | null;
onChange?: (value: RawValueType, option: OptionType) => void;
labelInValue?: boolean;
value?: ValueType | null;
defaultValue?: ValueType | null;
onChange?: (value: ValueType, option: OptionType) => void;
}

export interface SingleLabeledSelectProps<OptionType extends BaseOptionType = DefaultOptionType>
extends SharedSelectProps<OptionType> {
mode?: 'combobox';
labelInValue: true;
value?: LabelInValueType | null;
defaultValue?: LabelInValueType | null;
onChange?: (value: LabelInValueType, option: OptionType) => void;
}

export interface MultipleRawSelectProps<OptionType extends BaseOptionType = DefaultOptionType>
extends SharedSelectProps<OptionType> {
export interface MultipleSelectProps<
ValueType = any[],
OptionType extends BaseOptionType = DefaultOptionType,
> extends SharedSelectProps<OptionType> {
mode: 'multiple' | 'tags';
labelInValue?: false;
value?: RawValueType[] | null;
defaultValue?: RawValueType[] | null;
onChange?: (value: RawValueType[], option: OptionType[]) => void;
labelInValue?: boolean;
value?: ValueType[] | null;
defaultValue?: ValueType[] | null;
onChange?: (value: ValueType[], option: OptionType[]) => void;
}

export interface MultipleLabeledSelectProps<OptionType extends BaseOptionType = DefaultOptionType>
extends SharedSelectProps<OptionType> {
mode: 'multiple' | 'tags';
labelInValue: true;
value?: LabelInValueType[] | null;
defaultValue?: LabelInValueType[] | null;
onChange?: (value: LabelInValueType[], option: OptionType[]) => void;
}
export type SelectProps<ValueType = any, OptionType extends BaseOptionType = DefaultOptionType> =
| SingleSelectProps<ValueType, OptionType>
| MultipleSelectProps<ValueType, OptionType>;

// TODO: Types test
export type SelectProps<OptionType extends BaseOptionType = DefaultOptionType> = Omit<
| SingleRawSelectProps<OptionType>
| SingleLabeledSelectProps<OptionType>
| MultipleRawSelectProps<OptionType>
| MultipleLabeledSelectProps<OptionType>,
'onChange'
> & {
export type InternalSelectProps<
ValueType = any,
OptionType extends BaseOptionType = DefaultOptionType,
> = Omit<SelectProps<ValueType, OptionType>, 'onChange'> & {
onChange?: (value: DraftValueType, option: OptionType | OptionType[]) => void;
};

Expand All @@ -185,7 +171,7 @@ function isRawValue(value: DraftValueType): value is RawValueType {
}

const Select = React.forwardRef(
(props: SelectProps<DefaultOptionType>, ref: React.Ref<BaseSelectRef>) => {
(props: InternalSelectProps<any, DefaultOptionType>, ref: React.Ref<BaseSelectRef>) => {
const {
id,
mode,
Expand Down Expand Up @@ -661,9 +647,10 @@ if (process.env.NODE_ENV !== 'production') {
}

const TypedSelect = Select as unknown as (<
Values extends BaseOptionType | DefaultOptionType = DefaultOptionType,
ValueType = any,
OptionType extends BaseOptionType | DefaultOptionType = DefaultOptionType,
>(
props: React.PropsWithChildren<SelectProps<Values>> & {
props: React.PropsWithChildren<SelectProps<ValueType, OptionType>> & {
ref?: React.Ref<BaseSelectRef>;
},
) => React.ReactElement) & {
Expand Down
10 changes: 7 additions & 3 deletions src/utils/warningPropsUtil.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
import * as React from 'react';
import warning, { noteOnce } from 'rc-util/lib/warning';
import toNodeArray from 'rc-util/lib/Children/toArray';
import type { SelectProps } from '..';
import { convertChildrenToData } from './legacyUtil';
import { toArray } from './commonUtil';
import type { RawValueType, LabelInValueType, BaseOptionType } from '../Select';
import type {
RawValueType,
LabelInValueType,
BaseOptionType,
InternalSelectProps,
} from '../Select';
import { isMultiple } from '../BaseSelect';

function warningProps(props: SelectProps) {
function warningProps(props: InternalSelectProps) {
const {
mode,
options,
Expand Down