Browse Source

feat(vben5): add language manage

pull/1143/head
colin 1 year ago
parent
commit
f4cc428834
  1. 3
      apps/vben5/apps/app-antd/src/locales/langs/en-US/abp.json
  2. 3
      apps/vben5/apps/app-antd/src/locales/langs/zh-CN/abp.json
  3. 10
      apps/vben5/apps/app-antd/src/router/routes/modules/abp.ts
  4. 15
      apps/vben5/apps/app-antd/src/views/localization/languages/index.vue
  5. 1
      apps/vben5/packages/@abp/localization/src/api/index.ts
  6. 89
      apps/vben5/packages/@abp/localization/src/api/useLanguagesApi.ts
  7. 1
      apps/vben5/packages/@abp/localization/src/components/index.ts
  8. 115
      apps/vben5/packages/@abp/localization/src/components/languages/LocalizationLanguageModal.vue
  9. 240
      apps/vben5/packages/@abp/localization/src/components/languages/LocalizationLanguageTable.vue
  10. 10
      apps/vben5/packages/@abp/localization/src/constants/permissions.ts
  11. 1
      apps/vben5/packages/@abp/localization/src/types/index.ts
  12. 30
      apps/vben5/packages/@abp/localization/src/types/languages.ts

3
apps/vben5/apps/app-antd/src/locales/langs/en-US/abp.json

