@appsbd/vue3-appsbd-ui 1.0.3 → 1.0.4

package/.ai/ai_ref_useToast.md

@@ -1,42 +1,30 @@
-# useToast (Composable)
-
-Provides a procedural API to spawn toast notifications using the globally registered `$toast` instance (usually powered by `vue-toastification`).
-
-## Installation
-
-```javascript
-npm install @vue3-appsbd-ui
-```
-
-## Usage
-
-```html
-<script setup>
-import { useToast } from "@vue3-appsbd-ui";
-
-const { toast } = useToast();
-
-function showNotifications() {
-  toast.success("Profile saved successfully");
-  toast.error("Failed to connect to server", { timeout: 5000 });
-}
-</script>
-
-<template>
-  <button @click="showNotifications">Show Toasts</button>
-</template>
-```
-
-## API Reference
-
-### `toast` Methods
-
-| Method | Signature | Description |
-|---|---|---|
-| `toast(msg, options)` | `Function` | Spawns a default toast notification. |
-| `toast.success(msg, options)` | `Function` | Spawns a success toast notification. |
-| `toast.error(msg, options)` | `Function` | Spawns an error toast notification. |
-| `toast.warning(msg, options)` | `Function` | Spawns a warning toast notification. |
-| `toast.info(msg, options)` | `Function` | Spawns an info toast notification. |
-| `toast.dismiss(id)` | `Function` | Dismisses a specific toast by its ID. |
-| `toast.clear()` | `Function` | Clears all currently visible toasts. |
+# useToast (Composable)
+
+Provides a procedural API to spawn toast notifications using the globally registered `$toast` instance.
+
+## Usage
+
+```html
+<script setup>
+import { useToast } from "@vue3-appsbd-ui";
+
+const { toast } = useToast();
+
+function showNotifications() {
+  toast.success("Profile saved successfully");
+  toast.error("Failed to connect to server", { timeout: 5000 });
+}
+</script>
+```
+
+## API Reference
+
+| Method | Signature | Description |
+|---|---|---|
+| `toast(msg, options)` | `Function` | Spawns a default toast notification. |
+| `toast.success(msg, options)` | `Function` | Spawns a success toast. |
+| `toast.error(msg, options)` | `Function` | Spawns an error toast. |
+| `toast.warning(msg, options)` | `Function` | Spawns a warning toast. |
+| `toast.info(msg, options)` | `Function` | Spawns an info toast. |
+| `toast.dismiss(id)` | `Function` | Dismisses a specific toast by its ID. |
+| `toast.clear()` | `Function` | Clears all currently visible toasts. |

package/AI_REF.md

