ketekny-ui-kit 1.0.51 → 1.0.52

package/README.md

@@ -1,56 +1,95 @@
-# Ketekny UI Kit
+# ketekny-ui-kit
 
-Vue 3 UI component library styled with Tailwind CSS.
+Vue 3 UI component library with Tailwind CSS styling and utility plugins.
 
-## Installation
+## Requirements
+
+- `vue`: `^3.0.0` (peer dependency)
+- Tailwind CSS build pipeline in your app (`tailwindcss`, `postcss`, `autoprefixer`)
 
-1. Install the package:
+## Installation
 
 ```bash
 npm install ketekny-ui-kit
 ```
 
-2. Ensure required peer/runtime dependencies exist in your app:
+Required peer dependency:
+
+```bash
+npm install vue
+```
+
+If your app does not already use Tailwind CSS:
 
 ```bash
-npm install vue tailwindcss postcss autoprefixer
+npm install -D tailwindcss postcss autoprefixer
 ```
 
-If your project already has Vue + Tailwind configured, you can skip step 2.
+## Quick Start
+
+In your app entry (`main.js` / `main.ts`):
+
+```js
+import { createApp } from "vue";
+import App from "./App.vue";
+import "ketekny-ui-kit/styles.css";
+
+import {
+  kButton,
+  kInput,
+  kSelect,
+  kDateSelector,
+  kToggle,
+  toastPlugin,
+  confirmPlugin,
+  alertPlugin,
+  inputDialogPlugin,
+  tooltipPlugin,
+} from "ketekny-ui-kit";
+
+const app = createApp(App);
 
-## CI Publish Auth (NPM Token)
+app.component("kButton", kButton);
+app.component("kInput", kInput);
+app.component("kSelect", kSelect);
+app.component("kDateSelector", kDateSelector);
+app.component("kToggle", kToggle);
 
-To publish from GitLab CI, create an npm granular token and store it in the runner/project CI variables.
+app.use(toastPlugin);
+app.use(confirmPlugin);
+app.use(alertPlugin);
+app.use(inputDialogPlugin);
+app.use(tooltipPlugin);
 
-### 1. Create npm token
+app.mount("#app");
+```
 
-1. Open npm -> `Access Tokens` -> `Generate New Token` (Granular).
-2. Set permissions to `Read and write`.
-3. Under package access, allow `ketekny-ui-kit`.
-4. Enable `Bypass two-factor authentication (2FA)`.
-5. Create token and copy it (shown only once).
+Example component usage:
 
-### 2. Save token in GitLab CI/CD variables
+```vue
+<template>
+  <div class="p-6 space-y-3">
+    <kInput v-model="name" label="Name" />
+    <kButton label="Save" success @click="save" />
+  </div>
+</template>
 
-1. Open GitLab project -> `Settings` -> `CI/CD` -> `Variables`.
-2. Add variable:
-- Key: `NPM_TOKEN`
-- Value: `<your npm token>`
-- Type: `Variable`
-- Masked: `true`
-- Protected: `true` (if publishing only from protected branches, e.g. `main`)
-3. Save and rerun pipeline.
+<script setup>
+import { ref } from "vue";
 
-### 3. Verify runner/tag
+const name = ref("");
 
-- Ensure the runner used by publish jobs has the required tag (currently `front`).
-- Ensure the project can use that runner.
+function save() {
+  console.log("Saved:", name.value);
+}
+</script>
+```
 
-## Tailwind Setup (Required)
+## Tailwind Setup
 
-Use the provided Tailwind preset so semantic colors and component color tokens are always available.
+Use the provided preset to include semantic tokens and safelist patterns used by dynamic component classes.
 
-### `tailwind.config.js` (ESM)
+`tailwind.config.js` (ESM):
 
 ```js
 import tailwindPreset from "ketekny-ui-kit/tailwind-preset.js";
@@ -66,7 +105,7 @@ export default {
 };
 ```
 
-### `tailwind.config.cjs` (CommonJS)
+`tailwind.config.cjs` (CommonJS):
 
 ```js
 const tailwindPreset = require("ketekny-ui-kit/tailwind-preset.js").default;
@@ -82,101 +121,66 @@ module.exports = {
 };
 ```
 
-Notes:
-- The preset contains the semantic color definitions and safelist patterns used by dynamic classes (alerts/toasts/button intents).
-- If you replace `safelist` in your own config, keep equivalent patterns or dynamic semantic classes may be purged.
+## Plugins
 
-## App CSS Setup
+- `toastPlugin`: adds `$toast.success|error|warning|info|show(...)`
+- `confirmPlugin`: adds `$confirm(options)`
+- `alertPlugin`: adds `$alert.success|warning|error|info(...)`
+- `inputDialogPlugin`: adds `$prompt(options)`
+- `tooltipPlugin`: registers `v-tooltip`
 
-Import the kit stylesheet in your app entry (`main.js` / `main.ts`):
+### Plugin API (quick reference)
 
