mirror of
https://gitee.com/ant-design/ant-design.git
synced 2024-12-06 05:58:46 +08:00
2e0942ab26
* refactor: cssVarCls * refactor: update * chore: update * fix: cascader & tree-select * fix: ribbon
200 lines
5.7 KiB
TypeScript
200 lines
5.7 KiB
TypeScript
import * as React from 'react';
|
|
import classNames from 'classnames';
|
|
|
|
import type { Breakpoint, ScreenMap } from '../_util/responsiveObserver';
|
|
import useResponsiveObserver, { responsiveArray } from '../_util/responsiveObserver';
|
|
import { ConfigContext } from '../config-provider';
|
|
import RowContext from './RowContext';
|
|
import type { RowContextState } from './RowContext';
|
|
import { useRowStyle } from './style';
|
|
|
|
const RowAligns = ['top', 'middle', 'bottom', 'stretch'] as const;
|
|
const RowJustify = [
|
|
'start',
|
|
'end',
|
|
'center',
|
|
'space-around',
|
|
'space-between',
|
|
'space-evenly',
|
|
] as const;
|
|
|
|
type Responsive = 'xxl' | 'xl' | 'lg' | 'md' | 'sm' | 'xs';
|
|
type ResponsiveLike<T> = {
|
|
[key in Responsive]?: T;
|
|
};
|
|
|
|
type Gap = number | undefined;
|
|
export type Gutter = number | undefined | Partial<Record<Breakpoint, number>>;
|
|
|
|
type ResponsiveAligns = ResponsiveLike<(typeof RowAligns)[number]>;
|
|
type ResponsiveJustify = ResponsiveLike<(typeof RowJustify)[number]>;
|
|
export interface RowProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
gutter?: Gutter | [Gutter, Gutter];
|
|
align?: (typeof RowAligns)[number] | ResponsiveAligns;
|
|
justify?: (typeof RowJustify)[number] | ResponsiveJustify;
|
|
prefixCls?: string;
|
|
wrap?: boolean;
|
|
}
|
|
|
|
function useMergePropByScreen(oriProp: RowProps['align'] | RowProps['justify'], screen: ScreenMap) {
|
|
const [prop, setProp] = React.useState(typeof oriProp === 'string' ? oriProp : '');
|
|
|
|
const calcMergeAlignOrJustify = () => {
|
|
if (typeof oriProp === 'string') {
|
|
setProp(oriProp);
|
|
}
|
|
if (typeof oriProp !== 'object') {
|
|
return;
|
|
}
|
|
for (let i = 0; i < responsiveArray.length; i++) {
|
|
const breakpoint: Breakpoint = responsiveArray[i];
|
|
// if do not match, do nothing
|
|
if (!screen[breakpoint]) {
|
|
continue;
|
|
}
|
|
const curVal = oriProp[breakpoint];
|
|
if (curVal !== undefined) {
|
|
setProp(curVal);
|
|
return;
|
|
}
|
|
}
|
|
};
|
|
|
|
React.useEffect(() => {
|
|
calcMergeAlignOrJustify();
|
|
}, [JSON.stringify(oriProp), screen]);
|
|
|
|
return prop;
|
|
}
|
|
|
|
const Row = React.forwardRef<HTMLDivElement, RowProps>((props, ref) => {
|
|
const {
|
|
prefixCls: customizePrefixCls,
|
|
justify,
|
|
align,
|
|
className,
|
|
style,
|
|
children,
|
|
gutter = 0,
|
|
wrap,
|
|
...others
|
|
} = props;
|
|
|
|
const { getPrefixCls, direction } = React.useContext(ConfigContext);
|
|
|
|
const [screens, setScreens] = React.useState<ScreenMap>({
|
|
xs: true,
|
|
sm: true,
|
|
md: true,
|
|
lg: true,
|
|
xl: true,
|
|
xxl: true,
|
|
});
|
|
// to save screens info when responsiveObserve callback had been call
|
|
const [curScreens, setCurScreens] = React.useState<ScreenMap>({
|
|
xs: false,
|
|
sm: false,
|
|
md: false,
|
|
lg: false,
|
|
xl: false,
|
|
xxl: false,
|
|
});
|
|
|
|
// ================================== calc responsive data ==================================
|
|
const mergeAlign = useMergePropByScreen(align, curScreens);
|
|
|
|
const mergeJustify = useMergePropByScreen(justify, curScreens);
|
|
|
|
const gutterRef = React.useRef<Gutter | [Gutter, Gutter]>(gutter);
|
|
|
|
const responsiveObserver = useResponsiveObserver();
|
|
|
|
// ================================== Effect ==================================
|
|
React.useEffect(() => {
|
|
const token = responsiveObserver.subscribe((screen) => {
|
|
setCurScreens(screen);
|
|
const currentGutter = gutterRef.current || 0;
|
|
if (
|
|
(!Array.isArray(currentGutter) && typeof currentGutter === 'object') ||
|
|
(Array.isArray(currentGutter) &&
|
|
(typeof currentGutter[0] === 'object' || typeof currentGutter[1] === 'object'))
|
|
) {
|
|
setScreens(screen);
|
|
}
|
|
});
|
|
return () => responsiveObserver.unsubscribe(token);
|
|
}, []);
|
|
|
|
// ================================== Render ==================================
|
|
const getGutter = (): [Gap, Gap] => {
|
|
const results: [Gap, Gap] = [undefined, undefined];
|
|
const normalizedGutter = Array.isArray(gutter) ? gutter : [gutter, undefined];
|
|
normalizedGutter.forEach((g, index) => {
|
|
if (typeof g === 'object') {
|
|
for (let i = 0; i < responsiveArray.length; i++) {
|
|
const breakpoint: Breakpoint = responsiveArray[i];
|
|
if (screens[breakpoint] && g[breakpoint] !== undefined) {
|
|
results[index] = g[breakpoint] as number;
|
|
break;
|
|
}
|
|
}
|
|
} else {
|
|
results[index] = g;
|
|
}
|
|
});
|
|
return results;
|
|
};
|
|
|
|
const prefixCls = getPrefixCls('row', customizePrefixCls);
|
|
|
|
const [wrapCSSVar, hashId, cssVarCls] = useRowStyle(prefixCls);
|
|
|
|
const gutters = getGutter();
|
|
const classes = classNames(
|
|
prefixCls,
|
|
{
|
|
[`${prefixCls}-no-wrap`]: wrap === false,
|
|
[`${prefixCls}-${mergeJustify}`]: mergeJustify,
|
|
[`${prefixCls}-${mergeAlign}`]: mergeAlign,
|
|
[`${prefixCls}-rtl`]: direction === 'rtl',
|
|
},
|
|
className,
|
|
hashId,
|
|
cssVarCls,
|
|
);
|
|
|
|
// Add gutter related style
|
|
const rowStyle: React.CSSProperties = {};
|
|
const horizontalGutter = gutters[0] != null && gutters[0] > 0 ? gutters[0] / -2 : undefined;
|
|
|
|
if (horizontalGutter) {
|
|
rowStyle.marginLeft = horizontalGutter;
|
|
rowStyle.marginRight = horizontalGutter;
|
|
}
|
|
|
|
[, rowStyle.rowGap] = gutters;
|
|
|
|
// "gutters" is a new array in each rendering phase, it'll make 'React.useMemo' effectless.
|
|
// So we deconstruct "gutters" variable here.
|
|
const [gutterH, gutterV] = gutters;
|
|
|
|
const rowContext = React.useMemo<RowContextState>(
|
|
() => ({ gutter: [gutterH, gutterV] as [number, number], wrap }),
|
|
[gutterH, gutterV, wrap],
|
|
);
|
|
|
|
return wrapCSSVar(
|
|
<RowContext.Provider value={rowContext}>
|
|
<div {...others} className={classes} style={{ ...rowStyle, ...style }} ref={ref}>
|
|
{children}
|
|
</div>
|
|
</RowContext.Provider>,
|
|
);
|
|
});
|
|
|
|
if (process.env.NODE_ENV !== 'production') {
|
|
Row.displayName = 'Row';
|
|
}
|
|
|
|
export default Row;
|