@appsbd/vue3-appsbd-ui 1.0.1 → 1.0.3

package/.ai/ai_ref_AbToggle.md

@@ -1,65 +1,65 @@
-# AbToggle — AI Reference
-
-Accessible switch/toggle control. Supports title + description layout and custom `trueValue` / `falseValue` values (defaults to `"Y"` / `"N"`).
-
-## Installation
-
-Globally registered by the plugin.
-
-## Usage
-
-```vue
-<template>
-  <ab-toggle
-    v-model="settings.notifications"
-    name="notifications"
-    title="Email notifications"
-    description="Receive weekly digest emails."
-  />
-
-  <!-- Boolean values -->
-  <ab-toggle
-    v-model="isActive"
-    name="active"
-    :true-value="true"
-    :false-value="false"
-    label="Active"
-  />
-</template>
-```
-
-## Props
-
-| Name | Type | Default | Description |
-| --- | --- | --- | --- |
-| `modelValue` | `any` | — | v-model binding. |
-| `label` | `String \| null` | `null` | Field label (above the toggle). |
-| `val` | `any` | `"N"` | Initial value when `modelValue` is empty. |
-| `name` | `String` | **required** | VeeValidate field name. |
-| `containerClass` | `String` | `"mb-3"` | Wrapper class. |
-| `size` | `String` | `"md"` | Toggle size. |
-| `trueValue` | `any` | `"Y"` | Value when checked. |
-| `falseValue` | `any` | `"N"` | Value when unchecked. |
-| `title` | `String \| null` | `null` | Title next to the toggle. |
-| `description` | `String \| null` | `null` | Description under the title. |
-| `hints` | `String \| null` | `null` | Helper text. |
-
-## Events
-
-| Event | Payload | Description |
-| --- | --- | --- |
-| `update:modelValue` | `value` | v-model sync. |
-
-## Slots
-
-| Name | Description |
-| --- | --- |
-| `label` | Custom label. |
-| `title` | Custom title. |
-| `description` | Custom description. |
-| `descriptionContainer` | Wraps the entire title + description block. |
-| `hints` | Custom hints. |
-
-## v-model
-
-Yes.
+# AbToggle — AI Reference
+
+Accessible switch/toggle control. Supports title + description layout and custom `trueValue` / `falseValue` values (defaults to `"Y"` / `"N"`).
+
+## Installation
+
+Globally registered by the plugin.
+
+## Usage
+
+```vue
+<template>
+  <ab-toggle
+    v-model="settings.notifications"
+    name="notifications"
+    title="Email notifications"
+    description="Receive weekly digest emails."
+  />
+
+  <!-- Boolean values -->
+  <ab-toggle
+    v-model="isActive"
+    name="active"
+    :true-value="true"
+    :false-value="false"
+    label="Active"
+  />
+</template>
+```
+
+## Props
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| `modelValue` | `any` | — | v-model binding. |
+| `label` | `String \| null` | `null` | Field label (above the toggle). |
+| `val` | `any` | `"N"` | Initial value when `modelValue` is empty. |
+| `name` | `String` | **required** | VeeValidate field name. |
+| `containerClass` | `String` | `"mb-3"` | Wrapper class. |
+| `size` | `String` | `"md"` | Toggle size. |
+| `trueValue` | `any` | `"Y"` | Value when checked. |
+| `falseValue` | `any` | `"N"` | Value when unchecked. |
+| `title` | `String \| null` | `null` | Title next to the toggle. |
+| `description` | `String \| null` | `null` | Description under the title. |
+| `hints` | `String \| null` | `null` | Helper text. |
+
+## Events
+
+| Event | Payload | Description |
+| --- | --- | --- |
+| `update:modelValue` | `value` | v-model sync. |
+
+## Slots
+
+| Name | Description |
+| --- | --- |
+| `label` | Custom label. |
+| `title` | Custom title. |
+| `description` | Custom description. |
+| `descriptionContainer` | Wraps the entire title + description block. |
+| `hints` | Custom hints. |
+
+## v-model
+
+Yes.

package/.ai/ai_ref_AbTooltip.md

