Overflow.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307
  1. "use strict";
  2. var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
  3. Object.defineProperty(exports, "__esModule", {
  4. value: true
  5. });
  6. exports.default = void 0;
  7. var _vue = require("vue");
  8. var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
  9. var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
  10. var _vcResizeObserver = _interopRequireDefault(require("../vc-resize-observer"));
  11. var _classNames = _interopRequireDefault(require("../_util/classNames"));
  12. var _vueTypes = _interopRequireDefault(require("../_util/vue-types"));
  13. var _context = require("./context");
  14. var _Item = _interopRequireDefault(require("./Item"));
  15. var _RawItem = _interopRequireDefault(require("./RawItem"));
  16. var __rest = void 0 && (void 0).__rest || function (s, e) {
  17. var t = {};
  18. for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0) t[p] = s[p];
  19. if (s != null && typeof Object.getOwnPropertySymbols === "function") for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
  20. if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i])) t[p[i]] = s[p[i]];
  21. }
  22. return t;
  23. };
  24. const RESPONSIVE = 'responsive';
  25. const INVALIDATE = 'invalidate';
  26. function defaultRenderRest(omittedItems) {
  27. return `+ ${omittedItems.length} ...`;
  28. }
  29. const overflowProps = () => {
  30. return {
  31. id: String,
  32. prefixCls: String,
  33. data: Array,
  34. itemKey: [String, Number, Function],
  35. /** Used for `responsive`. It will limit render node to avoid perf issue */
  36. itemWidth: {
  37. type: Number,
  38. default: 10
  39. },
  40. renderItem: Function,
  41. /** @private Do not use in your production. Render raw node that need wrap Item by developer self */
  42. renderRawItem: Function,
  43. maxCount: [Number, String],
  44. renderRest: Function,
  45. /** @private Do not use in your production. Render raw node that need wrap Item by developer self */
  46. renderRawRest: Function,
  47. suffix: _vueTypes.default.any,
  48. component: String,
  49. itemComponent: _vueTypes.default.any,
  50. /** @private This API may be refactor since not well design */
  51. onVisibleChange: Function,
  52. /** When set to `full`, ssr will render full items by default and remove at client side */
  53. ssr: String,
  54. onMousedown: Function
  55. };
  56. };
  57. const Overflow = (0, _vue.defineComponent)({
  58. name: 'Overflow',
  59. inheritAttrs: false,
  60. props: overflowProps(),
  61. emits: ['visibleChange'],
  62. setup(props, _ref) {
  63. let {
  64. attrs,
  65. emit,
  66. slots
  67. } = _ref;
  68. const fullySSR = (0, _vue.computed)(() => props.ssr === 'full');
  69. const containerWidth = (0, _vue.shallowRef)(null);
  70. const mergedContainerWidth = (0, _vue.computed)(() => containerWidth.value || 0);
  71. const itemWidths = (0, _vue.shallowRef)(new Map());
  72. const prevRestWidth = (0, _vue.shallowRef)(0);
  73. const restWidth = (0, _vue.shallowRef)(0);
  74. const suffixWidth = (0, _vue.shallowRef)(0);
  75. const suffixFixedStart = (0, _vue.shallowRef)(null);
  76. const displayCount = (0, _vue.shallowRef)(null);
  77. const mergedDisplayCount = (0, _vue.computed)(() => {
  78. if (displayCount.value === null && fullySSR.value) {
  79. return Number.MAX_SAFE_INTEGER;
  80. }
  81. return displayCount.value || 0;
  82. });
  83. const restReady = (0, _vue.shallowRef)(false);
  84. const itemPrefixCls = (0, _vue.computed)(() => `${props.prefixCls}-item`);
  85. // Always use the max width to avoid blink
  86. const mergedRestWidth = (0, _vue.computed)(() => Math.max(prevRestWidth.value, restWidth.value));
  87. // ================================= Data =================================
  88. const isResponsive = (0, _vue.computed)(() => !!(props.data.length && props.maxCount === RESPONSIVE));
  89. const invalidate = (0, _vue.computed)(() => props.maxCount === INVALIDATE);
  90. /**
  91. * When is `responsive`, we will always render rest node to get the real width of it for calculation
  92. */
  93. const showRest = (0, _vue.computed)(() => isResponsive.value || typeof props.maxCount === 'number' && props.data.length > props.maxCount);
  94. const mergedData = (0, _vue.computed)(() => {
  95. let items = props.data;
  96. if (isResponsive.value) {
  97. if (containerWidth.value === null && fullySSR.value) {
  98. items = props.data;
  99. } else {
  100. items = props.data.slice(0, Math.min(props.data.length, mergedContainerWidth.value / props.itemWidth));
  101. }
  102. } else if (typeof props.maxCount === 'number') {
  103. items = props.data.slice(0, props.maxCount);
  104. }
  105. return items;
  106. });
  107. const omittedItems = (0, _vue.computed)(() => {
  108. if (isResponsive.value) {
  109. return props.data.slice(mergedDisplayCount.value + 1);
  110. }
  111. return props.data.slice(mergedData.value.length);
  112. });
  113. // ================================= Item =================================
  114. const getKey = (item, index) => {
  115. var _a;
  116. if (typeof props.itemKey === 'function') {
  117. return props.itemKey(item);
  118. }
  119. return (_a = props.itemKey && (item === null || item === void 0 ? void 0 : item[props.itemKey])) !== null && _a !== void 0 ? _a : index;
  120. };
  121. const mergedRenderItem = (0, _vue.computed)(() => props.renderItem || (item => item));
  122. const updateDisplayCount = (count, notReady) => {
  123. displayCount.value = count;
  124. if (!notReady) {
  125. restReady.value = count < props.data.length - 1;
  126. emit('visibleChange', count);
  127. }
  128. };
  129. // ================================= Size =================================
  130. const onOverflowResize = (_, element) => {
  131. containerWidth.value = element.clientWidth;
  132. };
  133. const registerSize = (key, width) => {
  134. const clone = new Map(itemWidths.value);
  135. if (width === null) {
  136. clone.delete(key);
  137. } else {
  138. clone.set(key, width);
  139. }
  140. itemWidths.value = clone;
  141. };
  142. const registerOverflowSize = (_, width) => {
  143. prevRestWidth.value = restWidth.value;
  144. restWidth.value = width;
  145. };
  146. const registerSuffixSize = (_, width) => {
  147. suffixWidth.value = width;
  148. };
  149. // ================================ Effect ================================
  150. const getItemWidth = index => {
  151. return itemWidths.value.get(getKey(mergedData.value[index], index));
  152. };
  153. (0, _vue.watch)([mergedContainerWidth, itemWidths, restWidth, suffixWidth, () => props.itemKey, mergedData], () => {
  154. if (mergedContainerWidth.value && mergedRestWidth.value && mergedData.value) {
  155. let totalWidth = suffixWidth.value;
  156. const len = mergedData.value.length;
  157. const lastIndex = len - 1;
  158. // When data count change to 0, reset this since not loop will reach
  159. if (!len) {
  160. updateDisplayCount(0);
  161. suffixFixedStart.value = null;
  162. return;
  163. }
  164. for (let i = 0; i < len; i += 1) {
  165. const currentItemWidth = getItemWidth(i);
  166. // Break since data not ready
  167. if (currentItemWidth === undefined) {
  168. updateDisplayCount(i - 1, true);
  169. break;
  170. }
  171. // Find best match
  172. totalWidth += currentItemWidth;
  173. if (
  174. // Only one means `totalWidth` is the final width
  175. lastIndex === 0 && totalWidth <= mergedContainerWidth.value ||
  176. // Last two width will be the final width
  177. i === lastIndex - 1 && totalWidth + getItemWidth(lastIndex) <= mergedContainerWidth.value) {
  178. // Additional check if match the end
  179. updateDisplayCount(lastIndex);
  180. suffixFixedStart.value = null;
  181. break;
  182. } else if (totalWidth + mergedRestWidth.value > mergedContainerWidth.value) {
  183. // Can not hold all the content to show rest
  184. updateDisplayCount(i - 1);
  185. suffixFixedStart.value = totalWidth - currentItemWidth - suffixWidth.value + restWidth.value;
  186. break;
  187. }
  188. }
  189. if (props.suffix && getItemWidth(0) + suffixWidth.value > mergedContainerWidth.value) {
  190. suffixFixedStart.value = null;
  191. }
  192. }
  193. });
  194. return () => {
  195. // ================================ Render ================================
  196. const displayRest = restReady.value && !!omittedItems.value.length;
  197. const {
  198. itemComponent,
  199. renderRawItem,
  200. renderRawRest,
  201. renderRest,
  202. prefixCls = 'rc-overflow',
  203. suffix,
  204. component: Component = 'div',
  205. id,
  206. onMousedown
  207. } = props;
  208. const {
  209. class: className,
  210. style
  211. } = attrs,
  212. restAttrs = __rest(attrs, ["class", "style"]);
  213. let suffixStyle = {};
  214. if (suffixFixedStart.value !== null && isResponsive.value) {
  215. suffixStyle = {
  216. position: 'absolute',
  217. left: `${suffixFixedStart.value}px`,
  218. top: 0
  219. };
  220. }
  221. const itemSharedProps = {
  222. prefixCls: itemPrefixCls.value,
  223. responsive: isResponsive.value,
  224. component: itemComponent,
  225. invalidate: invalidate.value
  226. };
  227. // >>>>> Choice render fun by `renderRawItem`
  228. const internalRenderItemNode = renderRawItem ? (item, index) => {
  229. const key = getKey(item, index);
  230. return (0, _vue.createVNode)(_context.OverflowContextProvider, {
  231. "key": key,
  232. "value": (0, _extends2.default)((0, _extends2.default)({}, itemSharedProps), {
  233. order: index,
  234. item,
  235. itemKey: key,
  236. registerSize,
  237. display: index <= mergedDisplayCount.value
  238. })
  239. }, {
  240. default: () => [renderRawItem(item, index)]
  241. });
  242. } : (item, index) => {
  243. const key = getKey(item, index);
  244. return (0, _vue.createVNode)(_Item.default, (0, _objectSpread2.default)((0, _objectSpread2.default)({}, itemSharedProps), {}, {
  245. "order": index,
  246. "key": key,
  247. "item": item,
  248. "renderItem": mergedRenderItem.value,
  249. "itemKey": key,
  250. "registerSize": registerSize,
  251. "display": index <= mergedDisplayCount.value
  252. }), null);
  253. };
  254. // >>>>> Rest node
  255. let restNode = () => null;
  256. const restContextProps = {
  257. order: displayRest ? mergedDisplayCount.value : Number.MAX_SAFE_INTEGER,
  258. className: `${itemPrefixCls.value} ${itemPrefixCls.value}-rest`,
  259. registerSize: registerOverflowSize,
  260. display: displayRest
  261. };
  262. if (!renderRawRest) {
  263. const mergedRenderRest = renderRest || defaultRenderRest;
  264. restNode = () => (0, _vue.createVNode)(_Item.default, (0, _objectSpread2.default)((0, _objectSpread2.default)({}, itemSharedProps), restContextProps), {
  265. default: () => typeof mergedRenderRest === 'function' ? mergedRenderRest(omittedItems.value) : mergedRenderRest
  266. });
  267. } else if (renderRawRest) {
  268. restNode = () => (0, _vue.createVNode)(_context.OverflowContextProvider, {
  269. "value": (0, _extends2.default)((0, _extends2.default)({}, itemSharedProps), restContextProps)
  270. }, {
  271. default: () => [renderRawRest(omittedItems.value)]
  272. });
  273. }
  274. const overflowNode = () => {
  275. var _a;
  276. return (0, _vue.createVNode)(Component, (0, _objectSpread2.default)({
  277. "id": id,
  278. "class": (0, _classNames.default)(!invalidate.value && prefixCls, className),
  279. "style": style,
  280. "onMousedown": onMousedown
  281. }, restAttrs), {
  282. default: () => [mergedData.value.map(internalRenderItemNode), showRest.value ? restNode() : null, suffix && (0, _vue.createVNode)(_Item.default, (0, _objectSpread2.default)((0, _objectSpread2.default)({}, itemSharedProps), {}, {
  283. "order": mergedDisplayCount.value,
  284. "class": `${itemPrefixCls.value}-suffix`,
  285. "registerSize": registerSuffixSize,
  286. "display": true,
  287. "style": suffixStyle
  288. }), {
  289. default: () => suffix
  290. }), (_a = slots.default) === null || _a === void 0 ? void 0 : _a.call(slots)]
  291. });
  292. };
  293. // 使用 disabled 避免结构不一致 导致子组件 rerender
  294. return (0, _vue.createVNode)(_vcResizeObserver.default, {
  295. "disabled": !isResponsive.value,
  296. "onResize": onOverflowResize
  297. }, {
  298. default: overflowNode
  299. });
  300. };
  301. }
  302. });
  303. Overflow.Item = _RawItem.default;
  304. Overflow.RESPONSIVE = RESPONSIVE;
  305. Overflow.INVALIDATE = INVALIDATE;
  306. var _default = exports.default = Overflow;