@@ -0,0 +1,114 @@
+# Appsbd UI - Compact AI Reference
+
+## Purpose
+
+Lightweight index for AI agents working on `vue3-appsbd-ui`.
+For detailed props, events, slots, examples, and usage rules, open the matching per-item file in `.ai/`.
+
+## Setup
+
+```js
+import AppsbdUI from "vue3-appsbd-ui";
+import "vue3-appsbd-ui/dist/style.css";
+
+app.use(AppsbdUI);
+```
+
+Global configuration: `.ai/ai_ref_global_config.md`.
+
+## Reference Lookup
+
+Use this pattern whenever possible:
+
+```txt
+Component/API name -> .ai/ai_ref_[Name].md
+```
+
+Examples:
+
+- `AbModal` -> `.ai/ai_ref_AbModal.md`
+- `AbButton` -> `.ai/ai_ref_AbButton.md`
+- `useToast` -> `.ai/ai_ref_useToast.md`
+- `abTranslate` -> `.ai/ai_ref_abTranslate.md`
+- `AppsbdUIConfigure` -> `.ai/ai_ref_global_config.md`
+
+## Auto-Registered Components
+
+These are globally registered by `app.use(AppsbdUI)`:
+
+`AbButton`, `AbCard`, `AbModal`, `AbProgressbar`, `AbInputField`, `AbNumberField`, `AbField`, `AbCustomField`, `AbDateTimePicker`, `AbFormCheck`, `AbRadioInput`, `AbToggle`, `AbInputTag`, `AbMultiSelect`, `AbPopover`.
+
+All other components/APIs should be explicitly imported unless their detailed `.ai/` reference says otherwise.
+
+## Component References
+
+- `AbAvatar` -> `.ai/ai_ref_AbAvatar.md`
+- `AbBadge` -> `.ai/ai_ref_AbBadge.md`
+- `AbButton` -> `.ai/ai_ref_AbButton.md`
+- `AbCard` -> `.ai/ai_ref_AbCard.md`
+- `AbCarousel` -> `.ai/ai_ref_AbCarousel.md`
+- `AbChart` -> `.ai/ai_ref_AbChart.md`
+- `AbColorPicker` -> `.ai/ai_ref_AbColorPicker.md`
+- `AbConfirmPopover` -> `.ai/ai_ref_AbConfirmPopover.md`
+- `AbCustomField` -> `.ai/ai_ref_AbCustomField.md`
+- `AbDarkModeToggler` -> `.ai/ai_ref_AbDarkModeToggler.md`
+- `AbDateTimePicker` -> `.ai/ai_ref_AbDateTimePicker.md`
+- `AbEasyModal` -> `.ai/ai_ref_AbEasyModal.md`
+- `AbField` -> `.ai/ai_ref_AbField.md`
+- `AbFileUploader` -> `.ai/ai_ref_AbFileUploader.md`
+- `AbFilterPanel` -> `.ai/ai_ref_AbFilterPanel.md`
+- `AbFormCheck` / `AbRadioInput` -> `.ai/ai_ref_AbFormCheck.md`
+- `AbImageRadioInput` -> `.ai/ai_ref_AbImageRadioInput.md`
+- `AbInputField` -> `.ai/ai_ref_AbInputField.md`
+- `AbInputTag` -> `.ai/ai_ref_AbInputTag.md`
+- `AbKbd` -> `.ai/ai_ref_AbKbd.md`
+- `AbKbdGroup` -> `.ai/ai_ref_AbKbdGroup.md`
+- `AbModal` -> `.ai/ai_ref_AbModal.md`
+- `AbMultiSelect` -> `.ai/ai_ref_AbMultiSelect.md`
+- `AbNumberField` -> `.ai/ai_ref_AbNumberField.md`
+- `AbPinInput` -> `.ai/ai_ref_AbPinInput.md`
+- `AbPopover` -> `.ai/ai_ref_AbPopover.md`
+- `AbPricingCard` -> `.ai/ai_ref_AbPricingCard.md`
+- `AbPricingContainer` -> `.ai/ai_ref_AbPricingContainer.md`
+- `AbPricingTable` -> `.ai/ai_ref_AbPricingTable.md`
+- `AbProgressbar` -> `.ai/ai_ref_AbProgressbar.md`
+- `AbScrollbar` -> `.ai/ai_ref_AbScrollbar.md`
+- `AbSettingsForm` -> `.ai/ai_ref_AbSettingsForm.md`
+- `AbSideMenuItem` -> `.ai/ai_ref_AbSideMenuItem.md`
+- `AbSidebar` -> `.ai/ai_ref_AbSidebar.md`
+- `AbSkeleton` -> `.ai/ai_ref_AbSkeleton.md`
+- `AbSlider` -> `.ai/ai_ref_AbSlider.md`
+- `AbTab` -> `.ai/ai_ref_AbTab.md`
+- `AbTable` -> `.ai/ai_ref_AbTable.md`
+- `AbTabs` -> `.ai/ai_ref_AbTabs.md`
+- `AbToggle` -> `.ai/ai_ref_AbToggle.md`
+- `AbTooltip` -> `.ai/ai_ref_AbTooltip.md`
+- `AbWizard` -> `.ai/ai_ref_AbWizard.md`
+- `AbWizardStep` -> `.ai/ai_ref_AbWizardStep.md`
+
+## API References
+
+- `AppsbdUIConfigure` -> `.ai/ai_ref_global_config.md`
+- `useAlert` -> `.ai/ai_ref_useAlert.md`
+- `useToast` -> `.ai/ai_ref_useToast.md`
+- `useTheme` -> `.ai/ai_ref_useTheme.md`
+- `useFileValidator` -> `.ai/ai_ref_useFileValidator.md`
+- `useResponsive` -> `.ai/ai_ref_useResponsive.md`
+- `abEventBus` / `emitterObj` -> `.ai/ai_ref_abEventBus.md`
+- `abTranslate` -> `.ai/ai_ref_abTranslate.md`
+- `abVeeRules` -> `.ai/ai_ref_abVeeRules.md`
+- `abRequestParam` -> `.ai/ai_ref_abRequestParam.md`
+
+## Directives
+
+- `v-tooltip` -> `.ai/ai_ref_AbTooltip.md`
+
+## Maintenance
+
+When a public component/API changes, update:
+
+- matching `.ai/ai_ref_*.md`
+- `AI_REFERENCE.md`
+- playground docs in `playground/components/`
+- this file only when a reference is added, renamed, removed, or auto-registration changes
+