@ -48,7 +48,8 @@
},
"localization": {
"title": "Localization",
"resources": "Resources"
"resources": "Resources",
"languages": "Languages"
}
},
"openiddict": {

3
apps/vben5/apps/app-antd/src/locales/langs/zh-CN/abp.json

@ -48,7 +48,8 @@
},
"localization": {
"title": "本地化管理",
"resources": "资源管理"
"resources": "资源管理",
"languages": "语言管理"
}
},
"openiddict": {

10
apps/vben5/apps/app-antd/src/router/routes/modules/abp.ts

@ -193,6 +193,16 @@ const routes: RouteRecordRaw[] = [
component: () =>
import('#/views/localization/resources/index.vue'),
},
{
meta: {
title: $t('abp.manage.localization.languages'),
icon: 'cil:language',
},
name: 'LocalizationLanguages',
path: '/manage/localization/languages',
component: () =>
import('#/views/localization/languages/index.vue'),
},
],
},
{

15
apps/vben5/apps/app-antd/src/views/localization/languages/index.vue

@ -0,0 +1,15 @@
<script lang="ts" setup>
import { Page } from '@vben/common-ui';
import { LocalizationLanguageTable } from '@abp/localization';
defineOptions({
name: 'LocalizationLanguages',
});
</script>
<template>
<Page>
<LocalizationLanguageTable />
</Page>
</template>

1
apps/vben5/packages/@abp/localization/src/api/index.ts

@ -1,2 +1,3 @@
export { useLanguagesApi } from './useLanguagesApi';
export { useLocalizationsApi } from './useLocalizationsApi';
export { useResourcesApi } from './useResourcesApi';

89
apps/vben5/packages/@abp/localization/src/api/useLanguagesApi.ts

@ -0,0 +1,89 @@
import type { ListResultDto } from '@abp/core';
import type {
LanguageCreateDto,
LanguageDto,
LanguageGetListInput,
LanguageUpdateDto,
} from '../types/languages';
import { useRequest } from '@abp/request';
export function useLanguagesApi() {
const { cancel, request } = useRequest();
/**
*
* @param input
* @returns
*/
function getListApi(
input?: LanguageGetListInput,
): Promise<ListResultDto<LanguageDto>> {
return request<ListResultDto<LanguageDto>>(
'/api/abp/localization/languages',
{
method: 'GET',
params: input,
},
);
}
/**
*
* @param name
* @returns
*/
function getApi(name: string): Promise<LanguageDto> {
return request<LanguageDto>(`/api/localization/languages/${name}`, {
method: 'GET',
});
}
/**
*
* @param name
*/
function deleteApi(name: string): Promise<void> {
return request(`/api/localization/languages/${name}`, {
method: 'DELETE',
});
}
/**
*
* @param input
* @returns
*/
function createApi(input: LanguageCreateDto): Promise<LanguageDto> {
return request<LanguageDto>(`/api/localization/languages`, {
data: input,
method: 'POST',
});
}
/**
*
* @param name
* @param input
* @returns
*/
function updateApi(
name: string,
input: LanguageUpdateDto,
): Promise<LanguageDto> {
return request<LanguageDto>(`/api/localization/languages/${name}`, {
data: input,
method: 'PUT',
});
}
return {
cancel,
createApi,
deleteApi,
getApi,
getListApi,
updateApi,
};
}

1
apps/vben5/packages/@abp/localization/src/components/index.ts

@ -1 +1,2 @@
export { default as LocalizationLanguageTable } from './languages/LocalizationLanguageTable.vue';
export { default as LocalizationResourceTable } from './resources/LocalizationResourceTable.vue';

115
apps/vben5/packages/@abp/localization/src/components/languages/LocalizationLanguageModal.vue

@ -0,0 +1,115 @@
<script setup lang="ts">
import type { FormInstance } from 'ant-design-vue';
import type { LanguageDto } from '../../types/languages';
import { defineEmits, defineOptions, ref, toValue, useTemplateRef } from 'vue';
import { useVbenModal } from '@vben/common-ui';
import { $t } from '@vben/locales';
import { Form, Input, message } from 'ant-design-vue';
import { useLanguagesApi } from '../../api/useLanguagesApi';
defineOptions({
name: 'LocalizationLanguageModal',
});
const emits = defineEmits<{
(event: 'change', data: LanguageDto): void;
}>();
const FormItem = Form.Item;
const defaultModel = {} as LanguageDto;
const form = useTemplateRef<FormInstance>('form');
const formModel = ref<LanguageDto>({ ...defaultModel });
const { cancel, createApi, getApi, updateApi } = useLanguagesApi();
const [Modal, modalApi] = useVbenModal({
class: 'w-1/2',
draggable: true,
fullscreenButton: false,
onCancel() {
modalApi.close();
},
onClosed() {
cancel('LocalizationLanguageModal has closed!');
},
onConfirm: onSubmit,
onOpenChange: async (isOpen: boolean) => {
if (isOpen) {
formModel.value = { ...defaultModel };
modalApi.setState({
title: $t('LocalizationManagement.Language:AddNew'),
});
const { cultureName } = modalApi.getData<LanguageDto>();
cultureName && (await onGet(cultureName));
}
},
title: $t('LocalizationManagement.Language:AddNew'),
});
async function onGet(name: string) {
try {
modalApi.setState({ loading: true });
const dto = await getApi(name);
formModel.value = dto;
modalApi.setState({
title: `${$t('AbpLocalization.Languages')} - ${dto.cultureName}`,
});
} finally {
modalApi.setState({ loading: false });
}
}
async function onSubmit() {
await form.value?.validate();
try {
modalApi.setState({ submitting: true });
const input = toValue(formModel);
const api = input.id
? updateApi(input.cultureName, input)
: createApi(input);
const dto = await api;
message.success($t('AbpUi.SavedSuccessfully'));
emits('change', dto);
modalApi.close();
} finally {
modalApi.setState({ submitting: false });
}
}
</script>
<template>
<Modal>
<Form
ref="form"
:label-col="{ span: 6 }"
:model="formModel"
:wrapper-col="{ span: 18 }"
>
<FormItem
:label="$t('AbpLocalization.DisplayName:CultureName')"
name="cultureName"
required
>
<Input v-model:value="formModel.cultureName" autocomplete="off" />
</FormItem>
<FormItem
:label="$t('AbpLocalization.DisplayName:UiCultureName')"
name="uiCultureName"
>
<Input v-model:value="formModel.uiCultureName" autocomplete="off" />
</FormItem>
<FormItem
:label="$t('AbpLocalization.DisplayName:DisplayName')"
name="displayName"
required
>
<Input v-model:value="formModel.displayName" autocomplete="off" />
</FormItem>
</Form>
</Modal>
</template>
<style scoped></style>

240
apps/vben5/packages/@abp/localization/src/components/languages/LocalizationLanguageTable.vue

@ -0,0 +1,240 @@
<script setup lang="ts">
import type { VbenFormProps, VxeGridListeners, VxeGridProps } from '@abp/ui';
import type { LanguageDto } from '../../types/languages';
import { defineAsyncComponent, h, onMounted, reactive, ref } from 'vue';
import { useVbenModal } from '@vben/common-ui';
import { $t } from '@vben/locales';
import {
useAbpStore,
useLocalization,
useLocalizationSerializer,
} from '@abp/core';
import { useVbenVxeGrid } from '@abp/ui';
import {
DeleteOutlined,
EditOutlined,
PlusOutlined,
} from '@ant-design/icons-vue';
import { Button, message, Modal } from 'ant-design-vue';
import { useLanguagesApi } from '../../api/useLanguagesApi';
import { useLocalizationsApi } from '../../api/useLocalizationsApi';
import { LanguagesPermissions } from '../../constants/permissions';
defineOptions({
name: 'LocalizationLanguageTable',
});
const permissionGroups = ref<LanguageDto[]>([]);
const pageState = reactive({
current: 1,
size: 10,
total: 0,
});
const abpStore = useAbpStore();
const { Lr } = useLocalization();
const { deserialize } = useLocalizationSerializer();
const { deleteApi, getListApi } = useLanguagesApi();
const { getLocalizationApi } = useLocalizationsApi();
const formOptions: VbenFormProps = {
//
collapsed: false,
handleReset: onReset,
async handleSubmit(params) {
pageState.current = 1;
await onGet(params);
},
schema: [
{
component: 'Input',
fieldName: 'filter',
formItemClass: 'col-span-2 items-baseline',
label: $t('AbpUi.Search'),
},
],
//
showCollapseButton: true,
//
submitOnEnter: true,
};
const gridOptions: VxeGridProps<LanguageDto> = {
columns: [
{
align: 'left',
field: 'cultureName',
minWidth: 150,
title: $t('AbpLocalization.DisplayName:CultureName'),
},
{
align: 'left',
field: 'displayName',
minWidth: 150,
title: $t('AbpLocalization.DisplayName:DisplayName'),
},
{
align: 'left',
field: 'uiCultureName',
minWidth: 150,
title: $t('AbpLocalization.DisplayName:UiCultureName'),
},
{
field: 'action',
fixed: 'right',
slots: { default: 'action' },
title: $t('AbpUi.Actions'),
width: 220,
},
],
exportConfig: {},
keepSource: true,
toolbarConfig: {
custom: true,
export: true,
refresh: false,
zoom: true,
},
};
const gridEvents: VxeGridListeners<LanguageDto> = {
pageChange(params) {
pageState.current = params.currentPage;
pageState.size = params.pageSize;
onPageChange();
},
};
const [LocalizationLanguageModal, modalApi] = useVbenModal({
connectedComponent: defineAsyncComponent(
() => import('./LocalizationLanguageModal.vue'),
),
});
const [Grid, gridApi] = useVbenVxeGrid({
formOptions,
gridEvents,
gridOptions,
});
async function onGet(input?: Record<string, string>) {
try {
gridApi.setLoading(true);
const { items } = await getListApi(input);
pageState.total = items.length;
permissionGroups.value = items.map((item) => {
const localizableString = deserialize(item.displayName);
return {
...item,
displayName: Lr(localizableString.resourceName, localizableString.name),
};
});
onPageChange();
} finally {
gridApi.setLoading(false);
}
}
async function onReset() {
await gridApi.formApi.resetForm();
const input = await gridApi.formApi.getValues();
await onGet(input);
}
function onPageChange() {
const items = permissionGroups.value.slice(
(pageState.current - 1) * pageState.size,
pageState.current * pageState.size,
);
gridApi.setGridOptions({
data: items,
pagerConfig: {
currentPage: pageState.current,
pageSize: pageState.size,
total: pageState.total,
},
});
}
function onCreate() {
modalApi.setData({});
modalApi.open();
}
function onUpdate(row: LanguageDto) {
modalApi.setData(row);
modalApi.open();
}
function onDelete(row: LanguageDto) {
Modal.confirm({
centered: true,
content: `${$t('AbpUi.ItemWillBeDeletedMessageWithFormat', [row.cultureName])}`,
onOk: async () => {
await deleteApi(row.cultureName);
message.success($t('AbpUi.DeletedSuccessfully'));
onChange();
},
title: $t('AbpUi.AreYouSure'),
});
}
async function onChange() {
gridApi.query();
//
const cultureName = abpStore.localization!.currentCulture.cultureName;
const localization = await getLocalizationApi({
cultureName,
});
abpStore.setLocalization(localization);
}
onMounted(onGet);
</script>
<template>
<Grid :table-title="$t('AbpLocalization.Languages')">
<template #toolbar-tools>
<Button
:icon="h(PlusOutlined)"
type="primary"
v-access:code="[LanguagesPermissions.Create]"
@click="onCreate"
>
{{ $t('LocalizationManagement.Language:AddNew') }}
</Button>
</template>
<template #action="{ row }">
<div class="flex flex-row">
<Button
:icon="h(EditOutlined)"
block
type="link"
v-access:code="[LanguagesPermissions.Update]"
@click="onUpdate(row)"
>
{{ $t('AbpUi.Edit') }}
</Button>
<Button
v-if="!row.isStatic"
:icon="h(DeleteOutlined)"
block
danger
type="link"
v-access:code="[LanguagesPermissions.Delete]"
@click="onDelete(row)"
>
{{ $t('AbpUi.Delete') }}
</Button>
</div>
</template>
</Grid>
<LocalizationLanguageModal @change="onChange" />
</template>
<style scoped></style>

10
apps/vben5/packages/@abp/localization/src/constants/permissions.ts

@ -8,3 +8,13 @@ export const ResourcesPermissions = {
/** 更新 */
Update: 'LocalizationManagement.Resource.Update',
};
/** 语言管理权限 */
export const LanguagesPermissions = {
/** 新增 */
Create: 'LocalizationManagement.Language.Create',
Default: 'LocalizationManagement.Language',
/** 删除 */
Delete: 'LocalizationManagement.Language.Delete',
/** 更新 */
Update: 'LocalizationManagement.Language.Update',
};

1
apps/vben5/packages/@abp/localization/src/types/index.ts

@ -1 +1,2 @@
export * from './languages';
export * from './resources';

30
apps/vben5/packages/@abp/localization/src/types/languages.ts

@ -0,0 +1,30 @@
import type { AuditedEntityDto } from '@abp/core';
interface LanguageDto extends AuditedEntityDto<string> {
cultureName: string;
displayName: string;
twoLetterISOLanguageName?: string;
uiCultureName: string;
}
interface LanguageGetListInput {
filter?: string;
}
interface LanguageCreateOrUpdateDto {
displayName: string;
}
interface LanguageCreateDto extends LanguageCreateOrUpdateDto {
cultureName: string;
uiCultureName?: string;
}
type LanguageUpdateDto = LanguageCreateOrUpdateDto;
export type {
LanguageCreateDto,
LanguageDto,
LanguageGetListInput,
LanguageUpdateDto,
};
Loading…
Cancel
Save