mgv-backoffice 1.0.3 → 1.0.6

package/README.md

@@ -0,0 +1,111 @@
+npm login
+
+# mgv-backoffice
+
+Shared Vue 3 UI component library.
+
+## Prerequisites
+
+- Node.js 18+
+- npm
+
+## Setup
+
+```bash
+npm install
+```
+
+## Development
+
+Watch mode rebuilds on every file change:
+
+```bash
+npm run dev
+```
+
+## Publishing a new version
+
+### 1. Build the library
+
+```bash
+npm run build
+```
+
+This outputs the bundled files to `dist/` (UMD, ESM, type declarations, and CSS).
+
+### 2. Bump the version
+
+Use one of the following depending on the type of change:
+
+```bash
+# Patch (bug fixes, small tweaks): 1.0.4 → 1.0.5
+npm version patch
+
+# Minor (new components, non-breaking features): 1.0.4 → 1.1.0
+npm version minor
+
+# Major (breaking changes): 1.0.4 → 2.0.0
+npm version major
+```
+
+This updates `package.json` and creates a git tag automatically.
+
+### 3. Publish to npm
+
+```bash
+npm publish
+```
+
+If publishing to a private registry or GitHub Packages, make sure your `.npmrc` is configured with the correct registry URL and auth token.
+
+### 4. Verify
+
+```bash
+npm info mgv-backoffice version
+```
+
+### Quick one-liner
+
+Build, bump patch, and publish in one go:
+
+```bash
+npm run build && npm version patch && npm publish
+```
+
+## Usage in consuming projects
+
+```bash
+npm install mgv-backoffice
+```
+
+```ts
+import { BaseButton, BaseBadge, BaseBreadcrumb } from 'mgv-backoffice'
+import 'mgv-backoffice/dist/style.css'
+```
+
+## Components
+
+| Component | Description |
+|---|---|
+| BaseAlert | Dismissible alert banner |
+| BaseBadge | Colored status badge |
+| BaseBreadcrumb | Auto-generated or manual breadcrumb nav |
+| BaseButton | Button with color, size, loading, and routing support |
+| BaseLine | Horizontal divider |
+| BaseLogo | SVG brand logo |
+| BaseModal | Confirmation modal dialog |
+| BaseRow | Card-like content container |
+| BaseSpinner | Loading spinner |
+| BaseToast | Toast notification |
+| ColoredSquares | Colored square indicator |
+| EuroAmount | Formatted euro currency display |
+| Pagination | Page navigation |
+| TrendArrow | Up/down trend indicator with badge |
+
+## Peer dependencies
+
+These must be installed in the consuming project:
+
+- `vue` ^3.3.0
+- `vue-router` ^4.0.0
+- `@heroicons/vue` ^2.0.0

package/dist/components/BaseBreadcrumb.vue.d.ts

@@ -0,0 +1,31 @@
+export interface BreadCrumb {
+    name: string;
+    url: string;
+}
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    items: {
+        type: () => BreadCrumb[];
+        required: false;
+        default: undefined;
+    };
+    path: {
+        type: StringConstructor;
+        required: false;
+        default: undefined;
+    };
+}>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    items: {
+        type: () => BreadCrumb[];
+        required: false;
+        default: undefined;
+    };
+    path: {
+        type: StringConstructor;
+        required: false;
+        default: undefined;
+    };
+}>> & Readonly<{}>, {
+    path: string;
+    items: BreadCrumb[];
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, HTMLElement>;
+export default _default;

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export { default as BaseAlert } from './components/BaseAlert.vue';
 export { default as BaseBadge } from './components/BaseBadge.vue';
+export { default as BaseBreadcrumb } from './components/BaseBreadcrumb.vue';
 export { default as BaseButton } from './components/BaseButton.vue';
 export { default as BaseLine } from './components/BaseLine.vue';
 export { default as BaseLogo } from './components/BaseLogo.vue';
@@ -21,4 +22,5 @@ export { BaseToastEnum } from './enums/BaseToastEnum';
 export { ColorsEnums } from './enums/ColorsEnums';
 export { LineEnum } from './enums/LineEnum';
 export { PositioningEnum } from './enums/PositioningEnum';
+export type { BreadCrumb } from './components/BaseBreadcrumb.vue';
 export { getBaseColor, getBaseColorOf } from './utils/util';