-```js
-import "ketekny-ui-kit/styles.css";
-```
+- `$toast.success(message, options?)`
+- `$toast.error(message, options?)`
+- `$toast.warning(message, options?)`
+- `$toast.info(message, options?)`
+- `$toast.show({ type?, message, duration?, ... })`
+- `$confirm({ title?, message, onConfirm?, onCancel? })`
+- `$alert.success(message)`
+- `$alert.error(message)`
+- `$alert.warning(message)`
+- `$alert.info(message)`
+- `$prompt({ title?, message?, placeholder?, onConfirm? })`
 
-## Vue Setup
+Note: exact option keys may vary by component/plugin implementation version.
 
-`main.js` / `main.ts` example:
+## Exports
 
-```js
-import { createApp } from "vue";
-import App from "./App.vue";
-import "./style.css";
+Components:
 
-import {
-  kButton,
-  kInput,
-  kSelect,
-  kDateSelector,
-  kToggle,
-  toastPlugin,
-  confirmPlugin,
-  alertPlugin,
-  inputDialogPlugin,
-  tooltipPlugin,
-} from "ketekny-ui-kit";
+- `kMessage`, `kCode`, `kToolbar`, `kTable`, `kTabs`, `kChip`
+- `kSpinner`, `kDatatable`, `kIcon`, `kMenu`, `kSkeleton`
+- `kProgressBar`, `kTree`, `kButton`, `kSelect`, `kUploader`
+- `kToggle`, `kInput`, `kDateSelector`, `kDateSelectorV2`, `kEditor`
+- `kSelectButton`, `kTags`, `kSearch`, `kArrayList`, `kList`, `kTextArea`
+- `kDialog`, `kDrawer`
+- `kAppHeader`, `kAppFooter`, `kAppMain`, `kHero`
 
-const app = createApp(App);
+Other exports:
 
-app.component("kButton", kButton);
-app.component("kInput", kInput);
-app.component("kSelect", kSelect);
-app.component("kDateSelector", kDateSelector);
-app.component("kToggle", kToggle);
+- `toastPlugin`, `confirmPlugin`, `alertPlugin`, `tooltipPlugin`, `inputDialogPlugin`
+- `tailwindPreset`
 
-app.use(toastPlugin);
-app.use(confirmPlugin);
-app.use(alertPlugin);
-app.use(inputDialogPlugin);
-app.use(tooltipPlugin);
+## Common Issues
 
-app.mount("#app");
-```
+- Styles look missing:
+  - Confirm `import "ketekny-ui-kit/styles.css";` is in your app entry file.
+- Tailwind classes from the kit are not applied:
+  - Confirm `tailwind.config` includes `./node_modules/ketekny-ui-kit/**/*.{vue,js,ts,jsx,tsx}` in `content`.
+  - Confirm `presets: [tailwindPreset]` is present.
+- Vue peer dependency warning:
+  - Install/update Vue 3 in your app: `npm install vue@^3`.
+- Dynamic semantic classes are purged:
+  - Keep the provided preset safelist patterns, or replicate them in your own Tailwind config.
 
-## Available Plugins
-
-- `toastPlugin` adds `$toast` (`success`, `error`, `warning`, `info`, `show`)
-- `confirmPlugin` adds `$confirm(options)`
-- `alertPlugin` adds `$alert.success|warning|error|info(...)`
-- `inputDialogPlugin` adds `$prompt(options)`
-- `tooltipPlugin` registers `v-tooltip`
-
-## Available Exports
-
-### Components
-
-- `kMessage`
-- `kButton`
-- `kChip`
-- `kCode`
-- `kDialog`
-- `kDrawer`
-- `kInput`
-- `kDateSelector`
-- `kToolbar`
-- `kSelect`
-- `kTable`
-- `kTabs`
-- `kToggle`
-- `kUploader`
-- `kEditor`
-- `kSpinner`
-- `kSelectButton`
-- `kDatatable`
-- `kIcon`
-- `kMenu`
-- `kTags`
-- `kSearch`
-- `kArrayList`
-- `kSkeleton`
-- `kAppHeader`
-- `kAppFooter`
-- `kAppMain`
-- `kHero`
-
-### Tailwind preset export
+## Development
 
-- `tailwindPreset`
+```bash
+npm run dev
+npm run build
+npm run preview
+```
 
 ## License
 
@@ -184,4 +188,5 @@ ISC
 
 ## Links
 
-- [npm](https://www.npmjs.com/package/ketekny-ui-kit)
+- Live demo/docs: https://ui.ketekny.gr
+- npm: https://www.npmjs.com/package/ketekny-ui-kit

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ketekny-ui-kit",
   "type": "module",
-  "version": "1.0.51",
+  "version": "1.0.52",
   "description": "A Vue 3 UI component library with Tailwind CSS styling",
   "main": "index.js",
   "files": [