@creative-web-solution/front-library 6.1.3 → 6.2.9

package/documentation/jsdocs/modules/validator/quicksearch.html

@@ -7,7 +7,7 @@
     <script src="scripts/fulltext-search.js"></script>
 
     <script type="text/x-docstrap-searchdb">
-    {"global.html":{"id":"global.html","title":"Global","body":" Documentation Classes Validator Global createStategetLabelgetLabelElementgetQueryFromFormgetRadioListisDateisEmailisEmptyisNumberisRadioListCheckedisUrlstandardValidation Global Methods createState($input, value, isValid, validatorName, data, isLiveValidation) Create a basic state object that will be return as parameter in promises Parameters: Name Type Description $input HTMLElement value String | Number isValid Boolean validatorName String data * isLiveValidation Boolean See: extra/modules/validator.md for details Returns: Type Validator_State getLabel($input [, $wrapper]) Get the text of a label's input Parameters: Name Type Argument Default Description $input HTMLElement $wrapper HTMLElement &lt;optional&gt; document.body See: extra/modules/validator.md for details Returns: Return the label, if there is only one, the list of labels if many or '' if none Type string | Array.&lt;string&gt; getLabelElement($input [, $wrapper]) Get the label of an input Parameters: Name Type Argument Default Description $input HTMLElement $wrapper HTMLElement &lt;optional&gt; document.body See: extra/modules/validator.md for details Returns: Return the label, if there is only one, the list of labels if many or null if none Type HTMLElement | Array.&lt;HTMLElement&gt; | null getQueryFromForm($form [, selector]) Create a query with the fields of a form. Use a fallback for browser that doesn't support new URLSearchParams( formData ).toString() Parameters: Name Type Argument Default Description $form HTMLElement selector String &lt;optional&gt; 'select,input,textarea' Only used for browser with no native new URLSearchParams( formData ).toString() Returns: Type String getRadioList(inputRadioOrInputName, userOptions) Get all radio with the same name Parameters: Name Type Description inputRadioOrInputName HTMLElement | string userOptions Object Properties Name Type Argument Default Description selector String &lt;optional&gt; input[name=\"{NAME}\"] css selector of the elements with a {GROUP_NAME} tag that will be replace by groupName var. othersOnly Boolean &lt;optional&gt; false if true, return the list without the element in `inputRadioOrInputName`. If `inputRadioOrInputName` is a string (input name), return all radio See: extra/modules/validator.md for details Returns: Return all elements Type Array.&lt;HTMLElement&gt; isDate(value [, format]) Test if the value is a date Parameters: Name Type Argument Default Description value String format String &lt;optional&gt; \"d/m/y\" d for day, m for month and y for year. Only in lowercase. January = 1 See: extra/modules/validator.md for details Returns: Type Boolean isEmail(value [, loose]) Test if the value is an email Parameters: Name Type Argument Description value String loose Boolean &lt;optional&gt; See: extra/modules/validator.md for details Returns: Type Boolean isEmpty(value) Test if there is a value Parameters: Name Type Description value String See: extra/modules/validator.md for details Returns: Type Boolean isNumber(value) Test if the value is a number Parameters: Name Type Description value String See: extra/modules/validator.md for details Returns: Type Boolean isRadioListChecked($iputRadioOrRadioList) Get the selected radio button from a list. Parameters: Name Type Description $iputRadioOrRadioList Array.&lt;HTMLElement&gt; | HTMLElement See: extra/modules/validator.md for details Returns: Return the selected radio button from a group or false Type false | HTMLElement isUrl(value) Test if the value is an url Parameters: Name Type Description value String See: extra/modules/validator.md for details Returns: Type Boolean standardValidation($input, value, isValid, validatorName, data, isLiveValidation) Helper for basic (synchronous) validation system Parameters: Name Type Description $input HTMLElement value String isValid Boolean validatorName String data * isLiveValidation Boolean See: extra/modules/validator.md for details Returns: Type Promise Type Definitions Validator_State Type: Object Properties: Name Type Description $input HTMLElement value String | Number isValid Boolean validatorName String data * × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:10+02:00 using the DocStrap template. "},"classes.list.html":{"id":"classes.list.html","title":"Classes","body":" Documentation Classes Validator Global createStategetLabelgetLabelElementgetQueryFromFormgetRadioListisDateisEmailisEmptyisNumberisRadioListCheckedisUrlstandardValidation Classes Classes Validator × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:10+02:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" Documentation Classes Validator Global createStategetLabelgetLabelElementgetQueryFromFormgetRadioListisDateisEmailisEmptyisNumberisRadioListCheckedisUrlstandardValidation × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:11+02:00 using the DocStrap template. "},"Validator.html":{"id":"Validator.html","title":"Class: Validator","body":" Documentation Classes Validator Global createStategetLabelgetLabelElementgetQueryFromFormgetRadioListisDateisEmailisEmptyisNumberisRadioListCheckedisUrlstandardValidation Class: Validator Validator new Validator($form, userOptions) Validate a form, a fieldset or whatever had inputs inside Parameters: Name Type Description $form HTMLElement userOptions Object Properties Name Type Argument Default Description fields String &lt;optional&gt; input,textarea,select filter String input[type=\\\"button\\\"], input[type=\\\"submit\\\"], input[type=\\\"reset\\\"], input[type=\\\"image\\\"]] customErrorLabelPrefix String &lt;optional&gt; data-error-label errorMessages Object &lt;optional&gt; {} validatorsOptions Object &lt;optional&gt; onValidate Callback &lt;optional&gt; data =&gt; {} onInvalidate Callback &lt;optional&gt; data =&gt; {} liveValidation Object &lt;optional&gt; Properties Name Type Argument Description onValidate function &lt;optional&gt; onInvalidate function &lt;optional&gt; eventsName Object &lt;optional&gt; Properties Name Type Argument Description optin String &lt;optional&gt; select String &lt;optional&gt; inputText String &lt;optional&gt; eventsHook Object &lt;optional&gt; See: extra/modules/validator.md for details Example let validator = new Validator( $form, options ) on( $form, { \"eventsName\": \"submit\", \"callback\": e =&gt; { e.preventDefault(); validator .validate() .then( data =&gt; { console.log( 'Valid', data ); $form.submit(); } ) .catch( data =&gt; { console.log( 'Invalid', data ); data.errors.forEach( input =&gt; { console.log( input.getErrorMessages() ); } ) } ); } }); Methods getAllFields(onlyValidated) Get all handled fields (DOM elements) Parameters: Name Type Description onlyValidated Boolean If true, remove all fields without validator Returns: Type Array.&lt;HTMLElement&gt; getAllInputs() Get all inputs (input objects, not DOM elements) Returns: Type Array.&lt;Input&gt; getCheckedFields() Get only the fields (DOM elements) with at least one validator Returns: Type Array.&lt;HTMLElement&gt; getCheckedInputs() Get all inputs (input objects, not DOM elements) with at least one validator Returns: Type Array.&lt;Input&gt; getFieldValidator($field) Return the validator object of an input Parameters: Name Type Description $field HTMLElement Returns: Type Input update() Bind or rebind all inputs validate() Start the validation of all the form Returns: Type Promise validateField($field) Validate one field Parameters: Name Type Description $field HTMLElement Returns: Type Promise Type Definitions Input Type: Object Properties: Name Type Description $input HTMLElement $label HTMLElement getErrorMessages function getErrors function hasError Boolean isValid function isLiveValidation Boolean × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:11+02:00 using the DocStrap template. "}}
+    {"global.html":{"id":"global.html","title":"Global","body":" Documentation Classes Validator Global createStategetLabelgetLabelElementgetQueryFromFormgetRadioListisDateisEmailisEmptyisNumberisRadioListCheckedisUrlstandardValidation Global Methods createState($input, value, isValid, validatorName, data, isLiveValidation) Create a basic state object that will be return as parameter in promises Parameters: Name Type Description $input HTMLElement value String | Number isValid Boolean validatorName String data * isLiveValidation Boolean See: extra/modules/validator.md for details Returns: Type Validator_State getLabel($input [, $wrapper]) Get the text of a label's input Parameters: Name Type Argument Default Description $input HTMLElement $wrapper HTMLElement &lt;optional&gt; document.body See: extra/modules/validator.md for details Returns: Return the label, if there is only one, the list of labels if many or '' if none Type string | Array.&lt;string&gt; getLabelElement($input [, $wrapper]) Get the label of an input Parameters: Name Type Argument Default Description $input HTMLElement $wrapper HTMLElement &lt;optional&gt; document.body See: extra/modules/validator.md for details Returns: Return the label, if there is only one, the list of labels if many or null if none Type HTMLElement | Array.&lt;HTMLElement&gt; | null getQueryFromForm($form [, selector]) Create a query with the fields of a form. Use a fallback for browser that doesn't support new URLSearchParams( formData ).toString() Parameters: Name Type Argument Default Description $form HTMLElement selector String &lt;optional&gt; 'select,input,textarea' Only used for browser with no native new URLSearchParams( formData ).toString() Returns: Type String getRadioList(inputRadioOrInputName, userOptions) Get all radio with the same name Parameters: Name Type Description inputRadioOrInputName HTMLElement | string userOptions Object Properties Name Type Argument Default Description selector String &lt;optional&gt; input[name=\"{NAME}\"] css selector of the elements with a {GROUP_NAME} tag that will be replace by groupName var. othersOnly Boolean &lt;optional&gt; false if true, return the list without the element in `inputRadioOrInputName`. If `inputRadioOrInputName` is a string (input name), return all radio See: extra/modules/validator.md for details Returns: Return all elements Type Array.&lt;HTMLElement&gt; isDate(value [, format]) Test if the value is a date Parameters: Name Type Argument Default Description value String format String &lt;optional&gt; \"d/m/y\" d for day, m for month and y for year. Only in lowercase. January = 1 See: extra/modules/validator.md for details Returns: Type Boolean isEmail(value [, loose]) Test if the value is an email Parameters: Name Type Argument Description value String loose Boolean &lt;optional&gt; See: extra/modules/validator.md for details Returns: Type Boolean isEmpty(value) Test if there is a value Parameters: Name Type Description value String See: extra/modules/validator.md for details Returns: Type Boolean isNumber(value) Test if the value is a number Parameters: Name Type Description value String See: extra/modules/validator.md for details Returns: Type Boolean isRadioListChecked($iputRadioOrRadioList) Get the selected radio button from a list. Parameters: Name Type Description $iputRadioOrRadioList Array.&lt;HTMLElement&gt; | HTMLElement See: extra/modules/validator.md for details Returns: Return the selected radio button from a group or false Type false | HTMLElement isUrl(value) Test if the value is an url Parameters: Name Type Description value String See: extra/modules/validator.md for details Returns: Type Boolean standardValidation($input, value, isValid, validatorName, data, isLiveValidation) Helper for basic (synchronous) validation system Parameters: Name Type Description $input HTMLElement value String isValid Boolean validatorName String data * isLiveValidation Boolean See: extra/modules/validator.md for details Returns: Type Promise Type Definitions Validator_State Type: Object Properties: Name Type Description $input HTMLElement value String | Number isValid Boolean validatorName String data * × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:32+01:00 using the DocStrap template. "},"classes.list.html":{"id":"classes.list.html","title":"Classes","body":" Documentation Classes Validator Global createStategetLabelgetLabelElementgetQueryFromFormgetRadioListisDateisEmailisEmptyisNumberisRadioListCheckedisUrlstandardValidation Classes Classes Validator × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:32+01:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" Documentation Classes Validator Global createStategetLabelgetLabelElementgetQueryFromFormgetRadioListisDateisEmailisEmptyisNumberisRadioListCheckedisUrlstandardValidation × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:32+01:00 using the DocStrap template. "},"Validator.html":{"id":"Validator.html","title":"Class: Validator","body":" Documentation Classes Validator Global createStategetLabelgetLabelElementgetQueryFromFormgetRadioListisDateisEmailisEmptyisNumberisRadioListCheckedisUrlstandardValidation Class: Validator Validator new Validator($form, userOptions) Validate a form, a fieldset or whatever had inputs inside Parameters: Name Type Description $form HTMLElement userOptions Object Properties Name Type Argument Default Description fields String &lt;optional&gt; input,textarea,select filter String input[type=\\\"button\\\"], input[type=\\\"submit\\\"], input[type=\\\"reset\\\"], input[type=\\\"image\\\"]] customErrorLabelPrefix String &lt;optional&gt; data-error-label errorMessages Object &lt;optional&gt; {} validatorsOptions Object &lt;optional&gt; onValidate Callback &lt;optional&gt; data =&gt; {} onInvalidate Callback &lt;optional&gt; data =&gt; {} liveValidation Object &lt;optional&gt; Properties Name Type Argument Description onValidate function &lt;optional&gt; onInvalidate function &lt;optional&gt; eventsName Object &lt;optional&gt; Properties Name Type Argument Description optin String &lt;optional&gt; select String &lt;optional&gt; inputText String &lt;optional&gt; eventsHook Object &lt;optional&gt; See: extra/modules/validator.md for details Example let validator = new Validator( $form, options ) on( $form, { \"eventsName\": \"submit\", \"callback\": e =&gt; { e.preventDefault(); validator .validate() .then( data =&gt; { console.log( 'Valid', data ); $form.submit(); } ) .catch( data =&gt; { console.log( 'Invalid', data ); data.errors.forEach( input =&gt; { console.log( input.getErrorMessages() ); } ) } ); } }); Methods getAllFields(onlyValidated) Get all handled fields (DOM elements) Parameters: Name Type Description onlyValidated Boolean If true, remove all fields without validator Returns: Type Array.&lt;HTMLElement&gt; getAllInputs() Get all inputs (input objects, not DOM elements) Returns: Type Array.&lt;Input&gt; getCheckedFields() Get only the fields (DOM elements) with at least one validator Returns: Type Array.&lt;HTMLElement&gt; getCheckedInputs() Get all inputs (input objects, not DOM elements) with at least one validator Returns: Type Array.&lt;Input&gt; getFieldValidator($field) Return the validator object of an input Parameters: Name Type Description $field HTMLElement Returns: Type Input update() Bind or rebind all inputs validate() Start the validation of all the form Returns: Type Promise validateField($field) Validate one field Parameters: Name Type Description $field HTMLElement Returns: Type Promise Type Definitions Input Type: Object Properties: Name Type Description $input HTMLElement $label HTMLElement getErrorMessages function getErrors function hasError Boolean isValid function isLiveValidation Boolean × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:32+01:00 using the DocStrap template. "}}
     </script>
 
     <script type="text/javascript">

package/documentation/jsdocs/modules/youtube-player/YouTubePlayer.html

@@ -871,7 +871,7 @@
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a>
 	
-		on 2020-07-28T16:49:08+02:00
+		on 2021-02-03T15:24:30+01:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/documentation/jsdocs/modules/youtube-player/classes.list.html

@@ -195,7 +195,7 @@
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a>
 	
-		on 2020-07-28T16:49:08+02:00
+		on 2021-02-03T15:24:30+01:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/documentation/jsdocs/modules/youtube-player/index.html

@@ -128,7 +128,7 @@
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a>
 	
-		on 2020-07-28T16:49:08+02:00
+		on 2021-02-03T15:24:30+01:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/documentation/jsdocs/modules/youtube-player/quicksearch.html

@@ -7,7 +7,7 @@
     <script src="scripts/fulltext-search.js"></script>
 
     <script type="text/x-docstrap-searchdb">
-    {"classes.list.html":{"id":"classes.list.html","title":"Classes","body":" Documentation Classes YouTubePlayer Classes Classes YouTubePlayer × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:08+02:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" Documentation Classes YouTubePlayer × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:08+02:00 using the DocStrap template. "},"YouTubePlayer.html":{"id":"YouTubePlayer.html","title":"Class: YouTubePlayer","body":" Documentation Classes YouTubePlayer Class: YouTubePlayer YouTubePlayer new YouTubePlayer(userOptions) Youtube Player loader Parameters: Name Type Description userOptions Object Properties: Name Type Argument Default Description userOptions.height Number &lt;optional&gt; userOptions.width Number &lt;optional&gt; userOptions.videoId String &lt;optional&gt; userOptions.$wrapper HTMLElement &lt;optional&gt; userOptions.apiUrl String &lt;optional&gt; //www.youtube.com/iframe_api userOptions.onPlayerStateChange function &lt;optional&gt; userOptions.playerVars YTPlayer_PlayerVars &lt;optional&gt; Google API parameters. You can add all variable handle by the API. Properties Name Type Argument Default Description autoplay Number &lt;optional&gt; 0 controls Number &lt;optional&gt; 2 autohide Number &lt;optional&gt; 1 modestbranding Number &lt;optional&gt; 1 showinfo Number &lt;optional&gt; 0 html5 Number &lt;optional&gt; 1 See: extra/modules/youtube.md Returns: Type Promise Example let YouTubePlayer = new YouTubePlayer( { \"height\": 1920, \"width\": 1080, \"videoId\": 'youtube-video-id-here', \"wrapper\": $wrapper, \"apiUrl\": \"//www.youtube.com/iframe_api\", \"onPlayerStateChange\": ( newState ) =&gt; { if ( newState.data === YT.PlayerState.ENDED ) { // Code here for video ended } }, \"playerVars\": { \"autoplay\": 0, \"controls\": 2, \"autohide\": 1, \"modestbranding\": 1, \"showinfo\": 0, \"html5\": 1, // ... All available youtube player options } } ) .then( ytPlayerInstance =&gt; {} ); × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:08+02:00 using the DocStrap template. "}}
+    {"classes.list.html":{"id":"classes.list.html","title":"Classes","body":" Documentation Classes YouTubePlayer Classes Classes YouTubePlayer × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:30+01:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" Documentation Classes YouTubePlayer × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:30+01:00 using the DocStrap template. "},"YouTubePlayer.html":{"id":"YouTubePlayer.html","title":"Class: YouTubePlayer","body":" Documentation Classes YouTubePlayer Class: YouTubePlayer YouTubePlayer new YouTubePlayer(userOptions) Youtube Player loader Parameters: Name Type Description userOptions Object Properties: Name Type Argument Default Description userOptions.height Number &lt;optional&gt; userOptions.width Number &lt;optional&gt; userOptions.videoId String &lt;optional&gt; userOptions.$wrapper HTMLElement &lt;optional&gt; userOptions.apiUrl String &lt;optional&gt; //www.youtube.com/iframe_api userOptions.onPlayerStateChange function &lt;optional&gt; userOptions.playerVars YTPlayer_PlayerVars &lt;optional&gt; Google API parameters. You can add all variable handle by the API. Properties Name Type Argument Default Description autoplay Number &lt;optional&gt; 0 controls Number &lt;optional&gt; 2 autohide Number &lt;optional&gt; 1 modestbranding Number &lt;optional&gt; 1 showinfo Number &lt;optional&gt; 0 html5 Number &lt;optional&gt; 1 See: extra/modules/youtube.md Returns: Type Promise Example let YouTubePlayer = new YouTubePlayer( { \"height\": 1920, \"width\": 1080, \"videoId\": 'youtube-video-id-here', \"wrapper\": $wrapper, \"apiUrl\": \"//www.youtube.com/iframe_api\", \"onPlayerStateChange\": ( newState ) =&gt; { if ( newState.data === YT.PlayerState.ENDED ) { // Code here for video ended } }, \"playerVars\": { \"autoplay\": 0, \"controls\": 2, \"autohide\": 1, \"modestbranding\": 1, \"showinfo\": 0, \"html5\": 1, // ... All available youtube player options } } ) .then( ytPlayerInstance =&gt; {} ); × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:30+01:00 using the DocStrap template. "}}
     </script>
 
     <script type="text/javascript">

package/package.json

@@ -2,7 +2,7 @@
   "name": "@creative-web-solution/front-library",
   "title": "Frontend library",
   "description": "Frontend functions and modules",
-  "version": "6.1.3",
+  "version": "6.2.9",
   "homepage": "https://github.com/creative-web-solution/front-library",
   "author": "Creative Web Solution <contact@cws-studio.com> (https://www.cws-studio.com)",
   "keywords": [],