@cntwg/html-helper 0.0.14

package/CHANGELOG.md

@@ -0,0 +1,123 @@
+#### *v0.0.14*
+
+Pre-release version.
+
+> - `html-ctrls-list.md` updated;
+> - some fixes in `html-ctrls/list-stubs.js` module;
+> - alter behavior for the `loadItems` method of a `THtmlStubItemsSet` class in case when its `options` parameter is set to `boolean` (see `html-ctrls-list.md` for details);
+> - added method `rstDefItem` to `THtmlStubItemsSet` class;
+> - added `THtmlButtonsControllerARCSet` class;
+
+#### *v0.0.13*
+
+Pre-release version.
+
+> - `html-helper-lib.md` updated;
+> - `html-ctrls-btn.md` updated;
+> - `html-ctrls-list.md` updated;
+> - some fixes in `html-helper-lib.js` module;
+> - some fixes in `html-ctrls-btn.js` module;
+> - some fixes in `html-ctrls-list.js` module;
+> - move definition of `THtmlStubItemsSet` from `html-ctrls-list.js` module to `html-ctrls/lists-stubs.js` submodule;
+> - add function `valueToClassList` into `html-helper-lib.js` module;
+> - updated dependency on `@ygracs/bsfoc-lib-js` module to v0.1.2.
+
+#### *v0.0.12*
+
+Pre-release version.
+
+> - updated dependency on `@ygracs/bsfoc-lib-js` module to v0.1.1.
+
+#### *v0.0.11*
+
+Pre-release version.
+
+> - `html-ctrls-btn.md` updated;
+> - `html-ctrls-list.md` updated;
+> - some fixes in `html-ctrls-list.js` module;
+> - some fixes in `html-ctrls-btn.js` module.
+
+#### *v0.0.10*
+
+Pre-release version.
+
+> - `html-ctrls-btn.md` updated;
+> - added `THtmlListButtonsController` class;
+
+#### *v0.0.9*
+
+Pre-release version.
+
+> - switch dependency from `@cntwg/bsfoc-lib-js` module to `@ygracs/bsfoc-lib-js` module.
+
+#### *v0.0.8*
+
+Pre-release version.
+
+> - updated dependency on `@cntwg/bsfoc-lib-js` module to v0.0.11.
+
+#### *v0.0.7*
+
+Pre-release version.
+
+> - updated dependency on `@cntwg/bsfoc-lib-js` module to v0.0.10;
+> - some fixes in `html-helper-lib.js` module;
+> - some fixes in `html-ctrls-list.js` module.
+
+#### *v0.0.6*
+
+Pre-release version.
+
+> - `html-ctrls-btn.md` updated;
+> - `html-ctrls-list.md` updated;
+> - `html-helper-lib.md` updated;
+> - some fixes in `html-ctrls-btn.js` module;
+> - some fixes in `html-ctrls-list.js` module.
+
+#### *v0.0.5*
+
+Pre-release version.
+
+> - `$module/test/README.md` added;
+> - updated dependency on `@cntwg/bsfoc-lib-js` module to v0.0.8;
+> - `html-ctrls-list.md` updated;
+> - added `minIndex` property to `THtmlItemsListContainer` class;
+> - some fixes in `html-ctrls-list.js` module;
+> - added 'classes' property for module exports;
+> - MIT-license applied.
+
+#### *v0.0.4*
+
+Pre-release version.
+
+> - updated dependency on `@cntwg/bsfoc-lib-js` module to v0.0.5.
+
+#### *v0.0.3*
+
+Pre-release version.
+
+> - added `activateHTMLElements` function;
+> - added `inactivateHTMLElements` function;
+> - added `createNewHtmlElement` function (experimental);
+> - `html-helper-lib.md` updated;
+> - `html-ctrls-btn.md` updated;
+> - `html-ctrls-list.md` updated.
+
+#### *v0.0.2*
+
+Pre-release version.
+
+> - `README.md` added;
+> - `html-helper-lib.md` added to `doc`;
+> - `html-ctrls-btn.md` added to `doc`;
+> - `html-ctrls-list.md` added to `doc`;
+> - added `CSS_CLASS_ACTIVE` constant to `CSS_CLASS_STRING`;
+> - added `isActiveHTMLElement` function;
+> - added `markHtmlElementAsActive` function;
+> - added `unmarkActiveHtmlElement` function;
+> - `html-btn-ctrl.js` was renamed `html-ctrls-btn.js`;
+> - `html-list-ctrl.js` was renamed `html-ctrls-list.js`.
+
+#### *v0.0.1*
+
+Pre-release version.