@@ -1,53 +1,53 @@
-# AbTooltip — AI Reference
-
-Programmatic tooltip component. Complements the `v-tooltip` directive — use this when you need slot-driven rich content or interactive tooltips.
-
-## Installation
-
-Globally registered by the plugin.
-
-## Usage
-
-```vue
-<template>
-  <!-- Simple -->
-  <ab-tooltip content="Save changes" placement="top">
-    <ab-button class="btn-primary"><i class="bi bi-save"></i></ab-button>
-  </ab-tooltip>
-
-  <!-- Rich content -->
-  <ab-tooltip placement="bottom" interactive>
-    <ab-button class="btn-outline-secondary">Info</ab-button>
-    <template #content>
-      <strong>Pro tip</strong>
-      <p>Press <ab-kbd>⌘</ab-kbd> + <ab-kbd>S</ab-kbd> to save.</p>
-    </template>
-  </ab-tooltip>
-</template>
-```
-
-## Props
-
-| Name | Type | Default | Description |
-| --- | --- | --- | --- |
-| `content` | `String` | `""` | Tooltip text (used when `#content` slot is absent). |
-| `placement` | `String` | `"top"` | `top`, `bottom`, `left`, `right`, or `auto-*`. |
-| `offset` | `Number \| String` | `8` | Offset from the reference element. |
-| `disabled` | `Boolean` | `false` | Disable the tooltip. |
-| `arrow` | `Boolean` | `true` | Show the arrow pointer. |
-| `interactive` | `Boolean` | `false` | Allow hovering the tooltip without it hiding. |
-
-## Events
-
-None.
-
-## Slots
-
-| Name | Description |
-| --- | --- |
-| `default` | Trigger element. |
-| `content` | Tooltip body (overrides the `content` prop). |
-
-## See also
-
-- `v-tooltip` directive for simple string hints (`<ab-button v-tooltip="'Hello'">`).
+# AbTooltip — AI Reference
+
+Programmatic tooltip component. Complements the `v-tooltip` directive — use this when you need slot-driven rich content or interactive tooltips.
+
+## Installation
+
+Globally registered by the plugin.
+
+## Usage
+
+```vue
+<template>
+  <!-- Simple -->
+  <ab-tooltip content="Save changes" placement="top">
+    <ab-button class="btn-primary"><i class="bi bi-save"></i></ab-button>
+  </ab-tooltip>
+
+  <!-- Rich content -->
+  <ab-tooltip placement="bottom" interactive>
+    <ab-button class="btn-outline-secondary">Info</ab-button>
+    <template #content>
+      <strong>Pro tip</strong>
+      <p>Press <ab-kbd>⌘</ab-kbd> + <ab-kbd>S</ab-kbd> to save.</p>
+    </template>
+  </ab-tooltip>
+</template>
+```
+
+## Props
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| `content` | `String` | `""` | Tooltip text (used when `#content` slot is absent). |
+| `placement` | `String` | `"top"` | `top`, `bottom`, `left`, `right`, or `auto-*`. |
+| `offset` | `Number \| String` | `8` | Offset from the reference element. |
+| `disabled` | `Boolean` | `false` | Disable the tooltip. |
+| `arrow` | `Boolean` | `true` | Show the arrow pointer. |
+| `interactive` | `Boolean` | `false` | Allow hovering the tooltip without it hiding. |
+
+## Events
+
+None.
+
+## Slots
+
+| Name | Description |
+| --- | --- |
+| `default` | Trigger element. |
+| `content` | Tooltip body (overrides the `content` prop). |
+
+## See also
+
+- `v-tooltip` directive for simple string hints (`<ab-button v-tooltip="'Hello'">`).

package/.ai/ai_ref_AbWizard.md

