@cntwg/html-helper 0.0.26 → 0.1.0

package/CHANGELOG.md

@@ -1,244 +1,16 @@
-#### *v0.0.26*
+#### *v0.1.0*
 
-Pre-release version.
-
-> - `html-ctrls-list.md` updated;
-> - improve a 'THtmlItemsListController' behavior on handling a `click`-event;
-> - change behavior for a `THtmlStubItemsSet`-class constructor (*see docs for details*);
-> - change behavior for a `loadItems`-method of a `THtmlStubItemsSet`-class (*see docs for details*);
-> - some other fixes.
-
-#### *v0.0.25*
-
-Pre-release version.
-
-> - update dependency on `@ygracs/bsfoc-lib-js` module to v0.2.3;
-> - add dependency on `@ygracs/lists-lib-js` module;
-> - remove some deprecates (*see docs for details*);
-> - change pattern for an element manipulation functions (*see docs for details*);
-> - change behavior for `loadItems` method of `THtmlStubItemsSet` class in handling `options` parameter (*see docs for details*).
-
-#### *v0.0.24*
-
-Pre-release version.
-
-> - update dependency on `@ygracs/bsfoc-lib-js` module to v0.2.2.
-
-#### *v0.0.23*
-
-Pre-release version.
-
-> - `html-helper-lib.md` updated;
-> - `html-ctrls-list.md` updated;
-> - `html-ctrls-btn.md` updated;
-> - `html-ctrls-fields.md` updated;
-> - added property `type` to `THtmlInputField` class;
-> - change pattern for an element manipulation functions (*see docs for details*);
-> - deprecate a `force` option in an `options` parameter of the `THtmlStubItemsSet` class constructor;
-> - some other fixes.
-
-#### *v0.0.22*
-
-Pre-release version.
-
-> - `html-helper-lib.md` updated;
-> - add functions `valueToElementID` into `html-helper-lib.js` module;
-> - improve behavior for `createNewHtmlElement` function.
-
-#### *v0.0.21*
-
-Pre-release version.
-
-> - `html-ctrls-list.md` updated;
-> - `html-ctrls-fields.md` updated;
-> - `html-ctrls-btn.md` updated;
-> - updated dependency on `@ygracs/bsfoc-lib-js` module to v0.2.1;
-> - remove some deprecates (*see docs for details*);
-> - change behavior for `loadItems` method of `THtmlStubItemsSet` class in handling `options` parameter (*see docs for details*);
-> - add functions `readAsTagName` and `readAsAttrName` into `html-helper-lib.js` module;
-> - added 'components' property for module exports;
-> - some other fixes.
-
-#### *v0.0.20*
-
-Pre-release version.
-
-> - updated dependency on `@ygracs/bsfoc-lib-js` module to v0.1.4;
-> - some fixes in `html-helper-lib.js` module.
-
-#### *v0.0.19*
-
-Pre-release version.
-
-> - `html-helper-lib.md` updated;
-> - updated dependency on `@ygracs/bsfoc-lib-js` module to v0.1.3;
-> - add functions `lockHtmlElement` and `unlockHtmlElement` into `html-helper-lib.js` module;
-> - change behavior for `createNewHtmlElement` function in handling `options` parameter (*see docs for details*);
-> - added `THtmlInputField` class (experimental);
-> - some other fixes.
-
-#### *v0.0.18*
-
-Pre-release version.
-
-> - `html-helper-lib.md` updated;
-> - some fixes in `html-helper-lib.js` module;
-> - add `mod-hfunc.js` module;
-> - rename module `html-ctrls-list.js` to `html-ctrls/list.js`;
-> - some fixes in `list.js` module;
-> - rename module `html-ctrls-btn.js` to `html-ctrls/buttons.js`;
-> - some fixes in `buttons.js` module;
-> - some fixes in `lists-btn.js` module;
-> - some fixes in `lists-stubs.js` module;
-> - add function `readAsAttrValue` into `html-helper-lib.js` module;
-> - add settings `itemBaseClassID` to `THtmlItemsListContainer` class constructor `options` parameter;
-> - added 'component' property for module exports;
-> - deprecated  'classes' property for module exports (*use `component` instead*);
-
-#### *v0.0.17*
-
-Pre-release version.
-
-> improved event logic on items deletion for `THtmlItemsListController` class.
-
-#### *v0.0.16*
-
-Pre-release version.
-
-> improved items selection logic for `THtmlItemsListController` class.
-
-#### *v0.0.15*
-
-Pre-release version.
-
-> - `html-helper-lib.md` updated;
-> - `html-ctrls-list.md` updated;
-> - some fixes in `html-ctrls-btn.js` module;
-> - some fixes in `html-ctrls-list.js` module;
-> - alter behavior for the `srchIndexByAttr` method of a `THtmlItemsListContainer` class (*see docs for details*);
-> - add settings `markCurrentItem` to `THtmlItemsListContainer` class constructor `options` parameter;
-> - add function `valueToIDString` into `html-helper-lib.js` module;
-
-#### *v0.0.14*
+Release version.
 
