first commit

Author: d.nebolsin

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 hiddenpathz
+
+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.

README.md

@@ -0,0 +1,50 @@
+# QuickEditAccordion Widget
+
+## Description
+
+`QuickEditAccordion` is a Yii2 widget designed to display data in an accordion layout with inline editing capabilities. It supports both table and list views and uses AJAX for asynchronous data updates.
+
+## Installation
+
+To install the `QuickEditAccordion` widget, add it to your Yii2 project by including it in your composer.json file or cloning the repository into your project directory.
+
+
+## Configuration
+
+The widget provides several customizable properties:
+
+- `type`: Display type (`'table'` or `'list'`). Default is `'table'`.
+- `action`: URL to which form data will be sent for saving.
+- `items`: Array of items to be displayed in the accordion.
+- Additional options for customizing appearance and behavior: `options`, `accordionOptions`, `listStyle`, `labelStyle`, `valueStyle`.
+
+## Example Usage
+
+```php
+echo QuickEditAccordion::widget([
+    'type' => 'list',
+    'action' => Url::to(['controller/action']),
+    'items' => [
+        // Your items array
+    ],
+]);
+```
+
+## JavaScript Functionality
+
+The widget includes JavaScript code to enable inline editing functionality. Clicking an element marked with the `.editable` class turns it into a text field, allowing the user to modify its value. The changes are saved asynchronously via AJAX.
+
+### Example of a Controller to Handle the AJAX Request
+
+```php
+public function actionSave() {
+    Yii::$app->response->format = \yii\web\Response::FORMAT_JSON;
+    $index = Yii::$app->request->post('index');
+    $attribute = Yii::$app->request->post('attribute');
+    $newValue = Yii::$app->request->post('newValue');
+
+    // Logic for processing changes saving
+
+    return ['success' => true, 'newValue' => $newValue];
+}
+```

README_RU.md

@@ -0,0 +1,67 @@
+# Виджет QuickEditAccordion
+
+## Описание
+
+Виджет `QuickEditAccordion` предназначен для отображения данных в формате аккордеона с возможностью их редактирования непосредственно в интерфейсе пользователя. Поддерживается два режима отображения: в виде таблицы и в виде списка. Этот виджет разработан для использования в приложениях на Yii2 и использует jQuery для динамического взаимодействия с пользователем.
+
+## Возможности
+
+- Редактирование данных на месте (inline editing).
+- Поддержка отображения данных в виде таблицы или списка.
+- Настраиваемый внешний вид через CSS стили.
+- Асинхронное сохранение изменений с помощью AJAX запросов.
+
+## Установка
+
+Виджет необходимо установить как часть вашего проекта Yii2. Это можно сделать, добавив код виджета в соответствующую директорию вашего приложения.
+
+## Использование
+
+### Конфигурация виджета
+
+Виджет `QuickEditAccordion` предоставляет ряд настраиваемых свойств:
+
+- `type`: Тип отображения (`'table'` или `'list'`). По умолчанию используется `'table'`.
+- `action`: URL, на который будет отправлен AJAX запрос для сохранения изменений.
+- `items`: Массив элементов для отображения.
+- `options`: Массив HTML опций для контейнера виджета.
+- `accordionOptions`, `listStyle`, `labelStyle`, `valueStyle`: Опции для настройки внешнего вида и поведения виджета.
+
+### Пример использования
+
+```php
+echo QuickEditAccordion::widget([
+    'type' => 'list',
+    'action' => Url::to(['your/controller/action']),
+    'items' => [
+        // Массив элементов для отображения
+    ],
+    'options' => [
+        'class' => 'your-custom-class',
+    ],
+]);
+
+```
+## JavaScript функциональность
+
+Виджет включает JavaScript код для реализации функционала редактирования на месте. При клике на элемент, отмеченный классом `.editable`, он превращается в текстовое поле, позволяя пользователю изменить значение. Изменения сохраняются асинхронно через AJAX.
+
+### Пример контроллера для обработки AJAX запроса
+
+```php
+
+public function actionSave() {
+    Yii::$app->response->format = \yii\web\Response::FORMAT_JSON;
+    $index = Yii::$app->request->post('index');
+    $attribute = Yii::$app->request->post('attribute');
+    $newValue = Yii::$app->request->post('newValue');
+
+    // Логика обработки сохранения изменений
+
+    return ['success' => true, 'newValue' => $newValue];
+}
+```
+
+## Лицензия
+
+QuickEditAccordion выпущен под лицензией MIT. Подробную информацию можно найти в файле LICENSE в корневой директории проекта.

composer.json

@@ -0,0 +1,38 @@
+{
+  "name": "hiddenpathz/yii2-quick-edit-accordion",
+  "description": "An asynchronous widget for quick attribute editing for Yii2",
+  "keywords": [
+    "yii",
+    "extension",
+    "hiddenpathz",
+    "widget",
+    "yii2",
+    "yii 2",
+    "accordion",
+    "quick",
+    "edit"
+  ],
+  "type": "yii2-extension",
+  "version": "0.0.1",
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Dmitry Nebolsin",
+      "email": "[email protected]"
+    }
+  ],
+  "require": {
+    "php": ">=7.4",
+    "yiisoft/yii2": "~2.0.14",
+    "yiisoft/yii2-bootstrap": "~2.0.0 || ~2.1.0"
+  },
+  "support": {
+    "issues": "https://github.com/hiddenpathz/yii2-quick-edit-accordion/issues?state=open",
+    "source": "https://github.com/hiddenpathz/yii2-quick-edit-accordion"
+  },
+  "autoload": {
+    "psr-4": {
+      "hiddenpathz\\QuickEditAccordion\\": "src/"
+    }
+  }
+}