@@ -1,77 +1,77 @@
-# AbWizard — AI Reference
-
-Multi-step wizard container. Hosts `AbWizardStep` children, supports horizontal / vertical orientations, and multiple visual variants (including modal-rendered wizards).
-
-## Installation
-
-Globally registered by the plugin.
-
-## Usage
-
-```vue
-<template>
-  <ab-wizard
-    orientation="horizontal"
-    variant="circular"
-    :before-next="handleBeforeNext"
-    @finished="handleFinished"
-    @step-changed="onStepChange"
-  >
-    <ab-wizard-step title="Account" description="Basic info">
-      <!-- step content -->
-    </ab-wizard-step>
-
-    <ab-wizard-step title="Profile">
-      <!-- step content -->
-    </ab-wizard-step>
-
-    <ab-wizard-step title="Confirm">
-      <!-- step content -->
-    </ab-wizard-step>
-  </ab-wizard>
-</template>
-
-<script setup>
-async function handleBeforeNext(currentStepIndex) {
-  // Return false to block navigation
-  return true;
-}
-function handleFinished() { /* all steps done */ }
-function onStepChange(newIndex) { /* active step changed */ }
-</script>
-```
-
-## Props
-
-| Name | Type | Default | Description |
-| --- | --- | --- | --- |
-| `beforeNext` | `Function` | `async () => true` | Hook before moving forward; return `false` to cancel. |
-| `beforePrev` | `Function` | `async () => true` | Hook before moving back. |
-| `beforeFinish` | `Function` | `async () => true` | Hook before `finished` fires. |
-| `orientation` | `String` | `"horizontal"` | `horizontal` or `vertical`. |
-| `variant` | `String` | `"default"` | `default`, `circular`, `modal`, `circular-modal`, etc. |
-| `stepperSize` | `String` | `"md"` | `sm` or `md`. |
-| `hideControls` | `Boolean` | `false` | Hide the built-in next/prev buttons. |
-| `nextText` | `String` | `"Next"` | Next button label. |
-| `prevText` | `String` | `"Back"` | Previous button label. |
-| `finishText` | `String` | `"Finish"` | Finish button label. |
-| `disableClose` | `Boolean` | `false` | Disable the close button (modal variants). |
-| `modalClass` | `String` | `"modal-lg"` | Modal size class (modal variants only). |
-
-## Events
-
-| Event | Payload | Description |
-| --- | --- | --- |
-| `finished` | — | User completed the final step. |
-| `step-changed` | `stepIndex` | Active step changed. |
-
-## Slots
-
-| Name | Description |
-| --- | --- |
-| `default` | `<ab-wizard-step>` children. |
-
-## Provides
-
-- `AbWizard` injection key for step registration.
-- `registerStepValidator(stepId, fn)` — used by `AbSettingsForm` to register per-step validators.
+# AbWizard — AI Reference
+
+Multi-step wizard container. Hosts `AbWizardStep` children, supports horizontal / vertical orientations, and multiple visual variants (including modal-rendered wizards).
+
+## Installation
+
+Globally registered by the plugin.
+
+## Usage
+
+```vue
+<template>
+  <ab-wizard
+    orientation="horizontal"
+    variant="circular"
+    :before-next="handleBeforeNext"
+    @finished="handleFinished"
+    @step-changed="onStepChange"
+  >
+    <ab-wizard-step title="Account" description="Basic info">
+      <!-- step content -->
+    </ab-wizard-step>
+
+    <ab-wizard-step title="Profile">
+      <!-- step content -->
+    </ab-wizard-step>
+
+    <ab-wizard-step title="Confirm">
+      <!-- step content -->
+    </ab-wizard-step>
+  </ab-wizard>
+</template>
+
+<script setup>
+async function handleBeforeNext(currentStepIndex) {
+  // Return false to block navigation
+  return true;
+}
+function handleFinished() { /* all steps done */ }
+function onStepChange(newIndex) { /* active step changed */ }
+</script>
+```
+
+## Props
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| `beforeNext` | `Function` | `async () => true` | Hook before moving forward; return `false` to cancel. |
+| `beforePrev` | `Function` | `async () => true` | Hook before moving back. |
+| `beforeFinish` | `Function` | `async () => true` | Hook before `finished` fires. |
+| `orientation` | `String` | `"horizontal"` | `horizontal` or `vertical`. |
+| `variant` | `String` | `"default"` | `default`, `circular`, `modal`, `circular-modal`, etc. |
+| `stepperSize` | `String` | `"md"` | `sm` or `md`. |
+| `hideControls` | `Boolean` | `false` | Hide the built-in next/prev buttons. |
+| `nextText` | `String` | `"Next"` | Next button label. |
+| `prevText` | `String` | `"Back"` | Previous button label. |
+| `finishText` | `String` | `"Finish"` | Finish button label. |
+| `disableClose` | `Boolean` | `false` | Disable the close button (modal variants). |
+| `modalClass` | `String` | `"modal-lg"` | Modal size class (modal variants only). |
+
+## Events
+
+| Event | Payload | Description |
+| --- | --- | --- |
+| `finished` | — | User completed the final step. |
+| `step-changed` | `stepIndex` | Active step changed. |
+
+## Slots
+
+| Name | Description |
+| --- | --- |
+| `default` | `<ab-wizard-step>` children. |
+
+## Provides
+
+- `AbWizard` injection key for step registration.
+- `registerStepValidator(stepId, fn)` — used by `AbSettingsForm` to register per-step validators.

package/.ai/ai_ref_AbWizardStep.md

