@appsbd/vue3-appsbd-ui

中文文档
2.0.5发布于 2026/11/05MITESM + CJS零依赖近 30 天下载 2155

Reusable Vue 3 component library

原始使用文档
文档目录16 节
  1. 🚀 Key Features
  2. 📦 Installation
  3. Peer Dependencies
  4. 🤖 AI Assistant Integration
  5. What gets installed
  6. Available slash commands
  7. Optional: enable additional AI tools
  8. Manual reference
  9. 🛠️ Setup
  10. Applying a Theme Skin (optional)
  11. 🧩 Core Components & Composables
  12. Toast Notifications
  13. Global Alerts
  14. Theme Management
  15. 📚 Component Reference
  16. 📄 License

Vue 3 Appsbd UI Library

A premium, reusable Vue 3 component library built for high-performance enterprise applications. Leverages Vite, SCSS, and Bootstrap 5 to provide a rich set of UI components with built-in Dark Mode and RTL support. version 1.0.8

🚀 Key Features

  • Vue 3 Composition API: Optimized for performance and flexibility.
  • Dynamic Theming: Full dark mode support using Bootstrap's data-bs-theme.
  • RTL Ready: Built with CSS logical properties for global accessibility.
  • Plugin System: custom-built global systems for Toasts and Alerts.
  • Enterprise Ready: Includes complex components like MultiSelect, DatePicker, Wizard, Pricing Tables, and Filter Panels.
  • Themable Skins: 10 prebuilt color skins (default, green, red, cyan, purple, violet, pink, orange, gray, black) shipped as standalone CSS under dist/skins/.

📦 Installation

npm install @appsbd/vue3-appsbd-ui

Peer Dependencies

Ensure you have the following installed in your project:

npm install bootstrap bootstrap-icons vee-validate @vee-validate/rules vue-router vue3-gettext @lucide/vue tiny-emitter @appsbd/vue3-elite-grid

🤖 AI Assistant Integration

Installing this library automatically copies AI skills into your project so Claude Code and Agent-based tools can generate correct component code without guessing props or imports.

What gets installed

Running npm install @appsbd/vue3-appsbd-ui copies the following automatically:

DestinationPurpose
.claude/commands/Slash commands for Claude Code (/use-appsbd-ui, /generate-module)
.claude/skills/Skills auto-detected by Claude Code
.agent/workflows/Workflow commands for Agent-based tools
.agent/skills/Skills for Agent-based tools

Available slash commands

CommandDescription
/use-appsbd-uiLoads component reference before generating any code — always run this first
/generate-moduleScaffolds a full CRUD module (List + Form + Composable) for a given entity

Example:

/generate-module

Module: Invoice
Fields:
- title (text, required)
- amount (number, required, min: 0)
- status (select: Draft | Sent | Paid, required)
- due_date (date)

API: /api/invoices
Output: src/modules/invoices/

Optional: enable additional AI tools

To also install skills for Cursor or Windsurf, pass APPSBD_AGENTS during install:

APPSBD_AGENTS=cursor npm install @appsbd/vue3-appsbd-ui
APPSBD_AGENTS=cursor,windsurf npm install @appsbd/vue3-appsbd-ui

Or run the setup script any time after install:

node node_modules/@appsbd/vue3-appsbd-ui/scripts/setup.js --cursor --windsurf

Manual reference

If you prefer not to use auto-installed skills, the reference files are included in the package:

  • node_modules/@appsbd/vue3-appsbd-ui/AI_REF.md — compact component index (~500 tokens, start here)
  • node_modules/@appsbd/vue3-appsbd-ui/AI_REFERENCE.md — full table with descriptions
  • node_modules/@appsbd/vue3-appsbd-ui/.ai/ai_ref_[Name].md — per-component props/events/slots

Point your AI to read AI_REF.md first, then the specific .ai/ file for the component you need.

🛠️ Setup

Register the library and its styles in your main entry file (e.g., main.js):

import { createApp } from "vue";
import AppsbdUI from "@appsbd/vue3-appsbd-ui";
import "@appsbd/vue3-appsbd-ui/style.css";

const app = createApp(App);
app.use(AppsbdUI);
app.mount("#app");

Applying a Theme Skin (optional)

// Default skin
import "@appsbd/vue3-appsbd-ui/dist/skins/default.css";

// Or any other prebuilt skin
import "@appsbd/vue3-appsbd-ui/dist/skins/purple.css";

🧩 Core Components & Composables

Toast Notifications

The library includes a robust custom toast system with pause-on-hover and pause-on-focus-loss features.

import { useToast } from "@appsbd/vue3-appsbd-ui";
const { toast } = useToast();

toast.success("Changes saved!", { timeout: 3000 });
toast.error("An error occurred", { position: "top-center" });

