antd
Version:
An enterprise-class UI design language and React components implementation
201 lines (200 loc) • 6.89 kB
JavaScript
"use client";
import * as React from 'react';
import { CSSMotionList } from '@rc-component/motion';
import ResizeObserver from '@rc-component/resize-observer';
import useLayoutEffect from "@rc-component/util/es/hooks/useLayoutEffect";
import isEqual from "@rc-component/util/es/isEqual";
import { composeRef } from "@rc-component/util/es/ref";
import { clsx } from 'clsx';
import { useMergeSemantic } from '../_util/hooks';
import { responsiveArray } from '../_util/responsiveObserver';
import { useComponentConfig } from '../config-provider/context';
import useCSSVarCls from '../config-provider/hooks/useCSSVarCls';
import useBreakpoint from '../grid/hooks/useBreakpoint';
import useGutter from '../grid/hooks/useGutter';
import useDelay from './hooks/useDelay';
import usePositions from './hooks/usePositions';
import useRefs from './hooks/useRefs';
import MasonryItem from './MasonryItem';
import useStyle from './style';
const Masonry = /*#__PURE__*/React.forwardRef((props, ref) => {
const {
rootClassName,
className,
style,
classNames,
styles,
columns,
prefixCls: customizePrefixCls,
gutter = 0,
items,
itemRender,
onLayoutChange,
fresh
} = props;
// ======================= MISC =======================
const {
getPrefixCls,
direction,
className: contextClassName,
style: contextStyle,
classNames: contextClassNames,
styles: contextStyles
} = useComponentConfig('masonry');
const prefixCls = getPrefixCls('masonry', customizePrefixCls);
const rootCls = useCSSVarCls(prefixCls);
const [hashId, cssVarCls] = useStyle(prefixCls, rootCls);
// ======================= Refs =======================
const containerRef = React.useRef(null);
React.useImperativeHandle(ref, () => ({
nativeElement: containerRef.current
}));
const [setItemRef, getItemRef] = useRefs();
// ======================= Item =======================
const [mergedItems, setMergedItems] = React.useState([]);
React.useEffect(() => {
setMergedItems(items || []);
}, [items]);
// ==================== Breakpoint ====================
const screens = useBreakpoint();
const gutters = useGutter(gutter, screens);
const [horizontalGutter = 0, verticalGutter = horizontalGutter] = gutters;
// ====================== Layout ======================
const columnCount = React.useMemo(() => {
if (!columns) {
return 3;
}
if (typeof columns === 'number') {
return columns;
}
// Find first matching responsive breakpoint
const matchingBreakpoint = responsiveArray.find(breakpoint => screens[breakpoint] && columns[breakpoint] !== undefined);
if (matchingBreakpoint) {
return columns[matchingBreakpoint];
}
return columns.xs ?? 1;
}, [columns, screens]);
// =========== Merged Props for Semantic ==========
const mergedProps = {
...props,
columns: columnCount
};
const [mergedClassNames, mergedStyles] = useMergeSemantic([contextClassNames, classNames], [contextStyles, styles], {
props: mergedProps
});
// ================== Items Position ==================
const [itemHeights, setItemHeights] = React.useState([]);
const collectItemSize = useDelay(() => {
const nextItemsHeight = mergedItems.map((item, index) => {
const itemKey = item.key ?? index;
const itemEle = getItemRef(itemKey);
const rect = itemEle?.getBoundingClientRect();
return [itemKey, rect ? rect.height : 0, item.column];
});
setItemHeights(prevItemsHeight => isEqual(prevItemsHeight, nextItemsHeight) ? prevItemsHeight : nextItemsHeight);
});
const [itemPositions, totalHeight] = usePositions(itemHeights, columnCount, verticalGutter);
const itemWithPositions = React.useMemo(() => mergedItems.map((item, index) => {
const key = item.key ?? index;
return {
item,
itemIndex: index,
// CSSMotion will transform key to string.
// Let's keep the original key here.
itemKey: key,
key,
position: itemPositions.get(key)
};
}), [mergedItems, itemPositions]);
React.useEffect(() => {
collectItemSize();
}, [mergedItems, columnCount]);
// Trigger for `onLayoutChange`
const [itemColumns, setItemColumns] = React.useState([]);
useLayoutEffect(() => {
if (onLayoutChange && itemWithPositions.every(({
position
}) => position)) {
setItemColumns(prevItemColumns => {
const nextItemColumns = itemWithPositions.map(({
item,
position
}) => [item, position.column]);
return isEqual(prevItemColumns, nextItemColumns) ? prevItemColumns : nextItemColumns;
});
}
}, [itemWithPositions]);
useLayoutEffect(() => {
if (onLayoutChange && items && items.length === itemColumns.length) {
onLayoutChange(itemColumns.map(([item, column]) => ({
...item,
column
})));
}
}, [itemColumns]);
// ====================== Render ======================
return /*#__PURE__*/React.createElement(ResizeObserver, {
onResize: collectItemSize
}, /*#__PURE__*/React.createElement("div", {
ref: containerRef,
className: clsx(prefixCls, contextClassName, mergedClassNames.root, rootClassName, className, hashId, cssVarCls, {
[`${prefixCls}-rtl`]: direction === 'rtl'
}),
style: {
height: totalHeight,
...mergedStyles.root,
...contextStyle,
...style
},
// Listen for image events
onLoad: collectItemSize,
onError: collectItemSize
}, /*#__PURE__*/React.createElement(CSSMotionList, {
keys: itemWithPositions,
component: false,
// Motion config
motionAppear: true,
motionLeave: true,
motionName: `${prefixCls}-item-fade`
}, (motionInfo, motionRef) => {
const {
item,
itemKey,
position = {},
itemIndex,
key,
className: motionClassName,
style: motionStyle
} = motionInfo;
const {
column: columnIndex = 0
} = position;
const itemStyle = {
'--item-width': `calc((100% + ${horizontalGutter}px) / ${columnCount})`,
insetInlineStart: `calc(var(--item-width) * ${columnIndex})`,
width: `calc(var(--item-width) - ${horizontalGutter}px)`,
top: position.top,
position: 'absolute'
};
return /*#__PURE__*/React.createElement(MasonryItem, {
prefixCls: prefixCls,
key: key,
item: item,
style: {
...motionStyle,
...mergedStyles.item,
...itemStyle
},
className: clsx(mergedClassNames.item, motionClassName),
ref: composeRef(motionRef, ele => setItemRef(itemKey, ele)),
index: itemIndex,
itemRender: itemRender,
column: columnIndex,
onResize: fresh ? collectItemSize : null
});
})));
});
if (process.env.NODE_ENV !== 'production') {
Masonry.displayName = 'Masonry';
}
export default Masonry;