@cntwg/html-helper 0.0.27 → 0.1.1

package/doc/html-ctrls-btn.md

@@ -1,263 +0,0 @@
->|***rev.*:**|0.1.16|
->|:---|---:|
->|date:|2025-08-27|
-
-## 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 functions
-
-## Module classes
-
-<a name="THtmlButtonsSet"></a>
-### **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.
-
-##### constructor parameters
-
-The class constructor receives no arguments.
-
-#### class properties
-
-<a name="THtmlButtonsSet+ItemNames"></a>
-##### **ItemNames**
-
-| property type | read only | description |
-|---|---|:---|
-| `string[]` | yes | contains a list of all buttons names |
-
-<a name="THtmlButtonsSet+GroupNames"></a>
-##### **GroupNames**
-
-| property type | read only | description |
-|---|---|:---|
-| `string[]` | yes | contains a list of all buttons groups |
-
-#### class methods
-
-<a name="THtmlButtonsSet+hasItem"></a>
-##### **hasItem(name)** => `boolean`
-
-This method returns `true` if item named by `name` exist in the collection and `false` if else.
-
-| parameter name | value type | default value | description |
-|:---|---|---:|:---|
-| `name` | `string` | --- | an element name |
-
-<a name="THtmlButtonsSet+addItem"></a>
-##### **addItem(name, item\[, group_1\[, group_2\[, group_N]]])** => `boolean`
-
-This method adds a "button" element given by `item` named by `name` to a set members and returns `true` if succeed. If any of a `group` is given the `item` will be added to that group if such was already declared.
-
-| parameter name | value type | default value | description |
-|:---|---|---:|:---|
-| `name` | `string` | --- | an element name |
-| `item` | `HTMLElement` | --- | an element |
-| `group[1...N]` | `string` | --- | a group name |
-
-<a name="THtmlButtonsSet+addItemToGroup"></a>
-##### **addItemToGroup(name, group_1\[, group_2\[, group_N]])** => `boolean`
-
-This method adds an existing item addressed by `name` to a members of a groups received by a `group` parameters. If succeed `true` is returned.
-
-| parameter name | value type | default value | description |
-|:---|---|---:|:---|
-| `name` | `string` | --- | an element name |
-| `group[1...N]` | `string` | --- | a group name |
-
-<a name="THtmlButtonsSet+delItem"></a>
-##### **delItem(name)** => `boolean`
-
-This method deletes a "button" element named by `name` and returned `true` if succeed.
-
-| parameter name | value type | default value | description |
-|:---|---|---:|:---|
-| `name` | `string` | --- | an element name |
-
-<a name="THtmlButtonsSet+delItemFromGroup"></a>
-##### **delItemFromGroup(name, group_1\[, group_2\[, group_N]])** => `boolean`
-
-This method deletes an existing item addressed by `name` from a groups received by a `group` parameters. If succeed `true` is returned.
-
-| parameter name | value type | default value | description |
-|:---|---|---:|:---|
-| `name` | `string` | --- | an element name |
-| `group[1...N]` | `string` | --- | a group name |
-
-<a name="THtmlButtonsSet+renameItem"></a>
-##### **renameItem(name, value)** => `boolean`
-
-This method renames a "button" element addressed by `name` to its new name given by a `value` parameter.
-
-| parameter name | value type | default value | description |
-|:---|---|---:|:---|
-| `name` | `string` | --- | an element name |
-| `value` | `string` | --- | some new name for the element |
-
-<a name="THtmlButtonsSet+enableItem"></a>
-##### **enableItem(name)** => `void`
-
-This methods activates a "button" element named by `name`.
-
-| parameter name | value type | default value | description |
-|:---|---|---:|:---|
-| `name` | `string` | --- | an element name |
-
-<a name="THtmlButtonsSet+disableItem"></a>
-##### **disableItem(name)** => `void`
-
-This methods inactivates a "button" element named by `name`.
-
-| parameter name | value type | default value | description |
-|:---|---|---:|:---|
-| `name` | `string` | --- | an element name |
-
-<a name="THtmlButtonsSet+hasGroup"></a>
-##### **hasGroup(name)** => `boolean`
-
-This method returns `true` if an items group named by `name` exist in the collection and `false` if else.
-
-| parameter name | value type | default value | description |
-|:---|---|---:|:---|
-| `name` | `string` | --- | a group name |
-
-<a name="THtmlButtonsSet+addGroup"></a>
-##### **addGroup(name)** => `boolean`
-
-This method adds a group given by `name`. If succeed `true` is returned.
-
-| parameter name | value type | default value | description |
-|:---|---|---:|:---|
-| `name` | `string` | --- | a group name |
-
-<a name="THtmlButtonsSet+delGroup"></a>
-##### **delGroup(name)** => `boolean`
-
-This method deletes the group given by `name`. If succeed `true` is returned.
-
-| parameter name | value type | default value | description |
-|:---|---|---:|:---|
-| `name` | `string` | --- | a group name |
-
-<a name="THtmlButtonsSet+renameGroup"></a>
-##### **renameGroup(name, value)** => `boolean`
-
-This method renames a group addressed by `name` to its new name given by a `value` parameter.
-
-| parameter name | value type | default value | description |
-|:---|---|---:|:---|
-| `name` | `string` | --- | a group name |
-| `value` | `string` | --- | some new name for the group |
-
-<a name="THtmlButtonsSet+enableGroup"></a>
-##### **enableGroup(name)** => `void`
-
-This method activates all "button" elements present in a group named by `name`.
-
-| parameter name | value type | default value | description |
-|:---|---|---:|:---|
-| `name` | `string` | --- | a group name |
-
-<a name="THtmlButtonsSet+disableGroup"></a>
-##### **disableGroup(name)** => `void`
-
-This method inactivates all "button" elements present in a group named by `name`.
-
-| parameter name | value type | default value | description |
-|:---|---|---:|:---|
-| `name` | `string` | --- | a group name |
-
-#### class properties (*static*)
-
-<a name="THtmlButtonsSet.isHTMLButton"></a>
-##### **isHTMLButton**
-
-| property type | read only | description |
-|---|---|:---|
-| `function` | yes | contains a default function that verified validity of an element. The function receives element and returns result for validation as a `boolean`. |
-
-> For more details see [`isHTMLButton`](html-helper-lib.md#isHTMLButton).
-
-<a name="THtmlButtonsControllerARCSet"></a>
-### **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.
-
-##### constructor parameters
-
-The class constructor 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
-
-<a name="THtmlButtonsControllerARCSet+disableAll"></a>
-##### **disableAll()** => `void`
-
-This method disables all buttons that holds by the controller.
-
-<a name="THtmlButtonsControllerARCSet+disableMain"></a>
-##### **disableMain()** => `void`
-
-This method disables all buttons in *'main'* group (*i.e. `btnApply` and `btnReset`*) that holds by the controller.
-
-<a name="THtmlButtonsControllerARCSet+enableAll"></a>
-##### **enableAll()** => `void`
-
-This method enables all buttons that holds by the controller.
-
-<a name="THtmlButtonsControllerARCSet+enableMain"></a>
-##### **enableMain()** => `void`
-
-This method enables all buttons in *'main'* group (*i.e. `btnApply` and `btnReset`*) that holds by the controller.
-
-#### class methods (*special*)
-
-<a name="THtmlButtonsControllerARCSet+on"></a>
-##### **on(name, event)** => `void`
-
-This method sets event handler addressed by a `name` parameter.
-
-| parameter name | value type | default value | description |
-|:---|---|---:|:---|
-| `name` | `string` | --- | an event name |
-| `event` | `function` | --- | a callback function |
-
-> 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 |

package/doc/html-ctrls-fields.md

@@ -1,195 +0,0 @@
->|***rev.*:**|0.0.7|
->|:---|---:|
->|date:|2024-11-20|
-
-## Introduction
-
-This paper describes a classes provided by `html-ctrls-fields.js` module.
-
-## Module classes
-
-<a name="THtmlInputField"></a>
-### **THtmlInputField**
-
-This class provide a container useful when dealing with an elements such an input fields or a checkboxes placed on an HTML-form.
-
-#### class constructor
-
-The class constructor creates a new instance of the class.
-
-##### constructor parameters
-
-The class constructor receives a parameters listed below:
-
-| parameter name | value type | default value | description |
-|:---|---|---:|:---|
-| `name` | `string` | --- | \<*reserved*> |
-| `eholds` | `object`| --- | contains ref-list for container elements |
-| `options` | `object` | --- | contains a container settings |
-
-##### `eholds` parameter
-
-The `eholds` structure has listed below:
-
-| parameter name | value type | default value | description |
-|:---|---|---:|:---|
-| `host` | `HTMLElement` | --- | points to a host element which holds all other items |
-| `label` | `HTMLElement` | --- | points to a label item |
-| `field` | `HTMLElement` | --- | points to a field item |
-
-##### `options` parameter
-
-The `options` structure has listed below:
-
-| option name | value type | default value | description |
-|:---|---|---:|:---|
-| `idPref` | 'string' | --- | \<*reserved*> |
-| `baseClassID` | --- | --- | \<*reserved*> |
-| `hint` | `string` | --- | \<*reserved*> |
-| `fldType` | `string` | `default` | defines an input field type |
-| `isReadOnly` | `boolean` | `true` | defines whether an element value can be modified |
-
-The `fldType` option value can be: `text`, `field`, `checkbox`, `switch` or `default` (*the latter is the same as `field`*).
-
-#### class properties
-
-##### **isModified**
-
-| property type | read only | description |
-|---|---|:---|
-| `boolean` | yes | shows whether or not the field content was modified |
-
-<a name="THtmlInputField+type"></a>
-##### **type**
-
-> since: `v0.0.23`
-
-| property type | read only | description |
-|---|---|:---|
-| `string` | yes | contains a container type |
-
-<a name="THtmlInputField+value"></a>
-##### **value**
-
-| property type | read only | description |
-|---|---|:---|
-| `string`, *`boolean`* | no | contains a container value |
-
-#### class methods
-
-<a name="THtmlInputField+clear"></a>
-##### **clear()** => `void`
-
-> Note: \<*reserved*>
-
-<a name="THtmlInputField+isEmpty"></a>
-##### **isEmpty()** => `boolean`
-
-This method returns `true` if the container field element contains an empty string.
-
-<a name="THtmlInputField+isNotEmpty"></a>
-##### **isNotEmpty()** => `boolean`
-
-This method returns `true` if the container field element contains a non-empty string.
-
-<a name="THtmlInputField+hide"></a>
-##### **hideItem()** => `void`
-
-This method hides a container on the Web-form.
-
-<a name="THtmlInputField+show"></a>
-##### **showItem()** => `void`
-
-This method shows a container on the Web-form.
-
-<a name="THtmlInputField+attachTo"></a>
-##### **attachTo(target)** => `boolean`
-
-This method attaches a container to a parent HTML-element given by a `target` parameter. If succeed `true` returned.
-
-| parameter name | value type | default value | description |
-|:---|---|---:|:---|
-| `target` | `HTMLElement` | --- | a target element |
-
-#### class methods (*static*)
-
-<a name="THtmlInputField.create"></a>
-##### **create(name\[, options])** => `?THtmlInputField`
-
-This method creates an instance of the class. If failed `null` returned.
-
-| parameter name | value type | default value | description |
-|:---|---|---:|:---|
-| `name` | `string` | --- | an ID of the created container |
-| `options` | `object` | --- | an options |
-
-For details of `options` parameter see a `createElement` method description.
-
-<a name="THtmlInputField.createElement"></a>
-##### **createElement(name\[, options\[, bRetChild]])** => `null|object|HTMLElement`
-
-This method creates a container with all elements needed for input field component to function.
-
-| parameter name | value type | default value | description |
-|:---|---|---:|:---|
-| `name` | `string` | --- | an ID of the created container |
-| `options` | `object` | --- | an options |
-| `bRetChild` | `boolean` | `false` | a flag to change a result value type |
-
-The `options` structure has listed below:
-
-| option name | value type | default value | description |
-|:---|---|---:|:---|
-| `host` | `HTMLElement`| --- | an HTML-element which is a host for all container elements |
-| `idPref` | `string` | --- | a prefix which modified a container ID, if given |
-| `label` | `string` | --- | a text for the field label |
-| `labelPosition` | `string` | --- | defines a position to place a label |
-| `useDelim` | `boolean` | `true` | defines whether a delimiter is used within a text of a label |
-| `baseClassID` | `object` | --- | contains a list of class name attributes for container elements |
-| `hint` | `string` | --- | defines a helper string which is shown when a field content is empty |
-| `fldType` | `string` | `default` | defines a field type |
-| `isReadOnly` | `boolean` | `true` | defines whether a field content can be modified |
-
-The `labelPosition` option value can be: `before`, `after` or `default` (*the latter is the same as `before`*).
-
-The `baseClassID` structure has listed below:
-
-| option name | value type | default value | description |
-|:---|---|---:|:---|
-| `main` | `string`, `string[]` | --- | contains a list of class name attributes for all elements |
-| `host` | `string`, `string[]` | --- | contains a list of class name attributes for container host |
-| `label` | `string`, `string[]` | --- | contains a list of class name attributes for label element |
-| `field` | `string`, `string[]` | --- | contains a list of class name attributes for field element |
-
-The `fldType` option value can be: `text`, `field`, `checkbox`, `switch` or `default` (*the latter is the same as `field`*).
-
-The `bRetChild` parameter, if given, changes the result value of the method. It must be of a `boolean` type. If value is `false` the only host element is returned as a result (a default behavior). If `true`, an `object` of the following structure is returned:
-
-| property name | value type | description |
-|:---|---|:---|
-| `host` | `HTMLElement` | a container host element |
-| `label` | `HTMLElement` | a container label element |
-| `field` | `HTMLElement` | a container field element |
-
-#### class methods (*special*)
-
-<a name="THtmlInputField+on"></a>
-##### **on(name, event)** => `void`
-
-This method sets event handler for the list event addressed by a `name` parameter.
-
-| parameter name | value type | default value | description |
-|:---|---|---:|:---|
-| `name` | `string` | --- | an event name |
-| `event` | `function` | --- | a callback function |
-
-> 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 |
-|:---|:---|
-| `value-changed` | fired when value is changed |
-| `value-empty` | fired due editing of the field when its value become an empty string |