chore: @vben-core/iconify was renamed @vben-core/icons. Add readme.md for some packages

This commit is contained in:
vince
2024-07-14 22:51:10 +08:00
parent 3a91a24e0d
commit 3eb7a8bc6f
68 changed files with 261 additions and 132 deletions

View File

@@ -1,12 +1,12 @@
{
"name": "@vben-core/iconify",
"name": "@vben-core/icons",
"version": "5.0.0",
"homepage": "https://github.com/vbenjs/vue-vben-admin",
"bugs": "https://github.com/vbenjs/vue-vben-admin/issues",
"repository": {
"type": "git",
"url": "git+https://github.com/vbenjs/vue-vben-admin.git",
"directory": "packages/@vben-core/shared/iconify"
"directory": "packages/@vben-core/shared/icons"
},
"license": "MIT",
"type": "module",

View File

@@ -37,7 +37,7 @@
}
},
"dependencies": {
"@vben-core/iconify": "workspace:*",
"@vben-core/icons": "workspace:*",
"@vben-core/shadcn-ui": "workspace:*",
"@vben-core/toolkit": "workspace:*",
"@vben-core/typings": "workspace:*",

View File

@@ -2,7 +2,7 @@
import type { CSSProperties } from 'vue';
import { computed, useSlots } from 'vue';
import { IcRoundMenu } from '@vben-core/iconify';
import { IcRoundMenu } from '@vben-core/icons';
import { VbenIconButton } from '@vben-core/shadcn-ui';
interface Props {

View File

@@ -1,5 +1,5 @@
<script setup lang="ts">
import { MdiMenuClose, MdiMenuOpen } from '@vben-core/iconify';
import { MdiMenuClose, MdiMenuOpen } from '@vben-core/icons';
interface Props {
theme: string;

View File

@@ -1,5 +1,5 @@
<script setup lang="ts">
import { MdiPin, MdiPinOff } from '@vben-core/iconify';
import { MdiPin, MdiPinOff } from '@vben-core/icons';
interface Props {
theme: string;

View File

@@ -38,7 +38,7 @@
},
"dependencies": {
"@vben-core/hooks": "workspace:*",
"@vben-core/iconify": "workspace:*",
"@vben-core/icons": "workspace:*",
"@vben-core/shadcn-ui": "workspace:*",
"@vben-core/toolkit": "workspace:*",
"@vben-core/typings": "workspace:*",

View File

@@ -19,7 +19,7 @@ import {
} from 'vue';
import { useNamespace } from '@vben-core/hooks';
import { IcRoundMoreHoriz } from '@vben-core/iconify';
import { IcRoundMoreHoriz } from '@vben-core/icons';
import { isHttpUrl } from '@vben-core/toolkit';
import { UseResizeObserverReturn, useResizeObserver } from '@vueuse/core';

View File

@@ -7,7 +7,7 @@ import { useNamespace } from '@vben-core/hooks';
import {
IcRoundChevronRight,
IcRoundKeyboardArrowDown,
} from '@vben-core/iconify';
} from '@vben-core/icons';
import { VbenIcon } from '@vben-core/shadcn-ui';
import { useMenuContext } from '../hooks';

View File

@@ -43,7 +43,7 @@
},
"dependencies": {
"@radix-icons/vue": "^1.0.0",
"@vben-core/iconify": "workspace:*",
"@vben-core/icons": "workspace:*",
"@vben-core/toolkit": "workspace:*",
"@vben-core/typings": "workspace:*",
"@vueuse/core": "^10.11.0",

View File

@@ -3,7 +3,7 @@ import type { BacktopProps } from './backtop';
import { computed } from 'vue';
import { IcRoundArrowUpward } from '@vben-core/iconify';
import { IcRoundArrowUpward } from '@vben-core/icons';
import { VbenButton } from '../button';
import { useBackTop } from './use-backtop';

View File

@@ -1,7 +1,7 @@
<script lang="ts" setup>
import type { IBreadcrumb } from './interface';
import { IcRoundKeyboardArrowDown } from '@vben-core/iconify';
import { IcRoundKeyboardArrowDown } from '@vben-core/icons';
import {
Breadcrumb,
BreadcrumbItem,

View File

@@ -2,7 +2,7 @@
import type { HTMLAttributes } from 'vue';
import { computed } from 'vue';
import { MdiLoading } from '@vben-core/iconify';
import { MdiLoading } from '@vben-core/icons';
import {
type ButtonVariants,
buttonVariants,

View File

@@ -1,5 +1,5 @@
<script lang="ts" setup>
import { IcRoundFullscreen, IcRoundFullscreenExit } from '@vben-core/iconify';
import { IcRoundFullscreen, IcRoundFullscreenExit } from '@vben-core/icons';
import { useFullscreen } from '@vueuse/core';

View File

@@ -1,7 +1,7 @@
<script setup lang="ts">
import { type Component, computed } from 'vue';
import { Icon, IconDefault } from '@vben-core/iconify';
import { Icon, IconDefault } from '@vben-core/icons';
import { isHttpUrl, isObject, isString } from '@vben-core/toolkit';
const props = defineProps<{

View File

@@ -1,10 +1,7 @@
<script setup lang="ts">
import { ref, useSlots } from 'vue';
import {
IcOutlineVisibility,
IcOutlineVisibilityOff,
} from '@vben-core/iconify';
import { IcOutlineVisibility, IcOutlineVisibilityOff } from '@vben-core/icons';
import {
type InputProps,
VbenInput,

View File

@@ -44,7 +44,7 @@ function handleScroll(event: Event) {
:class="{
'opacity-100': !isAtTop,
}"
class="scrollbar-top-shadow pointer-events-none absolute top-0 z-10 h-16 w-full opacity-0 transition-opacity duration-1000 ease-in-out will-change-[opacity]"
class="scrollbar-top-shadow pointer-events-none absolute top-0 z-10 h-12 w-full opacity-0 transition-opacity duration-300 ease-in-out will-change-[opacity]"
></div>
<slot></slot>
<div
@@ -52,7 +52,7 @@ function handleScroll(event: Event) {
:class="{
'opacity-100': !isAtTop && !isAtBottom,
}"
class="scrollbar-bottom-shadow pointer-events-none absolute bottom-0 z-10 h-16 w-full opacity-0 transition-opacity duration-1000 ease-in-out will-change-[opacity]"
class="scrollbar-bottom-shadow pointer-events-none absolute bottom-0 z-10 h-12 w-full opacity-0 transition-opacity duration-300 ease-in-out will-change-[opacity]"
></div>
<ScrollBar v-if="horizontal" orientation="horizontal" />
</ScrollArea>

View File

@@ -38,7 +38,7 @@
},
"dependencies": {
"@vben-core/hooks": "workspace:*",
"@vben-core/iconify": "workspace:*",
"@vben-core/icons": "workspace:*",
"@vben-core/shadcn-ui": "workspace:*",
"@vben-core/typings": "workspace:*",
"vue": "^3.4.31"

View File

@@ -5,7 +5,7 @@ import type { TabConfig, TabsProps } from '../../types';
import { computed, nextTick, onMounted, ref, watch } from 'vue';
import { IcRoundClose, MdiPin } from '@vben-core/iconify';
import { IcRoundClose, MdiPin } from '@vben-core/icons';
import { VbenContextMenu, VbenIcon } from '@vben-core/shadcn-ui';
interface Props extends TabsProps {}
@@ -174,7 +174,7 @@ function handleUnpinTab(tab: TabConfig) {
<!-- tab-item-main -->
<div
class="tabs-chrome__item-main absolute left-0 right-0 z-[2] mx-[calc(var(--gap)*2)] my-0 flex h-full items-center overflow-hidden rounded-tl-[5px] rounded-tr-[5px] duration-150 group-hover:pr-3"
class="tabs-chrome__item-main group-[.is-active]:text-primary text-accent-foreground dark:group-[.is-active]:text-accent-foreground absolute left-0 right-0 z-[2] mx-[calc(var(--gap)*2)] my-0 flex h-full items-center overflow-hidden rounded-tl-[5px] rounded-tr-[5px] duration-150 group-hover:pr-3"
>
<VbenIcon
v-if="showIcon"
@@ -184,7 +184,7 @@ function handleUnpinTab(tab: TabConfig) {
/>
<span
class="tabs-chrome__label text-accent-foreground ml-[var(--gap)] flex-1 overflow-hidden whitespace-nowrap"
class="tabs-chrome__label ml-[var(--gap)] flex-1 overflow-hidden whitespace-nowrap"
>
{{ tab.title }}
</span>

View File

@@ -3,7 +3,7 @@ import type { TabConfig, TabsProps } from '../../types';
import { computed } from 'vue';
import { IcRoundClose, MdiPin } from '@vben-core/iconify';
import { IcRoundClose, MdiPin } from '@vben-core/icons';
import { VbenContextMenu, VbenIcon, VbenScrollbar } from '@vben-core/shadcn-ui';
import { TabDefinition } from '@vben-core/typings';
@@ -113,7 +113,7 @@ function handleUnpinTab(tab: TabConfig) {
<!-- tab-item-main -->
<div
class="mx-3 mr-3 flex h-full items-center overflow-hidden rounded-tl-[5px] rounded-tr-[5px] pr-3 transition-all duration-300"
class="group-[.is-active]:text-primary dark:group-[.is-active]:text-accent-foreground text-accent-foreground mx-3 mr-3 flex h-full items-center overflow-hidden rounded-tl-[5px] rounded-tr-[5px] pr-3 transition-all duration-300"
>
<!-- <div
class="mx-3 ml-3 mr-2 flex h-full items-center overflow-hidden rounded-tl-[5px] rounded-tr-[5px] transition-all duration-300 group-hover:mr-2 group-hover:pr-4 group-[.is-active]:pr-4"
@@ -125,9 +125,7 @@ function handleUnpinTab(tab: TabConfig) {
fallback
/>
<span
class="text-accent-foreground flex-1 overflow-hidden whitespace-nowrap"
>
<span class="flex-1 overflow-hidden whitespace-nowrap">
{{ tab.title }}
</span>
</div>

View File

@@ -1,7 +1,7 @@
<script lang="ts" setup>
import type { DropdownMenuProps } from '@vben-core/shadcn-ui';
import { IcRoundKeyboardArrowDown } from '@vben-core/iconify';
import { IcRoundKeyboardArrowDown } from '@vben-core/icons';
import { VbenDropdownMenu } from '@vben-core/shadcn-ui';
defineProps<DropdownMenuProps>();

View File

@@ -1,5 +1,5 @@
<script lang="ts" setup>
import { IcRoundFitScreen, IcTwotoneFitScreen } from '@vben-core/iconify';
import { IcRoundFitScreen, IcTwotoneFitScreen } from '@vben-core/icons';
const screen = defineModel<boolean>('screen');

View File

@@ -1 +0,0 @@
# packages

View File

@@ -0,0 +1,19 @@
# @vben/constants
用于多个 `app` 公用的常量,继承了 `@vben-core/constants` 的所有能力。业务上有通用常量可以放在这里。
## 用法
### 添加依赖
```bash
# 进入目标应用目录,例如 apps/xxxx-app
# cd apps/xxxx-app
pnpm add @vben/hooks --workspace
```
### 使用
```ts
import { useNamespace } from '@vben/hooks';
```

View File

@@ -38,7 +38,7 @@
},
"dependencies": {
"@vben-core/hooks": "workspace:*",
"@vben-core/iconify": "workspace:*",
"@vben-core/icons": "workspace:*",
"@vben-core/locales": "workspace:*",
"@vben-core/shadcn-ui": "workspace:*",
"@vben/constants": "workspace:*",

View File

@@ -1,5 +1,5 @@
<script setup lang="ts">
import { MdiGithub, MdiGoogle, MdiQqchat, MdiWechat } from '@vben-core/iconify';
import { MdiGithub, MdiGoogle, MdiQqchat, MdiWechat } from '@vben-core/icons';
import { $t } from '@vben-core/locales';
import { VbenIconButton } from '@vben-core/shadcn-ui';

View File

@@ -4,7 +4,7 @@ import type { FallbackProps } from './fallback';
import { computed, defineAsyncComponent } from 'vue';
import { useRouter } from 'vue-router';
import { IcRoundArrowBackIosNew, IcRoundRefresh } from '@vben-core/iconify';
import { IcRoundArrowBackIosNew, IcRoundRefresh } from '@vben-core/icons';
import { $t } from '@vben-core/locales';
import { VbenButton } from '@vben-core/shadcn-ui';

View File

@@ -38,7 +38,7 @@
},
"dependencies": {
"@vben-core/helpers": "workspace:*",
"@vben-core/iconify": "workspace:*",
"@vben-core/icons": "workspace:*",
"@vben-core/layout-ui": "workspace:*",
"@vben-core/locales": "workspace:*",
"@vben-core/menu-ui": "workspace:*",

View File

@@ -20,7 +20,7 @@ import {
MdiFormatHorizontalAlignRight,
MdiPin,
MdiPinOff,
} from '@vben-core/iconify';
} from '@vben-core/icons';
import { $t, useI18n } from '@vben-core/locales';
import { updatePreferences, usePreferences } from '@vben-core/preferences';
import {

View File

@@ -1,7 +1,7 @@
<script setup lang="ts">
import type { BuiltinThemeType } from '@vben-core/typings';
import { IcRoundColorLens } from '@vben-core/iconify';
import { IcRoundColorLens } from '@vben-core/icons';
import {
COLOR_PRESETS,
preferences,

View File

@@ -9,7 +9,7 @@ import {
IcRoundSearch,
IcRoundSubdirectoryArrowLeft,
MdiKeyboardEsc,
} from '@vben-core/iconify';
} from '@vben-core/icons';
import { $t } from '@vben-core/locales';
import {
Dialog,

View File

@@ -4,7 +4,7 @@ import type { MenuRecordRaw } from '@vben-core/typings';
import { nextTick, onMounted, ref, shallowRef, watch } from 'vue';
import { useRouter } from 'vue-router';
import { IcRoundClose, IcRoundSearchOff } from '@vben-core/iconify';
import { IcRoundClose, IcRoundSearchOff } from '@vben-core/icons';
import { $t } from '@vben-core/locales';
import { VbenIcon, VbenScrollbar } from '@vben-core/shadcn-ui';
import { mapTree, traverseTreeValues, uniqueByField } from '@vben-core/toolkit';

View File

@@ -1,7 +1,7 @@
<script setup lang="ts">
import type { SupportedLanguagesType } from '@vben-core/typings';
import { IcBaselineLanguage } from '@vben-core/iconify';
import { IcBaselineLanguage } from '@vben-core/icons';
import { loadLocaleMessages } from '@vben-core/locales';
import {
SUPPORT_LANGUAGES,

View File

@@ -4,7 +4,7 @@ import type { AuthPageLayoutType } from '@vben-core/typings';
import { computed } from 'vue';
import { MdiDockBottom, MdiDockLeft, MdiDockRight } from '@vben-core/iconify';
import { MdiDockBottom, MdiDockLeft, MdiDockRight } from '@vben-core/icons';
import { $t } from '@vben-core/locales';
import {
preferences,

View File

@@ -1,7 +1,7 @@
<script setup lang="ts">
import { computed, reactive, ref, watchEffect } from 'vue';
import { IcRoundLock } from '@vben-core/iconify';
import { IcRoundLock } from '@vben-core/icons';
import { $t, useI18n } from '@vben-core/locales';
import {
VbenAvatar,

View File

@@ -4,7 +4,7 @@ import type { NotificationItem } from './types';
import {
IcRoundMarkEmailRead,
IcRoundNotificationsNone,
} from '@vben-core/iconify';
} from '@vben-core/icons';
import { $t } from '@vben-core/locales';
import {
VbenButton,

View File

@@ -3,7 +3,7 @@ import type { SelectOption } from '@vben-core/typings';
import { useSlots } from 'vue';
import { MdiQuestionMarkCircleOutline } from '@vben-core/iconify';
import { MdiQuestionMarkCircleOutline } from '@vben-core/icons';
import { Input, VbenTooltip } from '@vben-core/shadcn-ui';
defineOptions({

View File

@@ -3,7 +3,7 @@ import type { LayoutType } from '@vben-core/typings';
import { type Component, computed } from 'vue';
import { MdiQuestionMarkCircleOutline } from '@vben-core/iconify';
import { MdiQuestionMarkCircleOutline } from '@vben-core/icons';
import { $t } from '@vben-core/locales';
import { VbenTooltip } from '@vben-core/shadcn-ui';

View File

@@ -3,7 +3,7 @@ import type { SelectOption } from '@vben-core/typings';
import { useSlots } from 'vue';
import { MdiQuestionMarkCircleOutline } from '@vben-core/iconify';
import { MdiQuestionMarkCircleOutline } from '@vben-core/icons';
import {
NumberField,
NumberFieldContent,

View File

@@ -3,7 +3,7 @@ import type { SelectOption } from '@vben-core/typings';
import { useSlots } from 'vue';
import { MdiQuestionMarkCircleOutline } from '@vben-core/iconify';
import { MdiQuestionMarkCircleOutline } from '@vben-core/icons';
import {
Select,
SelectContent,

View File

@@ -1,7 +1,7 @@
<script setup lang="ts">
import { useSlots } from 'vue';
import { MdiQuestionMarkCircleOutline } from '@vben-core/iconify';
import { MdiQuestionMarkCircleOutline } from '@vben-core/icons';
import { Switch, VbenTooltip } from '@vben-core/shadcn-ui';
defineOptions({

View File

@@ -3,7 +3,7 @@ import type { BuiltinThemeType } from '@vben-core/typings';
import { computed, ref } from 'vue';
import { MdiEditBoxOutline } from '@vben-core/iconify';
import { MdiEditBoxOutline } from '@vben-core/icons';
import { $t } from '@vben-core/locales';
import {
BUILT_IN_THEME_PRESETS,

View File

@@ -7,7 +7,7 @@ import {
IcRoundMotionPhotosAuto,
IcRoundWbSunny,
MdiMoonAndStars,
} from '@vben-core/iconify';
} from '@vben-core/icons';
import { $t } from '@vben-core/locales';
import SwitchItem from '../switch-item.vue';

View File

@@ -13,7 +13,7 @@ import type {
import { computed, ref } from 'vue';
import { IcRoundFolderCopy, IcRoundRestartAlt } from '@vben-core/iconify';
import { IcRoundFolderCopy, IcRoundRestartAlt } from '@vben-core/icons';
import { $t, loadLocaleMessages } from '@vben-core/locales';
import {
clearPreferencesCache,

View File

@@ -5,7 +5,7 @@ import {
IcRoundMotionPhotosAuto,
IcRoundWbSunny,
MdiMoonAndStars,
} from '@vben-core/iconify';
} from '@vben-core/icons';
import { $t } from '@vben-core/locales';
import {
preferences,

View File

@@ -8,7 +8,7 @@ import {
IcRoundLock,
IcRoundLogout,
IcRoundSettingsSuggest,
} from '@vben-core/iconify';
} from '@vben-core/icons';
import { $t } from '@vben-core/locales';
import { preferences, usePreferences } from '@vben-core/preferences';
import {

19
packages/hooks/README.md Normal file
View File

@@ -0,0 +1,19 @@
# @vben/hooks
用于多个 `app` 公用的 hook继承了 `@vben-core/hooks` 的所有能力。业务上有通用 hooks 可以放在这里。
## 用法
### 添加依赖
```bash
# 进入目标应用目录,例如 apps/xxxx-app
# cd apps/xxxx-app
pnpm add @vben/hooks --workspace
```
### 使用
```ts
import { useNamespace } from '@vben/hooks';
```

19
packages/icons/README.md Normal file
View File

@@ -0,0 +1,19 @@
# @vben/icons
用于多个 `app` 公用的图标文件,继承了 `@vben-core/icons` 的所有能力。业务上有通用图标可以放在这里。
## 用法
### 添加依赖
```bash
# 进入目标应用目录,例如 apps/xxxx-app
# cd apps/xxxx-app
pnpm add @vben/icons --workspace
```
### 使用
```ts
import { IcRoundClose } from '@vben/icons';
```

View File

@@ -35,6 +35,6 @@
}
},
"dependencies": {
"@vben-core/iconify": "workspace:*"
"@vben-core/icons": "workspace:*"
}
}

View File

@@ -1 +1 @@
export * from '@vben-core/iconify';
export * from '@vben-core/icons';

View File

@@ -1,4 +1,4 @@
import { createIconifyIcon } from '@vben-core/iconify';
import { createIconifyIcon } from '@vben-core/icons';
import { loadSvgIcons } from './load';

View File

@@ -1,7 +1,7 @@
import {
addIcon,
// addCollection
} from '@vben-core/iconify';
} from '@vben-core/icons';
// addCollection({
// prefix: 'mdi',

19
packages/styles/README.md Normal file
View File

@@ -0,0 +1,19 @@
# @vben/styles
用于多个 `app` 公用的样式文件,继承了 `@vben-core/design` 的所有能力。业务上有通用的样式文件可以放在这里。
## 用法
### 添加依赖
```bash
# 进入目标应用目录,例如 apps/xxxx-app
# cd apps/xxxx-app
pnpm add @vben/styles --workspace
```
### 使用
```ts
import '@vben/styles';
```

20
packages/types/README.md Normal file
View File

@@ -0,0 +1,20 @@
# @vben/types
用于多个 `app` 公用的工具类型,继承了 `@vben-core/typings` 的所有能力。业务上有通用的类型定义可以放在这里。
## 用法
### 添加依赖
```bash
# 进入目标应用目录,例如 apps/xxxx-app
# cd apps/xxxx-app
pnpm add @vben/types --workspace
```
### 使用
```ts
// 推荐加上 type
import type { SelectOption } from '@vben/types';
```

19
packages/utils/README.md Normal file
View File

@@ -0,0 +1,19 @@
# @vben/utils
用于多个 `app` 公用的工具包,继承了 `@vben-core/toolkit` 的所有能力。业务上有通用的工具函数可以放在这里。
## 用法
### 添加依赖
```bash
# 进入目标应用目录,例如 apps/xxxx-app
# cd apps/xxxx-app
pnpm add @vben/utils --workspace
```
### 使用
```ts
import { isString } from '@vben/utils';
```