Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: form component IconPicker #5002

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion apps/web-antd/src/adapter/component/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import type { BaseFormComponentType } from '@vben/common-ui';
import type { Component, SetupContext } from 'vue';
import { h } from 'vue';

import { globalShareState } from '@vben/common-ui';
import { globalShareState, IconPicker } from '@vben/common-ui';
import { $t } from '@vben/locales';

import {
Expand Down Expand Up @@ -54,6 +54,7 @@ export type ComponentType =
| 'DatePicker'
| 'DefaultButton'
| 'Divider'
| 'IconPicker'
| 'Input'
| 'InputNumber'
| 'InputPassword'
Expand Down Expand Up @@ -87,6 +88,7 @@ async function initComponentAdapter() {
return h(Button, { ...props, attrs, type: 'default' }, slots);
},
Divider,
IconPicker,
Input: withDefaultPlaceholder(Input, 'input'),
InputNumber: withDefaultPlaceholder(InputNumber, 'input'),
InputPassword: withDefaultPlaceholder(InputPassword, 'input'),
Expand Down
6 changes: 6 additions & 0 deletions apps/web-antd/src/locales/langs/en-US/components.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"icon-picker": {
"placeholder": "Select an icon",
"search": "Search icon..."
}
}
6 changes: 6 additions & 0 deletions apps/web-antd/src/locales/langs/zh-CN/components.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"icon-picker": {
"placeholder": "选择一个图标",
"search": "搜索图标..."
}
}
4 changes: 3 additions & 1 deletion apps/web-ele/src/adapter/component/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import type { BaseFormComponentType } from '@vben/common-ui';
import type { Component, SetupContext } from 'vue';
import { h } from 'vue';

import { globalShareState } from '@vben/common-ui';
import { globalShareState, IconPicker } from '@vben/common-ui';
import { $t } from '@vben/locales';

import {
Expand Down Expand Up @@ -45,6 +45,7 @@ export type ComponentType =
| 'CheckboxGroup'
| 'DatePicker'
| 'Divider'
| 'IconPicker'
| 'Input'
| 'InputNumber'
| 'RadioGroup'
Expand Down Expand Up @@ -73,6 +74,7 @@ async function initComponentAdapter() {
return h(ElButton, { ...props, attrs, type: 'primary' }, slots);
},
Divider: ElDivider,
IconPicker,
Input: withDefaultPlaceholder(ElInput, 'input'),
InputNumber: withDefaultPlaceholder(ElInputNumber, 'input'),
RadioGroup: ElRadioGroup,
Expand Down
6 changes: 6 additions & 0 deletions apps/web-ele/src/locales/langs/en-US/components.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"icon-picker": {
"placeholder": "Select an icon",
"search": "Search icon..."
}
}
6 changes: 6 additions & 0 deletions apps/web-ele/src/locales/langs/zh-CN/components.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"icon-picker": {
"placeholder": "选择一个图标",
"search": "搜索图标..."
}
}
4 changes: 3 additions & 1 deletion apps/web-naive/src/adapter/component/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import type { BaseFormComponentType } from '@vben/common-ui';
import type { Component, SetupContext } from 'vue';
import { h } from 'vue';

import { globalShareState } from '@vben/common-ui';
import { globalShareState, IconPicker } from '@vben/common-ui';
import { $t } from '@vben/locales';

import {
Expand Down Expand Up @@ -46,6 +46,7 @@ export type ComponentType =
| 'CheckboxGroup'
| 'DatePicker'
| 'Divider'
| 'IconPicker'
| 'Input'
| 'InputNumber'
| 'RadioGroup'
Expand Down Expand Up @@ -75,6 +76,7 @@ async function initComponentAdapter() {
return h(NButton, { ...props, attrs, type: 'primary' }, slots);
},
Divider: NDivider,
IconPicker,
Input: withDefaultPlaceholder(NInput, 'input'),
InputNumber: withDefaultPlaceholder(NInputNumber, 'input'),
RadioGroup: NRadioGroup,
Expand Down
6 changes: 6 additions & 0 deletions apps/web-naive/src/locales/langs/en-US/components.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"icon-picker": {
"placeholder": "Select an icon",
"search": "Search icon..."
}
}
6 changes: 6 additions & 0 deletions apps/web-naive/src/locales/langs/zh-CN/components.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"icon-picker": {
"placeholder": "选择一个图标",
"search": "搜索图标..."
}
}
4 changes: 3 additions & 1 deletion docs/src/components/common-ui/vben-form.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ import type { BaseFormComponentType } from '@vben/common-ui';
import type { Component, SetupContext } from 'vue';
import { h } from 'vue';

import { globalShareState } from '@vben/common-ui';
import { globalShareState, IconPicker } from '@vben/common-ui';
import { $t } from '@vben/locales';