@@ -1,48 +1,48 @@
-# AbWizardStep — AI Reference
-
-Single step inside an `AbWizard`. Declares its title, optional description, and an optional icon shown in the stepper.
-
-## Installation
-
-Globally registered by the plugin.
-
-## Usage
-
-```vue
-<ab-wizard>
-  <ab-wizard-step
-    title="Account"
-    description="Create your account"
-    :icon="UserIcon"
-  >
-    <ab-input-field v-model="form.email" name="email" label="Email" rules="required|email" />
-  </ab-wizard-step>
-
-  <ab-wizard-step title="Confirm" disable-close>
-    Ready to submit?
-  </ab-wizard-step>
-</ab-wizard>
-```
-
-## Props
-
-| Name | Type | Default | Description |
-| --- | --- | --- | --- |
-| `title` | `String` | **required** | Step title shown in the stepper. |
-| `description` | `String` | `""` | Step description / subtitle. |
-| `icon` | `Object \| String \| Function` | `null` | Icon component, icon class string, or render function. |
-| `disableClose` | `Boolean` | `false` | Disable the close button while this step is active. |
-
-## Events
-
-None.
-
-## Slots
-
-| Name | Description |
-| --- | --- |
-| `default` | Step body content. |
-
-## Provides
-
-An `AbWizardStep` injection key so children (e.g. `AbSettingsForm`) can register themselves as step validators.
+# AbWizardStep — AI Reference
+
+Single step inside an `AbWizard`. Declares its title, optional description, and an optional icon shown in the stepper.
+
+## Installation
+
+Globally registered by the plugin.
+
+## Usage
+
+```vue
+<ab-wizard>
+  <ab-wizard-step
+    title="Account"
+    description="Create your account"
+    :icon="UserIcon"
+  >
+    <ab-input-field v-model="form.email" name="email" label="Email" rules="required|email" />
+  </ab-wizard-step>
+
+  <ab-wizard-step title="Confirm" disable-close>
+    Ready to submit?
+  </ab-wizard-step>
+</ab-wizard>
+```
+
+## Props
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| `title` | `String` | **required** | Step title shown in the stepper. |
+| `description` | `String` | `""` | Step description / subtitle. |
+| `icon` | `Object \| String \| Function` | `null` | Icon component, icon class string, or render function. |
+| `disableClose` | `Boolean` | `false` | Disable the close button while this step is active. |
+
+## Events
+
+None.
+
+## Slots
+
+| Name | Description |
+| --- | --- |
+| `default` | Step body content. |
+
+## Provides
+
+An `AbWizardStep` injection key so children (e.g. `AbSettingsForm`) can register themselves as step validators.

package/.ai/ai_ref_abEventBus.md

@@ -0,0 +1,94 @@
+# abEventBus (abEmitter)
+
+A lightweight, global event bus built on top of `tiny-emitter`. Provides a Vue 3 plugin for the `$eventBus` global property and a standalone `emitterObj` for non-component usage.
+
+## Installation
+
+```javascript
+npm install @vue3-appsbd-ui
+```
+
+## Usage
+
+### Standalone (Composable / Utilities)
+
+Import `emitterObj` directly for use outside of Vue components — utilities, stores, service modules, etc.
+
+```javascript
+import { emitterObj } from "@vue3-appsbd-ui";
+import { onUnmounted } from "vue";
+
+function handler(data) {
+  console.log("Received:", data);
+}
+
+// Subscribe
+emitterObj.$on("my-event", handler);
+
+// Emit
+emitterObj.$emit("my-event", { message: "Hello" });
+
+// Cleanup
+onUnmounted(() => {
+  emitterObj.$off("my-event", handler);
+});
+```
+
+### Plugin Usage (Options API or `this` context)
+
+Register the event bus as a Vue plugin to access `$eventBus` from any component via `this.$eventBus`.
+
+```javascript
+// main.js
+import { createApp } from "vue";
+import abEventBus from "@vue3-appsbd-ui/libraries/abEmitter";
+
+const app = createApp(App);
+app.use(abEventBus);
+app.mount("#app");
+```
+
+```javascript
+// Inside any Options-API component:
+export default {
+  mounted() {
+    this.$eventBus.$on("my-event", this.handleEvent);
+  },
+  beforeUnmount() {
+    this.$eventBus.$off("my-event", this.handleEvent);
+  },
+  methods: {
+    handleEvent(payload) {
+      console.log("Received:", payload);
+    }
+  }
+}
+```
+
+### One-Time Listener
+
+Use `$once` to subscribe to an event that automatically unsubscribes after the first invocation.
+
+```javascript
+emitterObj.$once("init-complete", () => {
+  console.log("Initialization done — this runs only once.");
+});
+```
+
+## API Reference
+
+### `emitterObj` Methods
+
+| Method | Signature | Description |
+|---|---|---|
+| `$on` | `(event: string, callback: Function)` | Subscribe to an event. |
+| `$once` | `(event: string, callback: Function)` | Subscribe to an event; auto-unsubscribe after first fire. |
+| `$off` | `(event: string, callback: Function)` | Unsubscribe from an event (pass the same handler reference). |
+| `$emit` | `(event: string, ...args: any[])` | Fire an event with optional payload arguments. |
+
+### Plugin (default export)
+
+| Property | Type | Description |
+|---|---|---|
+| `emitterObj` | `Object` | Direct reference to the emitter wrapper. |
+| `install(app)` | `Function` | Vue plugin install hook — registers `$eventBus` on `globalProperties`. |

