@keenthemes/ktui 1.0.3

package/CONTRIBUTING.md

@@ -0,0 +1,88 @@
+# Contributing to KTUI
+
+Thank you for considering contributing to KTUI! Your contributions help improve the project for everyone.
+Please follow these guidelines to ensure a smooth collaboration. 
+If you need any help, feel free to reach out us via [@keenthemes](https://x.com/keenthemes).
+
+## Getting Started
+
+1. **Fork the Repository**: Click the 'Fork' button on the top right of the repository page.
+2. **Clone Your Fork**:
+   ```sh
+   git clone https://github.com/keenthemes/ktui.git
+   cd ktui
+   ```
+3. **Set Up Upstream Remote**:
+   ```sh
+   git remote add upstream https://github.com/keenthemes/ktui.git
+   ```
+
+## Setting Up the Development Environment
+
+1. Install dependencies:
+   ```sh
+   npm install
+   ```
+2. Run format:
+   ```sh
+   npm run format
+   ```
+3. Lint your code:
+   ```sh
+   npm run lint
+   ```
+
+## Format and lint your code
+
+Ensure your code is formatted and linted before submitting any changes. Run the following commands:
+
+```sh
+npm run format
+npm run lint
+```
+
+## Commit Convention
+
+Please follow the commit message format below:
+
+- **feat:** All changes that introduce completely new code or new features.
+- **fix:** Changes that fix a bug (ideally, reference an issue if present).
+- **refactor:** Any code-related change that is not a fix nor a feature.
+- **docs:** Changing existing or creating new documentation (e.g., README, usage docs).
+- **build:** Changes regarding the build of the software, dependencies, or adding new dependencies.
+- **ci:** Changes regarding the configuration of continuous integration (e.g., GitHub Actions, CI systems).
+- **chore:** Repository changes that do not fit into any of the above categories.
+
+**Example commit message:**
+
+```sh
+feat(components): add new prop to the avatar component
+```
+
+## Submitting a Pull Request
+
+1. Create a new branch:
+   ```sh
+   git checkout -b feature-branch
+   ```
+2. Make changes and commit:
+   ```sh
+   git add .
+   git commit -m "Add new feature"
+   ```
+3. Push to your fork:
+   ```sh
+   git push origin feature-branch
+   ```
+4. Open a pull request:
+   - Go to the [ktui GitHub repository](https://github.com/keenthemes/ktui.git).
+   - Click on 'New Pull Request'.
+   - Select your branch and submit the PR.
+
+## Code Review
+
+Code is reviewed under strict terms to make sure it matches ktui code standards and design guidelines.
+
+---
+
+Thank you for contributing! 🚀

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Keenthemes Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,124 @@
+# KTUI
+
+[🌐 Visit the Official Website](https://ktui.io)
+
+**KTUI** is a modern, modular JavaScript/TypeScript UI library for building fast, interactive, and beautiful web applications. KTUI offers a comprehensive suite of DOM-based UI components and utilities, designed for flexibility, accessibility, and seamless integration with any web project.
+
+---
+
+## 🚀 Quick Start
+
+```bash
+# Install dependencies
+yarn install
+# or
+npm install
+
+# Build the library (development mode)
+yarn build
+# or
+npm run build
+```
+
+---
+
+## 📦 Installation
+
+Add KTUI to your project:
+
+```bash
+yarn add ktui
+# or
+npm install ktui
+```
+
+---
+
+## ✨ Usage
+
+### 1. Using as a Script in HTML
+
+```html
+<link rel="stylesheet" href="/path/to/ktui/styles.css" />
+<script src="/path/to/ktui/dist/ktui.js"></script>
+<script>
+  // Initialize all KTUI components after DOM is ready
+  window.KTComponents.init();
+</script>
+```
+
+### 2. Using as a Module in TypeScript/JavaScript
+
+```ts
+import KTComponents from 'ktui';
+KTComponents.init();
+```
+
+---
+
+## 🧩 Available Components
+
+KTUI provides a wide range of UI components, including:
+
+- **Dropdown** (`KTDropdown`)
+- **Modal** (`KTModal`)
+- **Drawer** (`KTDrawer`)
+- **Collapse** (`KTCollapse`)
+- **Dismiss** (`KTDismiss`)
+- **Tabs** (`KTTabs`)
+- **Accordion** (`KTAccordion`)
+- **Scrollspy** (`KTScrollspy`)
+- **Scrollable** (`KTScrollable`)
+- **Scrollto** (`KTScrollto`)
+- **Sticky** (`KTSticky`)
+- **Reparent** (`KTReparent`)
+- **Toggle** (`KTToggle`)
+- **Tooltip** (`KTTooltip`)
+- **Stepper** (`KTStepper`)
+- **Theme Switch** (`KTThemeSwitch`)
+- **Image Input** (`KTImageInput`)
+- **Toggle Password** (`KTTogglePassword`)
+- **DataTable** (`KTDataTable`)
+- **Datepicker** (`KTDatepicker`)
+- **Select** (`KTSelect`)
+
+---
+
+## 🌟 Features
+
+- Modular and customizable DOM-based components
+- Built with accessibility in mind
+- Theming and dark mode support
+- Responsive design
+- Easy integration with any web framework or static site
+- TypeScript support for type safety and autocompletion
+
+---
+
+## 🛠 Scripts
+
+- `npm run build` – Build the library using webpack in development mode
+- `npm run build:prod` – Build the library using webpack in production mode
+- `npm run build:lib` – Build the library outputs for CommonJS and ES Modules using TypeScript
+- `npm run lint` – Lint the source files with ESLint
+- `npm run format` – Format the source files with Prettier
+
+---
+
+## 🤝 Contributing
+
+We welcome contributions! To get started:
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/YourFeature`)
+3. Commit your changes (`git commit -m 'Add some feature'`)
+4. Push to the branch (`git push origin feature/YourFeature`)
+5. Open a pull request
+
+For guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+---
+
+## 📄 License
+
+KTUI is licensed under the MIT License. See the [LICENSE.md](LICENSE.md) file for details.