import {
Expand Down Expand Up @@ -149,6 +149,7 @@ export type ComponentType =
| 'TimePicker'
| 'TreeSelect'
| 'Upload'
| 'IconPicker';
| BaseFormComponentType;

async function initComponentAdapter() {
Expand All @@ -166,6 +167,7 @@ async function initComponentAdapter() {
return h(Button, { ...props, attrs, type: 'default' }, slots);
},
Divider,
IconPicker,
Input: withDefaultPlaceholder(Input, 'input'),
InputNumber: withDefaultPlaceholder(InputNumber, 'input'),
InputPassword: withDefaultPlaceholder(InputPassword, 'input'),
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
<script setup lang="ts">
import { ref, useTemplateRef, watch, watchEffect } from 'vue';
import { computed, ref, watch, watchEffect } from 'vue';

import { usePagination } from '@vben/hooks';
import { EmptyIcon, Grip } from '@vben/icons';
import { EmptyIcon, Grip, listIcons } from '@vben/icons';
import { $t } from '@vben/locales';
import {
Button,
Input,
Pagination,
PaginationEllipsis,
PaginationFirst,
Expand All @@ -18,81 +20,124 @@ import {
VbenPopover,
} from '@vben-core/shadcn-ui';

import { refDebounced } from '@vueuse/core';

interface Props {
value?: string;
pageSize?: number;
prefix?: string;
/**
* 图标列表
*/
icons?: string[];
}

const props = withDefaults(defineProps<Props>(), {
value: '',
prefix: 'ant-design',
pageSize: 36,
icons: () => [],
});

const emit = defineEmits<{
change: [string];
'update:value': [string];
}>();

const refTrigger = useTemplateRef<HTMLElement>('refTrigger');
const modelValue = defineModel({ default: '', type: String });

const visible = ref(false);
const currentSelect = ref('');
const currentList = ref(props.icons);
const currentPage = ref(1);
const keyword = ref('');
const keywordDebounce = refDebounced(keyword, 300);
const currentList = computed(() => {
try {
if (props.prefix) {
const icons = listIcons('', props.prefix);
if (icons.length === 0) {
console.warn(`No icons found for prefix: ${props.prefix}`);
}
return icons;
} else {
return props.icons;
}
} catch (error) {
console.error('Failed to load icons:', error);
return [];
}
});

watch(
() => props.icons,
(newIcons) => {
currentList.value = newIcons;
},
{ immediate: true },
);
const showList = computed(() => {
return currentList.value.filter((item) =>
item.includes(keywordDebounce.value),
);
});

const { paginationList, total, setCurrentPage } = usePagination(
currentList,
showList,
props.pageSize,
);

watchEffect(() => {
currentSelect.value = props.value;
currentSelect.value = modelValue.value;
});

watch(
() => currentSelect.value,
(v) => {
emit('update:value', v);
emit('change', v);
},
);

const handleClick = (icon: string) => {
currentSelect.value = icon;
modelValue.value = icon;
close();
};

const handlePageChange = (page: number) => {
currentPage.value = page;
setCurrentPage(page);
};

function changeOpenState() {
refTrigger.value?.click?.();
function toggleOpenState() {
visible.value = !visible.value;
}

defineExpose({ changeOpenState });
function open() {
visible.value = true;
}

function close() {
visible.value = false;
}

defineExpose({ toggleOpenState, open, close });
</script>
<template>
<VbenPopover
v-model:open="visible"
:content-props="{ align: 'end', alignOffset: -11, sideOffset: 8 }"
content-class="p-0 pt-3"
>
<template #trigger>
<div ref="refTrigger">
<VbenIcon :icon="currentSelect || Grip" class="size-5" />
</div>
<slot :close="close" :icon="currentSelect" :open="open" name="trigger">
<div class="flex items-center gap-2">
<Input
:value="currentSelect"
class="flex-1 cursor-pointer"
v-bind="$attrs"
:placeholder="$t('components.icon-picker.placeholder')"
/>
<VbenIcon :icon="currentSelect || Grip" class="size-8" />
</div>
</slot>
</template>
<div class="mb-2 flex w-full">
<Input
v-model="keyword"
:placeholder="$t('components.icon-picker.search')"
class="mx-2"
/>
</div>

<template v-if="paginationList.length > 0">
<div class="grid max-h-[360px] w-full grid-cols-6 justify-items-center">
Expand Down
4 changes: 3 additions & 1 deletion playground/src/adapter/component/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import type { BaseFormComponentType } from '@vben/common-ui';
import type { Component, SetupContext } from 'vue';
import { h } from 'vue';

import { globalShareState } from '@vben/common-ui';
import { globalShareState, IconPicker } from '@vben/common-ui';
import { $t } from '@vben/locales';

import {
Expand Down Expand Up @@ -54,6 +54,7 @@ export type ComponentType =
| 'DatePicker'
| 'DefaultButton'
| 'Divider'
| 'IconPicker'
| 'Input'
| 'InputNumber'
| 'InputPassword'
Expand Down Expand Up @@ -87,6 +88,7 @@ async function initComponentAdapter() {
return h(Button, { ...props, attrs, type: 'default' }, slots);
},
Divider,
IconPicker,
Input: withDefaultPlaceholder(Input, 'input'),
InputNumber: withDefaultPlaceholder(InputNumber, 'input'),
InputPassword: withDefaultPlaceholder(InputPassword, 'input'),
Expand Down
6 changes: 6 additions & 0 deletions playground/src/locales/langs/en-US/components.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"icon-picker": {
"placeholder": "Select an icon",
"search": "Search icon..."
}
}
6 changes: 6 additions & 0 deletions playground/src/locales/langs/zh-CN/components.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"icon-picker": {
"placeholder": "选择一个图标",
"search": "搜索图标..."
}
}
Loading