-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`.
+> - remove `$lib/html-ctrls/fields.js` module;
+> - remove `$lib/html-ctrls/buttons.js` module;
+> - remove `$lib/html-ctrls/list.js` module;
+> - remove `$lib/html-ctrls/list-stubs.js` module;
+> - remove `$lib/html-ctrls/list-btn.js` module;
+> - remove some deprecates;
+> - `README.md` updated.
 
-#### *v0.0.1*
+#### *v0.0.1-v0.0.27*
 
 Pre-release version.

package/README.md

@@ -1,10 +1,10 @@
->|***rev.*:**|0.1.7|
+>|***rev.*:**|0.2.8|
 >|:---|---:|
->|date:|2024-11-20|
+>|date:|2025-10-23|
 
 ## 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.
+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 an HTML-forms.
 
 ## Description
 
@@ -14,24 +14,20 @@ This module contains the following components:
 
 > *For more details see `html-helper.md` in module `doc` directory*.
 
-- classes for working with instances maintaining a buttons set support such as:
-  - `THtmlButtonsSet`,
-  - `THtmlButtonsControllerARCSet`.
-
-> *For more details see `html-ctrls-btn.md` in module `doc` directory*.
-
-- classes for working with instances maintaining a lists support such as:
-  - `THtmlItemsListContainer`,
-  - `THtmlItemsListController`,
-  - `THtmlListButtonsController`,
-  - `THtmlStubItemsSet`.
-
-> *For more details see `html-ctrls-list.md` in module `doc` directory*.
-
-- classes for working with instances maintaining an input fields support such as:
-  - `THtmlInputField` (experimental, beta stage).
-
-> *For more details see `html-ctrls-fields.md` in module `doc` directory*.
+> Notes on upgrade to `v0.1.0`
+>
+> > Since `v0.1.0` a support for the following components moved to a separate packages:
+> > - classes for working with instances maintaining a buttons set support such as: `THtmlButtonsSet`, `THtmlButtonsControllerARCSet`.
+> >
+> > To use those you need to install a package [`@cntwg/html-ctrls-buttons`](https://www.npmjs.com/package/@cntwg/html-ctrls-buttons).
+> >
+> > - classes for working with instances maintaining a lists support such as: `THtmlItemsListContainer`, `THtmlItemsListController`, `THtmlListButtonsController`, `THtmlStubItemsSet`.
+> >
+> > To use those you need to install a package [`@cntwg/html-ctrls-lists`](https://www.npmjs.com/package/@cntwg/html-ctrls-lists).
+> >
+> > - classes for working with instances maintaining an input fields support such as: `THtmlInputField`.
+> >
+> > To use those you need to install a package [`@cntwg/html-ctrls-fields`](https://www.npmjs.com/package/@cntwg/html-ctrls-fields).
 
 ## Use cases
 

package/doc/html-helper-lib.md

@@ -1,6 +1,6 @@
->|***rev.*:**|0.1.15|
+>|***rev.*:**|0.1.17|
 >|:---|---:|
->|date:|2025-03-29|
+>|date:|2025-10-23|
 
 ## Introduction
 
@@ -33,6 +33,15 @@ This function checks whether or not a given object represents an HTML-element an
 |:---|---|---:|:---|
 | `obj` | `any` | --- | some element to be checked |
 
+<a name="isHTMLButton"></a>
+#### **isHTMLButton(obj)** => `boolean`
+
+This function checks whether or not a given object represents an HTML-button element and if so returns `true` or `false` if else.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `obj` | `any` | --- | some element to be checked |
+
 <a name="isSelectedHTMLElement"></a>
 #### **isSelectedHTMLElement(obj)** => `boolean`
 
@@ -239,7 +248,7 @@ This function tries to convert a given `value` to `ID_STRING`. If failed a `null
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
 | `value` | `any` | --- | some value |