package/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2019-2022 Yuri Grachev
+
+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,32 @@
+>|***rev.*:**|0.1.2|
+>|:---|---:|
+>|date:|2022-09-12|
+
+## Introduction
+
+This module provide a base set of helpers for javascript. So your work can run a bit easy by using it when you deal with HTML-forms.
+
+## Use cases
+
+This module was make for use as a library in a development of a Web-apps based on [Electron](https://en.wikipedia.org/wiki/Electron_(software_framework)) as main target.
+
+## Description
+
+This module contains the following components:
+
+- base helper module which provided a set of constants and functions usefull for some manipulation with HTML-elements.
+
+> *For more details see `html-helper.md` in module `doc` directory*.
+
+- class `THtmlButtonsSet`,
+- class `THtmlListButtonsController`,
+- class `THtmlButtonsControllerARCSet`.
+
+> *For more details see `html-ctrls-btn.md` in module `doc` directory*.
+
+- classes for working with HTML-elements maintaining a lists support such as:
+	- `THtmlItemsListContainer`,
+	- `THtmlItemsListController`,
+	- `THtmlStubItemsSet`.
+
+> *For more details see `html-ctrls-list.md` in module `doc` directory*.

package/doc/html-ctrls-btn.md

@@ -0,0 +1,222 @@
+>|***rev.*:**|0.1.8|
+>|:---|---:|
+>|date:|2022-09-12|
+
+## Introduction
+
+This paper describes a classes provided by `html-ctrls-btn.js` module.
+
+## Module constants
+
+By module, constants that is provided listed in the following table:
+
+|name|value|
+|:---|---:|
+|`BTS_DEF_GROUP_NAME`|'all'|
+
+## Module classes
+
+### **THtmlButtonsSet**
+
+This class provide a manageable collection which used to group buttons placed on an HTML-form and controls those groups and all its members.
+
+#### class constructor
+
+The class constructor creates a new instance of the class. No arguments is receives by it.
+
+#### class properties
+
+The table below describes a properties of a `THtmlButtonsSet` class:
+
+|property name|property type|read only|description|
+|:---|---|---|:---|
+|`ItemNames`|`array`|yes|contains a list of all buttons names|
+|`GroupNames`|`array`|yes|contains a list of all buttons groups|
+
+#### class methods
+
+##### **hasItem(name)**
+
+This method returns `true` if item named by `name` exist in the collection and `false` if else.
+
+##### **addItem(name, item\[, groups])**
+
+This method adds a "button" element given by `item` named by `name` to a set members and returns `true` if succeed. If `groups` is given the `item` will be added to a groups members listed by `groups` but only if such a group was already declared.
+
+##### **addItemToGroup(name, args)**
+
+This method adds an existing item addressed by 'name' to a members of a groups listed by 'args'. If succeed `true` is returned.
+
+##### **delItem(name)**
+
+This method deletes a "button" element named by `name` and returned `true` if succeed.
+
+##### **delItemFromGroup(name, args)**
+
+This method deletes an existing item addressed by 'name' from a members of a groups listed by 'args'. If succeed `true` is returned.
+
+##### **renameItem(oldName, newName)**
+
+This method renames a "button" element addressed by `oldName` to its `newName`.
+
+##### **enableItem(name)**
+
+This methods activates a "button" element named by `name`.
+
+##### **disableItem(name)**
+
+This methods inactivates a "button" element named by `name`.
+
+##### **hasGroup(name)**
+
+This method returns `true` if an items group named by `name` exist in the collection and `false` if else.
+
+##### **addGroup(name)**
+
+This method adds a group given by `name`. If succeed `true` is returned.
+
+##### **delGroup(name)**
+
+This method deletes the gpoup given by `name`. If succeed `true` is returned.
+
+##### **renameGroup(oldName, newName)**
+
+This method renames a group addressed by `oldName` to its `newName`.
+
+##### **enableGroup(name)**
+
+This method activates all "button" elements present in a group named by `name`.
+
+##### **disableGroup(name)**
+
+This method inactivates all "button" elements present in a group named by `name`.
+
+#### class methods (*static*)
+
+##### **isHTMLButton(object)**
+
+This method checks if the given object represents a "button" element and if so `true` is returned.
+
+### **THtmlListButtonsController**
+
+This class provide a buttons controller to use with a list components to performs actions for list elements selection.
+
+#### class constructor
+
+The class constructor creates a new instance of the class. It receives an `options` parameter which structure has listed below:
+
+|option name|option type|default value|description|
+|:---|---|---:|:---|
+|`btnFirst`|`HTMLElement`|---|define HTML-button which will select the first element|
+|`btn_frst`|`HTMLElement`|---|*will deprecate (use `btnFirst` instead)*|
+|`btnPrev`|`HTMLElement`|---|define HTML-button which will select the previous element|
+|`btn_prev`|`HTMLElement`|---|*will deprecate (use `btnPrev` instead)*|
+|`btnNext`|`HTMLElement`|---|define HTML-button which will select the next element|
+|`btn_next`|`HTMLElement`|---|*will deprecate (use `btnNext` instead)*|
+|`btnLast`|`HTMLElement`|---|define HTML-button which will select the last element|
+|`btn_last`|`HTMLElement`|---|*will deprecate (use `btnLast` instead)*|
+
+
+#### class properties
+
+This class has none.
+
+#### class methods
+
+##### **disableAll()**
+
+This method disables all buttons that holds by the controller.
+
+##### **disableBkwd()**
+
+This method disables all buttons in *'move backward'* group (*i.e. `btnFirst` and `btnPrev`*) that holds by the controller.
+
+##### **disableFrwd()**
+
+This method disables all buttons in *'move forward'* group (*i.e. `btnNext` and `btnLast`*) that holds by the controller.
+
+##### **enableAll()**
+
+This method enables all buttons that holds by the controller.
+
+##### **enableBkwd()**
+
+This method enables all buttons in *'move backward'* group (*i.e. `btnFirst` and `btnPrev`*) that holds by the controller.
+
+##### **enableFrwd()**
+
+This method enables all buttons in *'move forward'* group (*i.e. `btnNext` and `btnLast`*) that holds by the controller.
+
+#### class methods (*special*)
+
+##### **on(name, event)**
+
+This method sets event handler addressed by `name` parameter for the class instance.
+
+> Note: for current implementation you can't reset or set new event handler (*especially another one*) if a handler with the same name exists already.
+
+#### class events
+
+The class generates the events listed in the table bellow:
+
+|event name|description|
+|:---|:---|
+|`btn-first-pressed`|fired if the `btnFirst` was pressed|
+|`btn-prev-pressed`|fired if the `btnPrev` was pressed|
+|`btn-next-pressed`|fired if the `btnNext` was pressed|
+|`btn-last-pressed`|fired if the `btnLast` was pressed|
+
+### **THtmlButtonsControllerARCSet**
+
+This class provide a buttons controller to use with a form components to performs apply/reject actions on a form data when editing.
+
+#### class constructor
+
+The class constructor creates a new instance of the class. It receives an `options` parameter which structure has listed below:
+
+|option name|option type|default value|description|
+|:---|---|---:|:---|
+|`btnApply`|`HTMLElement`|---|define HTML-button which will accept all changes|
+|`btnReset`|`HTMLElement`|---|define HTML-button that will require reset all changes to data if made|
+|`btnCancel`|`HTMLElement`|---|define HTML-button that will require reject all changes and close the form|
+
+
+#### class properties
+
+This class has none.
+
+#### class methods
+
+##### **disableAll()**
+
+This method disables all buttons that holds by the controller.
+
+##### **disableMain()**
+
+This method disables all buttons in *'main'* group (*i.e. `btnApply` and `btnReset`*) that holds by the controller.
+
+##### **enableAll()**
+
+This method enables all buttons that holds by the controller.
+
+##### **enableMain()**
+
+This method enables all buttons in *'main'* group (*i.e. `btnApply` and `btnReset`*) that holds by the controller.
+
+#### class methods (*special*)
+
+##### **on(name, event)**
+
+This method sets event handler addressed by `name` parameter for the class instance.
+
+> Note: for current implementation you can't reset or set new event handler (*especially another one*) if a handler with the same name exists already.
+
+#### class events
+
+The class generates the events listed in the table bellow:
+
+|event name|description|
+|:---|:---|
+|`btn-apply-pressed`|fired if the `btnApply` was pressed|
+|`btn-reset-pressed`|fired if the `btnReset` was pressed|
+|`btn-cancel-pressed`|fired if the `btnCancel` was pressed|