package/.ai/ai_ref_abRequestParam.md

@@ -0,0 +1,55 @@
+# abRequestParam (Library)
+
+Data-transfer classes used to build structured API request parameters for paginated, sorted, and filtered data queries.
+
+## Installation
+
+```javascript
+npm install @vue3-appsbd-ui
+```
+
+## Usage
+
+```javascript
+import abRequestParam from "@vue3-appsbd-ui/libraries/abRequestParam";
+
+const params = new abRequestParam();
+
+// Pagination
+params.limit = 25;
+params.page = 1;
+
+// Sorting
+params.AddSortItem("created_at", "desc");
+
+// Filtering
+params.AddSrcItem("status", "active", "eq");
+params.AddSrcItem("name", "John", "like");
+
+// Output suitable for axios or fetch payload
+console.log(params);
+```
+
+## API Reference
+
+### `abRequestParam` Class
+
+**Properties**
+
+| Property | Type | Description |
+|---|---|---|
+| `data` | `any` | Arbitrary payload attached to the request (e.g. form data). |
+| `limit` | `string\|number` | Number of records per page. |
+| `page` | `string\|number` | Current page number. |
+| `filter_prop` | `string` | Optional filter property identifier. |
+| `sort_by` | `abSortParam[]` | Array of sort descriptors. |
+| `src_by` | `abSrcParam[]` | Array of filter/search descriptors. |
+| `group_by` | `string[]` | Array of property names to group results by. |
+| `force` | `boolean` | Forces the server to bypass cache. |
+
+**Methods**
+
+| Method | Signature | Description |
+|---|---|---|
+| `AddSortItem(prop, ord)` | `Function` | Appends a sort rule. `ord` defaults to `'asc'`, accepts `'asc' \| 'desc'`. |
+| `AddSrcItem(prop, val, opr)` | `Function` | Appends a search rule. `opr` defaults to `'eq'`, accepts `'eq', 'neq', 'gt', 'gte', 'lt', 'lte', 'like', 'in'`. |

package/.ai/ai_ref_abTranslate.md

@@ -0,0 +1,33 @@
+# abTranslate (Library)
+
+A localization utility wrapping `vue3-gettext`. Exposes helper methods `translateGettext` and `translateGetMsg` that automatically interpolate parameters and translate strings, falling back safely if gettext isn't initialized.
+
+## Installation
+
+```javascript
+npm install @vue3-appsbd-ui
+```
+
+## Usage
+
+```javascript
+import { translateGettext, translateGetMsg } from "@vue3-appsbd-ui/libraries/abTranslate";
+
+// Simple translation
+const greeting = translateGettext("Hello World");
+
+// Translation with interpolation (assuming vue3-gettext translates "Welcome %{name}")
+const welcome = translateGettext("Welcome %{name}", { name: "John" });
+
+// Only interpolates without translating the base string
+const msg = translateGetMsg("Error code: %{code}", { code: "404" });
+```
+
+## API Reference
+
+| Export | Signature | Description |
+|---|---|---|
+| `initTranslate(gettextInstance)` | `Function` | Registers the global gettext instance to be used outside of Vue components. |
+| `abCreateGettext(options)` | `Function` | Creates a gettext instance and auto-registers it via `initTranslate`. |
+| `translateGettext(msg, params)` | `Function` | Translates a string `msg` and interpolates any variables provided in `params` object. |
+| `translateGetMsg(msg, params)` | `Function` | Interpolates the `params` into `msg` but does not translate the base string. |