Global Alerts

Integrated SweetAlert2 system focused on aesthetic consistency.

import { useAlert } from "@appsbd/vue3-appsbd-ui";
const { alert } = useAlert();

alert.success("Success!", "Your profile has been updated.");

Theme Management

Easily toggle between light and dark modes.

import { useTheme } from "@appsbd/vue3-appsbd-ui";
const { isDark, toggleTheme } = useTheme();

📚 Component Reference

ComponentDescription
AbAvatarProfile imagery with status indicators and size variants.
AbBadgeLabeling component for status and counts.
AbButtonHighly customizable button with loading states.
AbCardFlexible container for grouped content (supports tile / item / insight variants via CSS classes).
AbCarouselResponsive carousel / slider.
AbColorPickerVisual color selection interface.
AbConfirmPopoverMulti-step interactive popover for confirmations and async flows.
AbCustomFieldBase wrapper for creating custom form inputs.
AbDarkModeTogglerOne-click light/dark theme toggle.
AbDateTimePickerFull-featured date and time selection (powered by v-calendar).
AbDropdownCustom styled dropdown menus.
AbEasyModalLightweight modal for simple dialogs.
AbFieldGeneric form field wrapper with label / help / error slots.
AbFileUploaderDrag-and-drop file upload interface.
AbFilterPanelComprehensive filtering UI for data-heavy views.
AbFormCheck / AbRadioInputStandardized checkbox / radio controls.
AbImageRadioInputRadio group rendered as selectable image tiles.
AbInputFieldHigh-quality text input with validation/feedback.
AbInputTagTagging / multiple-value input field.
AbKbd / AbKbdGroupKeyboard shortcut display primitives.
AbModalSophisticated dialog system with transitions.
AbMultiSelectAdvanced searchable multi-selection dropdown (built-in, replaces @vueform/multiselect).
AbNavLinkNavigation link for sidebars and menus.
AbNumberFieldNumeric input; variant="stepper" adds increment/decrement step controls.
AbPinInputSegmented OTP / PIN entry input.
AbPopoverFloating popover powered by floating-vue.
AbPricingCard / AbPricingContainer / AbPricingTableComposable pricing-plan building blocks.
AbProgressbarSmooth, animated progress tracking.
AbScrollbarStyled custom scroll container.
AbSettingsFormOpinionated settings / preferences form layout.
AbSidebar / AbSideMenuItemDynamic sidebar navigation components.
AbSkeletonLoading-state skeleton placeholders.
AbSliderRange selection slider for numerical values.
AbTableData table with the project's default styling.
AbTabs / AbTabResponsive tabbed interface.
AbToastHigh-performance notification system.
AbToggleAccessible switch/toggle component.
AbTooltipFloating tooltip powered by floating-vue.
AbWizard / AbWizardStepMulti-step wizard flow.

📄 License

MIT

版本与发布记录

@appsbd/vue3-appsbd-ui 共发布 31 个版本,首次发布于 2026/04/23;过去 12 个月发布了 31 个版本。

版本发布日期距今
2.0.5latest2026/11/053 天前
2.0.42026/11/043 天前
2.0.32026/11/043 天前
2.0.22026/11/043 天前
2.0.12026/11/034 天前
2.0.02026/11/034 天前

关于 @appsbd/vue3-appsbd-ui 的常见问题

@appsbd/vue3-appsbd-ui 是什么?

Reusable Vue 3 component library

如何安装 @appsbd/vue3-appsbd-ui?

在项目目录运行 npm install @appsbd/vue3-appsbd-ui,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:vue(>=3.3.0)、echarts(>=5.5.0)、bootstrap(>=5.3.7)、vue-router(>=4.5.0)、@lucide/vue(>=1.28.0)、vue-echarts(>=6.6.9)、tiny-emitter(>=2.1.0)、vee-validate(>=4.15.1)、vue3-gettext(>=2.4.0)、@vee-validate/rules(>=4.15.1)、@appsbd/vue3-elite-grid(>=3.0.3)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@appsbd/vue3-appsbd-ui 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/appsbd__vue3-appsbd-ui 是否存在。

@appsbd/vue3-appsbd-ui 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@appsbd/vue3-appsbd-ui 可以商用吗?

@appsbd/vue3-appsbd-ui 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@appsbd/vue3-appsbd-ui 的下载量有多少?

根据 npm 官方下载统计,@appsbd/vue3-appsbd-ui 在 2026/10/07 – 2026/11/05 这 30 天内被下载 2,155 次,日均约 72 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@appsbd/vue3-appsbd-ui 还在维护吗?

最新版本 2.0.5 发布于 2026/11/05(3 天前);至今共发布 31 个版本,其中过去 12 个月发布了 31 个;首次发布于 2026/04/23。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。