Overflow.js 13 KB

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