Added min option and prepare to release

Author: Eugene Tupikov

CHANGELOG.md

@@ -1,10 +1,15 @@
 Yii2 multiple input change log
 ==============================
 
-1.2.6 in development
+1.2.7 in development
 --------------------
 
+1.2.6
+-----
+
 - Bug #49: urlencoded field token replacement in js template (rolmonk)
+- Enh #48: Added option `min` for setting minimum number of rows
+- Enh: added option 'addButtonPosition'
 
 1.2.5
 -----

README.md

@@ -8,7 +8,7 @@ Yii2 widget for handle multiple inputs for an attribute of model
 [![License](https://poser.pugx.org/unclead/yii2-multiple-input/license)](https://packagist.org/packages/unclead/yii2-multiple-input)
 
 ##Latest release
-The latest version of the extension is v1.2.5. Follow the [instruction](./UPGRADE.md) for upgrading from previous versions
+The latest version of the extension is v1.2.6. Follow the [instruction](./UPGRADE.md) for upgrading from previous versions
 
 Contents:
 
@@ -38,28 +38,61 @@ to the require section of your `composer.json` file.
 
 ## Configuration
 
-Widget support the following options that are additionally recognized over and above the configuration options in the InputWidget:
+Widget support the following options that are additionally recognized over and above the configuration options in the InputWidget.
 
-- `limit` *integer*: rows limit. If not set will defaul to unlimited
-- `attributeOptions` *array*: client-side attribute options, e.g. enableAjaxValidation. You may use this property in case when
+### Base options
+
+**limit** *integer*: rows limit. If not set will defaul to unlimited
+
+**min** *integer*: minimum number of rows. Set to `0` if you need the empty list in case you don't have any data
+
+**attributeOptions** *array*: client-side attribute options, e.g. enableAjaxValidation. You may use this property in case when
   you use widget without a model, since in this case widget is not able to detect client-side options automatically
-- `addButtonOptions` *array*: the HTML options for `add` button. Can contains `class` and `label` keys
-- `removeButtonOptions` *array*: the HTML options for `add` button. Can contains `class` and `label` keys
-- `data` *array*: array of values in case you use widget without model
-- `models` *array*: the list of models. Required in case you use `TabularInput` widget
-- `allowEmptyList` *boolean*: whether to allow the empty list
-- `columns` *array*: the row columns configuration where you can set the following properties:
-  - `name` *string*: input name. *Required options*
-  - `type` *string*: type of the input. If not set will default to `textInput`. Read more about the types described below
-  - `title` *string*: the column title
-  - `value` *Closure*: you can set it to an anonymous function with the following signature: ```function($data) {}```
-  - `defaultValue` *string*: default value of input,
-  - `items` *array*|*Closure*: the items for input with type dropDownList, listBox, checkboxList, radioList or anonymous function
-  which return array of items and has the following signature: ```function($data) {}```
-  - `options` *array*: the HTML attributes for the input
-  - `headerOptions` *array*: the HTML attributes for the header cell
-  - `enableError` *boolean*: whether to render inline error for the input. Default to `false`
-  - `errorOptions` *array*: the HTMl attributes for the error tag
+  
+**addButtonPosition** *integer*: the position of `add` button. This can be MultipleInput::POS_HEADER or MultipleInput::POS_ROW.
+ 
+**addButtonOptions** *array*: the HTML options for `add` button. Can contains `class` and `label` keys
+
+**removeButtonOptions** *array*: the HTML options for `add` button. Can contains `class` and `label` keys
+
+**data** *array*: array of values in case you use widget without model
+
+**models** *array*: the list of models. Required in case you use `TabularInput` widget
+
+**allowEmptyList** *boolean*: whether to allow the empty list
+
+**columns** *array*: the row columns configuration where you can set the properties which is described below
+
+### Column options
+
+**name** *string*: input name. *Required options*
+
+**type** *string*: type of the input. If not set will default to `textInput`. Read more about the types described below
+
+**title** *string*: the column title
+
+**value** *Closure*: you can set it to an anonymous function with the following signature: 
+
+```php
+function($data) {}
+```
+
+**defaultValue** *string*: default value of input
+
+**items** *array*|*Closure*: the items for input with type dropDownList, listBox, checkboxList, radioList
+or anonymous function which return array of items and has the following signature: 
+
+```php
+function($data) {}
+```
+
+**options** *array*: the HTML attributes for the input
+
+**headerOptions** *array*: the HTML attributes for the header cell
+
+**enableError** *boolean*: whether to render inline error for the input. Default to `false`
+
+**errorOptions** *array*: the HTMl attributes for the error tag
 
 ### Input types
 
@@ -101,8 +134,13 @@ use unclead\widgets\MultipleInput;
 
 ...
 
-<?= $form->field($model, 'emails')->widget(MultipleInput::className(), [
-        'limit' => 5
+<?php
+    echo $form->field($model, 'emails')->widget(MultipleInput::className(), [
+        'limit'             => 6,
+        'allowEmptyList'    => false,
+        'enableGuessTitle'  => true,
+        'min'               => 2, // should be at least 2 rows
+        'addButtonPosition' => MultipleInput::POS_HEADER // show add button in the header
     ])
     ->label(false);
 ?>
@@ -280,6 +318,8 @@ In some cases you need to have the ability to delete all rows in the list. For t
 
 ```
 
+Also you can set `0` in `min` option if you don't need first blank row when data is empty. 
+
 ### Guess column title
 
 Sometimes you can use the widget without defining columns but you want to have the column header of the table.

composer.json

@@ -9,7 +9,7 @@
         "yii2 tabular input"
     ],
     "type": "yii2-extension",
-    "version": "1.2.5",
+    "version": "1.2.6",
     "license": "BSD-3-Clause",
     "support": {
         "issues": "https://github.com/unclead/yii2-multiple-input/issues?state=open",

examples/views/multiple-input.php

@@ -24,9 +24,11 @@
 <h3>Single column</h3>
 <?php
     echo $form->field($model, 'emails')->widget(MultipleInput::className(), [
-        'limit'             => 5,
-        'allowEmptyList'    => true,
-        'enableGuessTitle'  => true
+        'limit'             => 6,
+        'allowEmptyList'    => false,
+        'enableGuessTitle'  => true,
+        'min'               => 2, // should be at least 2 rows
+        'addButtonPosition' => MultipleInput::POS_HEADER // show add button in the header
     ])
     ->label(false);
 ?>

src/MultipleInput.php

@@ -22,6 +22,9 @@
  */
 class MultipleInput extends InputWidget
 {
+    const POS_HEADER    = 0;
+    const POS_ROW       = 1;
+
     /**
      * @var ActiveRecord[]|array[] input data
      */
@@ -64,6 +67,16 @@ class MultipleInput extends InputWidget
      */
     public $enableGuessTitle = false;
 
+    /**
+     * @var int minimum number of rows
+     */
+    public $min;
+
+    /**
+     * @var string position of add button. By default button is rendered in the row.
+     */
+    public $addButtonPosition = self::POS_ROW;
+
 
     /**
      * Initialization.
@@ -129,6 +142,8 @@ private function createRenderer()
             'data'              => $this->data,
             'columnClass'       => MultipleInputColumn::className(),
             'allowEmptyList'    => $this->allowEmptyList,
+            'min'               => $this->min,
+            'addButtonPosition' => $this->addButtonPosition,
             'context'           => $this
         ];
 

src/TabularInput.php

@@ -21,6 +21,9 @@
  */
 class TabularInput extends Widget
 {
+    const POS_HEADER    = 0;
+    const POS_ROW       = 1;
+
     /**
      * @var array
      */
@@ -31,6 +34,11 @@ class TabularInput extends Widget
      */
     public $limit;
 
+    /**
+     * @var int minimum number of rows
+     */
+    public $min;
+
     /**
      * @var array client-side attribute options, e.g. enableAjaxValidation. You may use this property in case when
      * you use widget without a model, since in this case widget is not able to detect client-side options
@@ -58,6 +66,11 @@ class TabularInput extends Widget
      */
     public $models;
 
+    /**
+     * @var string position of add button. By default button is rendered in the row.
+     */
+    public $addButtonPosition = self::POS_ROW;
+
 
     /**
      * Initialization.
@@ -100,6 +113,8 @@ private function createRenderer()
             'data'              => $this->models,
             'columnClass'       => TabularColumn::className(),
             'allowEmptyList'    => $this->allowEmptyList,
+            'min'               => $this->min,
+            'addButtonPosition' => $this->addButtonPosition,
             'context'           => $this
         ];
 

src/assets/src/js/jquery.multipleInput.js

@@ -54,7 +54,9 @@
         // string that collect js templates of widgets which uses in the columns
         jsTemplates: [],
         // how many row has to renders
-        limit: 1
+        limit: 1,
+        // minimum number of rows
+        min: 1
     };
 
     var defaultAttributeOptions = {
@@ -142,7 +144,9 @@
 
             var jsTemplate;
             for (i in settings.jsTemplates) {
-                jsTemplate = settings.jsTemplates[i].replaceAll('{multiple_index}', data.currentIndex).replaceAll('%7Bmultiple_index%7D', data.currentIndex);
+                jsTemplate = settings.jsTemplates[i]
+                    .replaceAll('{multiple_index}', data.currentIndex)
+                    .replaceAll('%7Bmultiple_index%7D', data.currentIndex);
                 window.eval(jsTemplate);
             }
             $wrapper.data('multipleInput').currentIndex++;
@@ -153,23 +157,28 @@
 
         removeInput: function () {
             var $wrapper = $(this).closest('.multiple-input').first(),
-                $toDelete = $(this).closest('.multiple-input-list__item');
+                $toDelete = $(this).closest('.multiple-input-list__item'),
+                count = $('.multiple-input-list__item').length,
+                data        = $wrapper.data('multipleInput'),
+                settings    = data.settings;
 
-            var event = $.Event(events.beforeDeleteRow);
-            $wrapper.trigger(event, [$toDelete]);
-            if (event.result === false) {
-                return;
-            }
+            if (count > settings.min) {
+                var event = $.Event(events.beforeDeleteRow);
+                $wrapper.trigger(event, [$toDelete]);
+                if (event.result === false) {
+                    return;
+                }
 
-            $toDelete.find('input, select, textarea').each(function () {
-                methods.removeAttribute.apply(this);
-            });
-            $toDelete.fadeOut(300, function () {
-                $(this).remove();
-            });
+                $toDelete.find('input, select, textarea').each(function () {
+                    methods.removeAttribute.apply(this);
+                });
+                $toDelete.fadeOut(300, function () {
+                    $(this).remove();
+                });
 
-            event = $.Event(events.afterDeleteRow);
-            $wrapper.trigger(event);
+                event = $.Event(events.afterDeleteRow);
+                $wrapper.trigger(event);
+            }
         },
 
         addAttribute: function () {