vanilla-match-height - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

CHANGELOG.md

@@ -0,1 +1,8 @@
+<a name="1.0.2"></a>
+# 1.0.2 (2023-12-03)
+
+### release summary
+
+- Update document
+
 <a name="1.0.1"></a>
@@ -2,0 +9,0 @@ # 1.0.1 (2023-11-30)

dist/vanilla-match-height.js

 /**
- * vanilla-match-height v1.0.1 by @mitera
+ * vanilla-match-height v1.0.2 by @mitera
  * Simone Miterangelis <[e-mail]>
@@ -98,2 +98,3 @@ * License: MIT
      * _events
+     * Initialize the common events
      * @param {MatchHeight} $this
@@ -112,4 +113,5 @@ */
     /**
-     *  _validateProperty
-     *  handle plugin options
+     * _validateProperty
+     * handle plugin options
+     * @param {String} value
      */
@@ -126,4 +128,5 @@ MatchHeight.prototype._validateProperty = function(value) {
     /**
-     *  _parseOptions
-     *  handle plugin options
+     * _parse
+     * handle plugin options
+     * @param {String} value
      */
@@ -136,5 +139,6 @@ MatchHeight.prototype._parse = function(value) {
     /**
-     *  _rows
-     *  utility function returns array of selections representing each row
-     *  (as displayed after float wrapping applied by browser)
+     * _rows
+     * utility function returns array of selections representing each row
+     * (as displayed after float wrapping applied by browser)
+     * @param {Array} elements
      */
@@ -172,4 +176,5 @@ MatchHeight.prototype._rows = function(elements) {
     /**
-     *  _dashToCamel
-     *  utility function for transform css property dash to camel
+     * _dashToCamel
+     * utility function for transform css property dash to camel
+     * @param {String} input
      */
@@ -183,4 +188,5 @@ MatchHeight.prototype._dashToCamel = function(input) {
     /**
-     *  _applyDataApi
-     *  applies matchHeight to all elements with a data-match-height attribute
+     * _applyDataApi
+     * applies matchHeight to all elements with a data-match-height attribute
+     * @param {String} property
      */
@@ -187,0 +193,0 @@ MatchHeight.prototype._applyDataApi = function(property) {

package.json

 {
   "name": "vanilla-match-height",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "license": "MIT",
@@ -5,0 +5,0 @@ "author": "Simone Miterangelis <[e-mail]>",

README.md

@@ -74,2 +74,3 @@ # vanilla-match-height.js #
     {
+        elements: '',
         byRow: true,
@@ -85,2 +86,3 @@ property: 'height',
 
+- `elements` is an optional string containing one or more selectors to match against. This string must be a valid CSS selector string
 - `byRow` is `true` or `false` to enable row detection
@@ -87,0 +89,0 @@ - `property` is the CSS property name to set (e.g. `'height'` or `'min-height'`)

vanilla-match-height.js

 /**
- * vanilla-match-height v1.0.1 by @mitera
+ * vanilla-match-height v1.0.2 by @mitera
  * Simone Miterangelis <[e-mail]>
@@ -98,2 +98,3 @@ * License: MIT
      * _events
+     * Initialize the common events
      * @param {MatchHeight} $this
@@ -112,5 +113,6 @@ */
     /**
-    *  _validateProperty
-    *  handle plugin options
-    */
+     * _validateProperty
+     * handle plugin options
+     * @param {String} value
+     */
     MatchHeight.prototype._validateProperty = function(value) {
@@ -126,5 +128,6 @@ // parse value and convert NaN to 0
     /**
-    *  _parseOptions
-    *  handle plugin options
-    */
+     * _parse
+     * handle plugin options
+     * @param {String} value
+     */
     MatchHeight.prototype._parse = function(value) {
@@ -136,6 +139,7 @@ // parse value and convert NaN to 0
     /**
-    *  _rows
-    *  utility function returns array of selections representing each row
-    *  (as displayed after float wrapping applied by browser)
-    */
+     * _rows
+     * utility function returns array of selections representing each row
+     * (as displayed after float wrapping applied by browser)
+     * @param {Array} elements
+     */
     MatchHeight.prototype._rows = function(elements) {
@@ -172,5 +176,6 @@ var $this = this;
     /**
-    *  _dashToCamel
-    *  utility function for transform css property dash to camel
-    */
+     * _dashToCamel
+     * utility function for transform css property dash to camel
+     * @param {String} input
+     */
     MatchHeight.prototype._dashToCamel = function(input) {
@@ -183,5 +188,6 @@ return input.toLowerCase().replace(/-(.)/g, function(match, group1) {
     /**
-    *  _applyDataApi
-    *  applies matchHeight to all elements with a data-match-height attribute
-    */
+     * _applyDataApi
+     * applies matchHeight to all elements with a data-match-height attribute
+     * @param {String} property
+     */
     MatchHeight.prototype._applyDataApi = function(property) {
@@ -200,5 +206,5 @@ var $this = this;
     /**
-    *  _remove
-    *  remove matchHeight to given elements
-    */
+     *  _remove
+     *  remove matchHeight to given elements
+     */
     MatchHeight.prototype._remove = function() {
@@ -221,5 +227,5 @@ var $elements = []
     /**
-    *  _apply
-    *  apply matchHeight to given elements
-    */
+     *  _apply
+     *  apply matchHeight to given elements
+     */
     MatchHeight.prototype._apply = function() {
@@ -226,0 +232,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

173236

increased by0.36%

Lines of code

894

increased by1.36%

Number of lines in readme file

250

increased by0.81%

No dependency changes