ant-design-vue/components/vc-overflow/Overflow.tsx
tangjinzhou 3aeeeb2aed
3.0 ready (#4523)
* refactor: transfer、tooltip (#4306)

* refactor(transfer): use composition api (#4135)

* refactor(transfer): use composition api

* fix: remove console

* refactor(tooltip): use composition api (#4059)

* refactor(tooltip): use composition api

* chore: useConfigInject

* fix: remove useless

* style: format code

* refactor: transfer

* refactor: tooltip

Co-authored-by: ajuner <106791576@qq.com>

* Refactor mentions (#4341)

* refactor(mentions): use compositionAPI (#4313)

* refactor: mentions

* refactor: mentions

Co-authored-by: ajuner <106791576@qq.com>

* Refactor progress (#4358)

* fix: timepicker error border not show #4331

* fix(UploadDragger): fix UploadDrager no export (#4334)

* refactor(switch): support customize checked value #4329 (#4332)

* refactor(switch): support customize checked value #4329

* test: add test case

* refactor: update props name

* refactor: update ts

* refactor: optimize

* style: uncheckedValue to unCheckedValue

* test: update snap

* feat: udpate switch ts

* docs: remove ie11

* fix: tree-select throw error when use slot title

* fix: TypeScript definition of Table interface for typescript 4.3.5 (#4353)

* fix type for typescript 4.3.5

* Update interface.ts

close #4296

* fix: dropdown submenu style error #4351
close #4351

* fix(notification): 完善notification类型 (#4346)

* refactor(progress): use composition API (#4355)

* refactor(progress): use composition API

* refactor(vc-progress): update

* refactor: progress

* refactor: progress

* fix: timepicker error border not show #4331

* fix(UploadDragger): fix UploadDrager no export (#4334)

* refactor(switch): support customize checked value #4329 (#4332)

* refactor(switch): support customize checked value #4329

* test: add test case

* refactor: update props name

* refactor: update ts

* refactor: optimize

* style: uncheckedValue to unCheckedValue

* test: update snap

* feat: udpate switch ts

* docs: remove ie11

* fix: tree-select throw error when use slot title

* fix: TypeScript definition of Table interface for typescript 4.3.5 (#4353)

* fix type for typescript 4.3.5

* Update interface.ts

close #4296

* fix: dropdown submenu style error #4351
close #4351

* fix(notification): 完善notification类型 (#4346)

* refactor(progress): use composition API (#4355)

* refactor(progress): use composition API

* refactor(vc-progress): update

* refactor: progress

* refactor: progress

Co-authored-by: Jarvis <35361626+fanhaoyuan@users.noreply.github.com>
Co-authored-by: John <John60676@qq.com>
Co-authored-by: 艾斯特洛 <axetroy.dev@gmail.com>
Co-authored-by: zanllp <qc@zanllp.cn>

* docs: add changelog

* refactor: tree

* refactor: tree

* style: lint

* refactor: tree

* 热factor: tree

* refactor: tree

* refactor: tree

* refactor: tree

* refactor: directory tree

* refactor: tree

* refactor: tree-select

* refactor: tree-select

* refactor: tree-select

* refactor: tree-select

* refactor: tree-select

* style: lint format

* refactor: tree-select

* refactor: tree-select

* refactor: tree-select

* refactor: tree-select

* refactor: tree-select

* refactor: tree-select

* fix: upload ts error

* fix: update tree title render & switchIcon

* test: update tree test

* feat: add VirtualScroll tree

* refactor: datePicker & calendar & trigger (#4522)

* style: update

* test: update calendar test

* test: update test

* test: update test

* refactor: slider

* feat: update slider css

* refactor: slider to ts

* refactor: slider to ts

* perf: update default itemHeight

* test: update

* fix: uddate ts type

* fix: update skeleton

* fix: update skeleton

* refactor: update vc-pagination

* refactor: pagination

* refactor: timeline

* refactor: steps

* refactor: collapse

* refactor: collapse

* refactor: popconfirm

* refactor: popover

* refactor: dropdown

* doc: merge doc

* chore: vite for dev (#4602)

* style: js to jsx

* doc: add site

* style: lint

* style: format ts type

* doc: update

* style: format code

* style: format site

* doc: update

* style: dmeo

* style: format scripts

* chore: remove sub-modules

* chore: update vite

* site: add site build

* test: update snap

* doc(select): add tip (#4606)

* refactor: table (#4641)

* refactor: table

* refactor: table

* refactor: table

* refactor: table

* refactor: table

* refactor: table

* refactor: table

* refactor: table

* refactor: table

* fix: column not pass to cell

* doc: uppate table

* fix: update bodyCell headerCell

* doc: remove examples

* refactor: table

* fix: table title not work

* fix: table selection

* fix: table checkStrictly

* refactor: table

* fix: table template error

* feat: table support summary

* test: update snap

* perf: table

* docs(table): fix ajax demo (#4639)

* test: update table

* refactor: remove old table

* doc: update  table doc

* doc: update doc

* doc: update select

* doc: update summary

Co-authored-by: John <John60676@qq.com>

* doc: update doc

* fix: menu arrow not work

* test: update

* doc: add next site

* style: format

* doc: update

* doc: update site script

* fix: expand icon not fixed

* feat: use renderSlot

* test: update table snap

* feat: confirm support reactively

* feat: configProvider.config

* feat: message support configprovider.config

* feat: notification support configprovider.config

* doc: update doc

* fix: typescript compile error

* style: add import eslint

* doc: update demo

* chore: set transpileOnly true

* style: fix eslint error

* test: update snap

* doc: update

* test: mock date

* test: update snap

* chore: remove gulp-typescript (#4675)

* feat: V3 form (#4678)

* chore: update husky

* perf: update formItem

* perf: useInjectFormItemContext

* fix: table ts error

* doc: add Customized Form Controls demo

* feat: export useInjectFormItemContext

* doc: update form doc

* doc: update doc

* doc: update doc

* feat: autocomplete support option slot

* doc: update

* feat: add form item rest

* style: remove omit.js

* refactor: autocomplete

* doc: add changelog to site

* doc: update site anchor

* doc: update doc layout

* test: update table test

* doc: update

* chore: udpate gulp script

* chore: udpate gulp script

* doc: add changelog

* doc: update

* test: ignore some test wait vue-test-utils

* fix: form id error #4582
close #4582

* doc: add select Responsive demo

* doc: remove temp doc

Co-authored-by: ajuner <106791576@qq.com>
Co-authored-by: Jarvis <35361626+fanhaoyuan@users.noreply.github.com>
Co-authored-by: John <John60676@qq.com>
Co-authored-by: 艾斯特洛 <axetroy.dev@gmail.com>
Co-authored-by: zanllp <qc@zanllp.cn>
Co-authored-by: Amour1688 <lcz_1996@foxmail.com>
2021-09-25 16:51:32 +08:00

388 lines
13 KiB
Vue

import type { CSSProperties, HTMLAttributes, PropType } from 'vue';
import { computed, defineComponent, ref, watch } from 'vue';
import ResizeObserver from '../vc-resize-observer';
import classNames from '../_util/classNames';
import type { Key, VueNode } from '../_util/type';
import PropTypes from '../_util/vue-types';
import { OverflowContextProvider } from './context';
import Item from './Item';
import RawItem from './RawItem';
const RESPONSIVE = 'responsive' as const;
const INVALIDATE = 'invalidate' as const;
function defaultRenderRest<ItemType>(omittedItems: ItemType[]) {
return `+ ${omittedItems.length} ...`;
}
export interface OverflowProps<ItemType> extends HTMLAttributes {
prefixCls?: string;
data?: ItemType[];
itemKey?: Key;
/** Used for `responsive`. It will limit render node to avoid perf issue */
itemWidth?: number;
renderItem?: (item: ItemType) => VueNode;
/** @private Do not use in your production. Render raw node that need wrap Item by developer self */
renderRawItem?: (item: ItemType, index: number) => VueNode;
maxCount?: number | typeof RESPONSIVE | typeof INVALIDATE;
renderRest?: VueNode | ((omittedItems: ItemType[]) => VueNode);
/** @private Do not use in your production. Render raw node that need wrap Item by developer self */
renderRawRest?: (omittedItems: ItemType[]) => VueNode;
suffix?: VueNode;
component?: any;
itemComponent?: any;
/** @private This API may be refactor since not well design */
onVisibleChange?: (visibleCount: number) => void;
/** When set to `full`, ssr will render full items by default and remove at client side */
ssr?: 'full';
}
const Overflow = defineComponent({
name: 'Overflow',
inheritAttrs: false,
props: {
prefixCls: String,
data: Array,
itemKey: [String, Number, Function] as PropType<Key | ((item: any) => Key)>,
/** Used for `responsive`. It will limit render node to avoid perf issue */
itemWidth: { type: Number, default: 10 },
renderItem: Function as PropType<(item: any) => VueNode>,
/** @private Do not use in your production. Render raw node that need wrap Item by developer self */
renderRawItem: Function as PropType<(item: any, index: number) => VueNode>,
maxCount: [Number, String] as PropType<number | typeof RESPONSIVE | typeof INVALIDATE>,
renderRest: Function as PropType<(items: any[]) => VueNode>,
/** @private Do not use in your production. Render raw node that need wrap Item by developer self */
renderRawRest: Function as PropType<(items: any[]) => VueNode>,
suffix: PropTypes.any,
component: String,
itemComponent: PropTypes.any,
/** @private This API may be refactor since not well design */
onVisibleChange: Function as PropType<(visibleCount: number) => void>,
/** When set to `full`, ssr will render full items by default and remove at client side */
ssr: String as PropType<'full'>,
},
emits: ['visibleChange'],
setup(props, { attrs, emit }) {
const fullySSR = computed(() => props.ssr === 'full');
const containerWidth = ref<number>(null);
const mergedContainerWidth = computed(() => containerWidth.value || 0);
const itemWidths = ref<Map<Key, number>>(new Map<Key, number>());
const prevRestWidth = ref(0);
const restWidth = ref(0);
const suffixWidth = ref(0);
const suffixFixedStart = ref<number>(null);
const displayCount = ref<number>(null);
const mergedDisplayCount = computed(() => {
if (displayCount.value === null && fullySSR.value) {
return Number.MAX_SAFE_INTEGER;
}
return displayCount.value || 0;
});
const restReady = ref(false);
const itemPrefixCls = computed(() => `${props.prefixCls}-item`);
// Always use the max width to avoid blink
const mergedRestWidth = computed(() => Math.max(prevRestWidth.value, restWidth.value));
// ================================= Data =================================
const isResponsive = computed(() => !!(props.data.length && props.maxCount === RESPONSIVE));
const invalidate = computed(() => props.maxCount === INVALIDATE);
/**
* When is `responsive`, we will always render rest node to get the real width of it for calculation
*/
const showRest = computed(
() =>
isResponsive.value ||
(typeof props.maxCount === 'number' && props.data.length > props.maxCount),
);
const mergedData = computed(() => {
let items = props.data;
if (isResponsive.value) {
if (containerWidth.value === null && fullySSR.value) {
items = props.data;
} else {
items = props.data.slice(
0,
Math.min(props.data.length, mergedContainerWidth.value / props.itemWidth),
);
}
} else if (typeof props.maxCount === 'number') {
items = props.data.slice(0, props.maxCount);
}
return items;
});
const omittedItems = computed(() => {
if (isResponsive.value) {
return props.data.slice(mergedDisplayCount.value + 1);
}
return props.data.slice(mergedData.value.length);
});
// ================================= Item =================================
const getKey = (item: any, index: number) => {
if (typeof props.itemKey === 'function') {
return props.itemKey(item);
}
return (props.itemKey && (item as any)?.[props.itemKey]) ?? index;
};
const mergedRenderItem = computed(() => props.renderItem || ((item: any) => item));
const updateDisplayCount = (count: number, notReady?: boolean) => {
displayCount.value = count;
if (!notReady) {
restReady.value = count < props.data.length - 1;
emit('visibleChange', count);
}
};
// ================================= Size =================================
const onOverflowResize = (_: object, element: HTMLElement) => {
containerWidth.value = element.clientWidth;
};
const registerSize = (key: Key, width: number | null) => {
const clone = new Map(itemWidths.value);
if (width === null) {
clone.delete(key);
} else {
clone.set(key, width);
}
itemWidths.value = clone;
};
const registerOverflowSize = (_: Key, width: number | null) => {
prevRestWidth.value = restWidth.value;
restWidth.value = width!;
};
const registerSuffixSize = (_: Key, width: number | null) => {
suffixWidth.value = width!;
};
// ================================ Effect ================================
const getItemWidth = (index: number) => {
return itemWidths.value.get(getKey(mergedData.value[index], index));
};
watch(
[mergedContainerWidth, itemWidths, restWidth, suffixWidth, () => props.itemKey, mergedData],
() => {
if (mergedContainerWidth.value && mergedRestWidth.value && mergedData.value) {
let totalWidth = suffixWidth.value;
const len = mergedData.value.length;
const lastIndex = len - 1;
// When data count change to 0, reset this since not loop will reach
if (!len) {
updateDisplayCount(0);
suffixFixedStart.value = null;
return;
}
for (let i = 0; i < len; i += 1) {
const currentItemWidth = getItemWidth(i);
// Break since data not ready
if (currentItemWidth === undefined) {
updateDisplayCount(i - 1, true);
break;
}
// Find best match
totalWidth += currentItemWidth;
if (
// Only one means `totalWidth` is the final width
(lastIndex === 0 && totalWidth <= mergedContainerWidth.value) ||
// Last two width will be the final width
(i === lastIndex - 1 &&
totalWidth + getItemWidth(lastIndex)! <= mergedContainerWidth.value)
) {
// Additional check if match the end
updateDisplayCount(lastIndex);
suffixFixedStart.value = null;
break;
} else if (totalWidth + mergedRestWidth.value > mergedContainerWidth.value) {
// Can not hold all the content to show rest
updateDisplayCount(i - 1);
suffixFixedStart.value =
totalWidth - currentItemWidth - suffixWidth.value + restWidth.value;
break;
}
}
if (props.suffix && getItemWidth(0) + suffixWidth.value > mergedContainerWidth.value) {
suffixFixedStart.value = null;
}
}
},
);
return () => {
// ================================ Render ================================
const displayRest = restReady.value && !!omittedItems.value.length;
const {
itemComponent,
renderRawItem,
renderRawRest,
renderRest,
prefixCls = 'rc-overflow',
suffix,
component: Component = 'div' as any,
} = props;
const { class: className, style, ...restAttrs } = attrs;
let suffixStyle: CSSProperties = {};
if (suffixFixedStart.value !== null && isResponsive.value) {
suffixStyle = {
position: 'absolute',
left: `${suffixFixedStart.value}px`,
top: 0,
};
}
const itemSharedProps = {
prefixCls: itemPrefixCls.value,
responsive: isResponsive.value,
component: itemComponent,
invalidate: invalidate.value,
};
// >>>>> Choice render fun by `renderRawItem`
const internalRenderItemNode = renderRawItem
? (item: any, index: number) => {
const key = getKey(item, index);
return (
<OverflowContextProvider
key={key}
value={{
...itemSharedProps,
order: index,
item,
itemKey: key,
registerSize,
display: index <= mergedDisplayCount.value,
}}
>
{renderRawItem(item, index)}
</OverflowContextProvider>
);
}
: (item: any, index: number) => {
const key = getKey(item, index);
return (
<Item
{...itemSharedProps}
order={index}
key={key}
item={item}
renderItem={mergedRenderItem.value}
itemKey={key}
registerSize={registerSize}
display={index <= mergedDisplayCount.value}
/>
);
};
// >>>>> Rest node
let restNode = () => null;
const restContextProps = {
order: displayRest ? mergedDisplayCount.value : Number.MAX_SAFE_INTEGER,
className: `${itemPrefixCls.value}-rest`,
registerSize: registerOverflowSize,
display: displayRest,
};
if (!renderRawRest) {
const mergedRenderRest = renderRest || defaultRenderRest;
restNode = () => (
<Item
{...itemSharedProps}
// When not show, order should be the last
{...restContextProps}
v-slots={{
default: () =>
typeof mergedRenderRest === 'function'
? mergedRenderRest(omittedItems.value)
: mergedRenderRest,
}}
></Item>
);
} else if (renderRawRest) {
restNode = () => (
<OverflowContextProvider
value={{
...itemSharedProps,
...restContextProps,
}}
>
{renderRawRest(omittedItems.value)}
</OverflowContextProvider>
);
}
const overflowNode = () => (
<Component
class={classNames(!invalidate.value && prefixCls, className)}
style={style}
{...restAttrs}
>
{mergedData.value.map(internalRenderItemNode)}
{/* Rest Count Item */}
{showRest.value ? restNode() : null}
{/* Suffix Node */}
{suffix && (
<Item
{...itemSharedProps}
order={mergedDisplayCount.value}
class={`${itemPrefixCls.value}-suffix`}
registerSize={registerSuffixSize}
display
style={suffixStyle}
v-slots={{ default: () => suffix }}
></Item>
)}
</Component>
);
// 使用 disabled 避免结构不一致 导致子组件 rerender
return (
<ResizeObserver
disabled={!isResponsive.value}
onResize={onOverflowResize}
v-slots={{ default: overflowNode }}
></ResizeObserver>
);
};
},
});
Overflow.Item = RawItem;
Overflow.RESPONSIVE = RESPONSIVE;
Overflow.INVALIDATE = INVALIDATE;
export default Overflow as typeof Overflow & {
readonly Item: typeof RawItem;
readonly RESPONSIVE: typeof RESPONSIVE;
readonly INVALIDATE: typeof INVALIDATE;
};