ant-design/components/config-provider/index.tsx
Map1en_ 8f3f0076de
fix: ConfigProvider rerender unexpectedly when switching some language (#31630)
* fix: ConfigProvide could not maintain the state of components when switching some lang

close #31592

* chore: add test case

* Update components/config-provider/index.tsx

Co-authored-by: afc163 <afc163@gmail.com>

* chore: fix checks

Co-authored-by: afc163 <afc163@gmail.com>
2021-08-04 13:45:35 +08:00

272 lines
7.0 KiB
TypeScript

import * as React from 'react';
import IconContext from '@ant-design/icons/lib/components/Context';
import { FormProvider as RcFormProvider } from 'rc-field-form';
import { ValidateMessages } from 'rc-field-form/lib/interface';
import useMemo from 'rc-util/lib/hooks/useMemo';
import { RenderEmptyHandler } from './renderEmpty';
import LocaleProvider, { ANT_MARK, Locale } from '../locale-provider';
import LocaleReceiver from '../locale-provider/LocaleReceiver';
import {
ConfigConsumer,
ConfigContext,
CSPConfig,
DirectionType,
ConfigConsumerProps,
} from './context';
import SizeContext, { SizeContextProvider, SizeType } from './SizeContext';
import message from '../message';
import notification from '../notification';
import { RequiredMark } from '../form/Form';
import defaultLocale from '../locale/default';
export {
RenderEmptyHandler,
ConfigContext,
ConfigConsumer,
CSPConfig,
DirectionType,
ConfigConsumerProps,
};
export const configConsumerProps = [
'getTargetContainer',
'getPopupContainer',
'rootPrefixCls',
'getPrefixCls',
'renderEmpty',
'csp',
'autoInsertSpaceInButton',
'locale',
'pageHeader',
];
// These props is used by `useContext` directly in sub component
const PASSED_PROPS: Exclude<keyof ConfigConsumerProps, 'rootPrefixCls' | 'getPrefixCls'>[] = [
'getTargetContainer',
'getPopupContainer',
'renderEmpty',
'pageHeader',
'input',
'form',
];
export interface ConfigProviderProps {
getTargetContainer?: () => HTMLElement;
getPopupContainer?: (triggerNode: HTMLElement) => HTMLElement;
prefixCls?: string;
iconPrefixCls?: string;
children?: React.ReactNode;
renderEmpty?: RenderEmptyHandler;
csp?: CSPConfig;
autoInsertSpaceInButton?: boolean;
form?: {
validateMessages?: ValidateMessages;
requiredMark?: RequiredMark;
};
input?: {
autoComplete?: string;
};
locale?: Locale;
pageHeader?: {
ghost: boolean;
};
componentSize?: SizeType;
direction?: DirectionType;
space?: {
size?: SizeType | number;
};
virtual?: boolean;
dropdownMatchSelectWidth?: boolean;
}
interface ProviderChildrenProps extends ConfigProviderProps {
parentContext: ConfigConsumerProps;
legacyLocale: Locale;
}
export const defaultPrefixCls = 'ant';
let globalPrefixCls: string;
const setGlobalConfig = (params: Pick<ConfigProviderProps, 'prefixCls'>) => {
if (params.prefixCls !== undefined) {
globalPrefixCls = params.prefixCls;
}
};
function getGlobalPrefixCls() {
return globalPrefixCls || defaultPrefixCls;
}
export const globalConfig = () => ({
getPrefixCls: (suffixCls?: string, customizePrefixCls?: string) => {
if (customizePrefixCls) return customizePrefixCls;
return suffixCls ? `${getGlobalPrefixCls()}-${suffixCls}` : getGlobalPrefixCls();
},
getRootPrefixCls: (rootPrefixCls?: string, customizePrefixCls?: string) => {
// Customize rootPrefixCls is first priority
if (rootPrefixCls) {
return rootPrefixCls;
}
// If Global prefixCls provided, use this
if (globalPrefixCls) {
return globalPrefixCls;
}
// [Legacy] If customize prefixCls provided, we cut it to get the prefixCls
if (customizePrefixCls && customizePrefixCls.includes('-')) {
return customizePrefixCls.replace(/^(.*)-[^-]*$/, '$1');
}
// Fallback to default prefixCls
return getGlobalPrefixCls();
},
});
const ProviderChildren: React.FC<ProviderChildrenProps> = props => {
const {
children,
csp,
autoInsertSpaceInButton,
form,
locale,
componentSize,
direction,
space,
virtual,
dropdownMatchSelectWidth,
legacyLocale,
parentContext,
iconPrefixCls,
} = props;
const getPrefixCls = React.useCallback(
(suffixCls: string, customizePrefixCls?: string) => {
const { prefixCls } = props;
if (customizePrefixCls) return customizePrefixCls;
const mergedPrefixCls = prefixCls || parentContext.getPrefixCls('');
return suffixCls ? `${mergedPrefixCls}-${suffixCls}` : mergedPrefixCls;
},
[parentContext.getPrefixCls, props.prefixCls],
);
const config = {
...parentContext,
csp,
autoInsertSpaceInButton,
locale: locale || legacyLocale,
direction,
space,
virtual,
dropdownMatchSelectWidth,
getPrefixCls,
};
// Pass the props used by `useContext` directly with child component.
// These props should merged into `config`.
PASSED_PROPS.forEach(propName => {
const propValue: any = props[propName];
if (propValue) {
(config as any)[propName] = propValue;
}
});
// https://github.com/ant-design/ant-design/issues/27617
const memoedConfig = useMemo(
() => config,
config,
(prevConfig: Record<string, any>, currentConfig) => {
const prevKeys = Object.keys(prevConfig);
const currentKeys = Object.keys(currentConfig);
return (
prevKeys.length !== currentKeys.length ||
prevKeys.some(key => prevConfig[key] !== currentConfig[key])
);
},
);
const memoIconContextValue = React.useMemo(
() => ({ prefixCls: iconPrefixCls, csp }),
[iconPrefixCls],
);
let childNode = children;
// Additional Form provider
let validateMessages: ValidateMessages = {};
if (locale) {
validateMessages =
locale.Form?.defaultValidateMessages || defaultLocale.Form?.defaultValidateMessages || {};
}
if (form && form.validateMessages) {
validateMessages = { ...validateMessages, ...form.validateMessages };
}
if (Object.keys(validateMessages).length > 0) {
childNode = <RcFormProvider validateMessages={validateMessages}>{children}</RcFormProvider>;
}
if (locale) {
childNode = (
<LocaleProvider locale={locale} _ANT_MARK__={ANT_MARK}>
{childNode}
</LocaleProvider>
);
}
if (iconPrefixCls) {
childNode = (
<IconContext.Provider value={memoIconContextValue}>{childNode}</IconContext.Provider>
);
}
if (componentSize) {
childNode = <SizeContextProvider size={componentSize}>{childNode}</SizeContextProvider>;
}
return <ConfigContext.Provider value={memoedConfig}>{childNode}</ConfigContext.Provider>;
};
const ConfigProvider: React.FC<ConfigProviderProps> & {
ConfigContext: typeof ConfigContext;
SizeContext: typeof SizeContext;
config: typeof setGlobalConfig;
} = props => {
React.useEffect(() => {
if (props.direction) {
message.config({
rtl: props.direction === 'rtl',
});
notification.config({
rtl: props.direction === 'rtl',
});
}
}, [props.direction]);
return (
<LocaleReceiver>
{(_, __, legacyLocale) => (
<ConfigConsumer>
{context => (
<ProviderChildren
parentContext={context}
legacyLocale={legacyLocale as Locale}
{...props}
/>
)}
</ConfigConsumer>
)}
</LocaleReceiver>
);
};
/** @private internal Usage. do not use in your production */
ConfigProvider.ConfigContext = ConfigContext;
ConfigProvider.SizeContext = SizeContext;
ConfigProvider.config = setGlobalConfig;
export default ConfigProvider;