-| `options` | `boolean`, `object` | --- | options to set constraints |
+| `options` | `object` | --- | options to set constraints |
 
 > NOTE: This is a re-exported function. For more details see docs for [`@ygracs/bsfoc-lib-js`](https://gitlab.com/ygracs/bsfoc-lib-js)-module.
 

package/index.js

@@ -1,30 +1,15 @@
-// [v0.1.028-20250503]
+// [v0.2.033-20251023]
 
 // === module init block ===
 
 const html_helper = require('./lib/html-helper-lib.js');
-const html_list = require('./lib/html-ctrls/list.js');
-const html_list_btn = require('./lib/html-ctrls/lists-btn.js');
-const html_bts = require('./lib/html-ctrls/buttons.js');
-const html_flds = require('./lib/html-ctrls/fields.js');
 const ev_helper = require('./lib/event-hfunc.js');
 
 
-// === module extra block (helper functions) ===
+// === module inner block ===
 
 // === module main block ===
 
-const components = {
-  THtmlStubItemsSet: html_list.THtmlStubItemsSet,
-  THtmlItemsListContainer: html_list.THtmlItemsListContainer,
-  THtmlItemsListController: html_list.THtmlItemsListController,
-  THtmlButtonsSet: html_bts.THtmlButtonsSet,
-  THtmlButtonsControllerARCSet: html_bts.THtmlButtonsControllerARCSet,
-  THtmlListButtonsController: html_list_btn.THtmlListButtonsController,
-  // experimental
-  THtmlInputField: html_flds.THtmlInputField,
-};
-
 const eventHelper = {
   pushEventHandler: ev_helper.pushEventHandler,
   removeEventHandler: ev_helper.removeEventHandler,
@@ -53,37 +38,15 @@ module.exports.activateHTMLElements = html_helper.activateHTMLElements;
 module.exports.inactivateHTMLElements = html_helper.inactivateHTMLElements;
 module.exports.valueToClassList = html_helper.valueToClassList;
 
-module.exports.THtmlStubItemsSet = html_list.THtmlStubItemsSet;
-module.exports.THtmlItemsListContainer = html_list.THtmlItemsListContainer;
-module.exports.THtmlItemsListController = html_list.THtmlItemsListController;
-
-module.exports.BTS_DEF_GROUP_NAME = html_bts.BTS_DEF_GROUP_NAME;
-module.exports.THtmlButtonsSet = html_bts.THtmlButtonsSet;
-module.exports.THtmlButtonsControllerARCSet = html_bts.THtmlButtonsControllerARCSet;
-
-module.exports.THtmlListButtonsController = html_list_btn.THtmlListButtonsController;
-
-module.exports.components = components;
-
-// experimental
+// * experimental *
 module.exports.readAsTagName = html_helper.readAsTagName;
 module.exports.readAsAttrName = html_helper.readAsAttrName;
 module.exports.readAsAttrValue = html_helper.readAsAttrValue;
 module.exports.valueToElementID = html_helper.valueToElementID;
 module.exports.createNewHTMLElement = html_helper.createNewHTMLElement;
-
-module.exports.isHTMLButton = html_bts.isHTMLButton;
-
-module.exports.THtmlInputField = html_flds.THtmlInputField;
+module.exports.isHTMLButton = html_helper.isHTMLButton;
 
 module.exports.eventHelper = eventHelper;
 
-// re-exported
+// * re-exported *
 module.exports.valueToIDString = html_helper.valueToIDString;
-
-// will deprecate
-module.exports.classes = components;
-
-// deprecated
-module.exports.component = components;
-module.exports.createNewHtmlElement = html_helper.createNewHtmlElement;