@react-md/list - npm Package Compare versions

Comparing version 2.6.0 to 2.7.0

CHANGELOG.md

@@ -6,2 +6,21 @@ # Change Log
 
+# [2.7.0](https://github.com/mlaursen/react-md/compare/v2.6.0...v2.7.0) (2021-02-28)
+
+
+### Documentation
+
+* **tsdoc:** fixed remaining tsdoc syntax warnings ([946f4dd](https://github.com/mlaursen/react-md/commit/946f4dddf380b9f2313fb76d54d969aa2adbff53))
+* **tsdoc:** fixed some tsdoc annotations and styling ([0449b86](https://github.com/mlaursen/react-md/commit/0449b86e4e51793710b35a452b7ebcbb6e7b5b2e))
+* **tsdoc:** updated \@since annotations ([c62027e](https://github.com/mlaursen/react-md/commit/c62027ebf2223167a2fde0378882e4b934d61971))
+
+
+### Other Internal Changes
+
+* updated test coverage to not include conditional component PropTypes ([24e5df1](https://github.com/mlaursen/react-md/commit/24e5df14c731411d7691253383435036326407b5))
+
+
+
+
+
+
 # [2.6.0](https://github.com/mlaursen/react-md/compare/v2.5.5...v2.6.0) (2021-02-13)
@@ -8,0 +27,0 @@

dist/scssVariables.d.ts

@@ -1,5 +0,1 @@
-/**
- * This file was generated from @react-md/dev-utils and should not be updated
- * manually.
- */
 declare const _default: {
@@ -6,0 +2,0 @@ "rmd-list-vertical-padding": string;

dist/scssVariables.js

 "use strict";
-/**
+/*
  * This file was generated from @react-md/dev-utils and should not be updated
@@ -4,0 +4,0 @@ * manually.

es/getListItemHeight.js

@@ -7,9 +7,9 @@ /**
  *
- * - height !== "auto" -> height
- * - secondaryText or left/right addon is media/media-large  -> "extra-large"
- * - left/right addon is avatar -> "large"
- * - left/right addon is icon -> "medium"
- * - no addons and no secondary text -> "normal"
+ * - height !== "auto" -> height
+ * - secondaryText or left/right addon is media/media-large  -> "extra-large"
+ * - left/right addon is avatar -> "large"
+ * - left/right addon is icon -> "medium"
+ * - no addons and no secondary text -> "normal"
  *
- * @private
+ * @internal
  */
@@ -16,0 +16,0 @@ export function getListItemHeight(_a) {

es/List.js

@@ -37,2 +37,3 @@ var __assign = (this && this.__assign) || function () {
 });
+/* istanbul ignore next */
 if (process.env.NODE_ENV !== "production") {
@@ -39,0 +40,0 @@ try {

es/ListItem.js

@@ -59,2 +59,3 @@ var __assign = (this && this.__assign) || function () {
 });
+/* istanbul ignore next */
 if (process.env.NODE_ENV !== "production") {
@@ -61,0 +62,0 @@ try {

es/ListItemAddon.js

@@ -45,2 +45,3 @@ var __assign = (this && this.__assign) || function () {
 }
+/* istanbul ignore next */
 if (process.env.NODE_ENV !== "production") {
@@ -47,0 +48,0 @@ try {

es/ListItemChildren.js

@@ -28,2 +28,3 @@ import React from "react";
 }
+/* istanbul ignore next */
 if (process.env.NODE_ENV !== "production") {
@@ -30,0 +31,0 @@ try {

es/ListItemLink.js

@@ -63,2 +63,3 @@ var __assign = (this && this.__assign) || function () {
 });
+/* istanbul ignore next */
 if (process.env.NODE_ENV !== "production") {
@@ -65,0 +66,0 @@ try {

es/ListItemText.js

@@ -19,2 +19,3 @@ import React from "react";
 }
+/* istanbul ignore next */
 if (process.env.NODE_ENV !== "production") {
@@ -21,0 +22,0 @@ try {

es/ListSubheader.js

@@ -36,2 +36,3 @@ var __assign = (this && this.__assign) || function () {
 });
+/* istanbul ignore next */
 if (process.env.NODE_ENV !== "production") {
@@ -38,0 +39,0 @@ try {

es/SimpleListItem.js

@@ -62,2 +62,3 @@ var __assign = (this && this.__assign) || function () {
 });
+/* istanbul ignore next */
 if (process.env.NODE_ENV !== "production") {
@@ -64,0 +65,0 @@ try {

lib/getListItemHeight.d.ts

@@ -18,3 +18,3 @@ import { HTMLAttributes } from "react";
      * Note: This does nothing if the `disabled` prop is not enabled.
-     * @since 2.4.3
+     * @remarks \@since 2.4.3
      */
@@ -42,7 +42,7 @@ disabledOpacity?: boolean;
      *
-     * - height !== "auto" -> height
-     * - secondaryText or left/right addon is media/media-large  -> "extra-large"
-     * - left/right addon is avatar -> "large"
-     * - left/right addon is icon -> "medium"
-     * - no addons and no secondary text -> "normal"
+     * - height !== "auto" -> height
+     * - secondaryText or left/right addon is media/media-large  -> "extra-large"
+     * - left/right addon is avatar -> "large"
+     * - left/right addon is icon -> "medium"
+     * - no addons and no secondary text -> "normal"
      */
@@ -57,10 +57,10 @@ height?: ListItemHeight;
  *
- * - height !== "auto" -> height
- * - secondaryText or left/right addon is media/media-large  -> "extra-large"
- * - left/right addon is avatar -> "large"
- * - left/right addon is icon -> "medium"
- * - no addons and no secondary text -> "normal"
+ * - height !== "auto" -> height
+ * - secondaryText or left/right addon is media/media-large  -> "extra-large"
+ * - left/right addon is avatar -> "large"
+ * - left/right addon is icon -> "medium"
+ * - no addons and no secondary text -> "normal"
  *
- * @private
+ * @internal
  */
 export declare function getListItemHeight({ height, leftAddon, leftAddonType, rightAddon, rightAddonType, secondaryText, }: SimpleListItemProps): ListItemHeight;

lib/getListItemHeight.js

@@ -10,9 +10,9 @@ "use strict";
  *
- * - height !== "auto" -> height
- * - secondaryText or left/right addon is media/media-large  -> "extra-large"
- * - left/right addon is avatar -> "large"
- * - left/right addon is icon -> "medium"
- * - no addons and no secondary text -> "normal"
+ * - height !== "auto" -> height
+ * - secondaryText or left/right addon is media/media-large  -> "extra-large"
+ * - left/right addon is avatar -> "large"
+ * - left/right addon is icon -> "medium"
+ * - no addons and no secondary text -> "normal"
  *
- * @private
+ * @internal
  */
@@ -19,0 +19,0 @@ function getListItemHeight(_a) {

lib/List.js

@@ -62,2 +62,3 @@ "use strict";
 });
+/* istanbul ignore next */
 if (process.env.NODE_ENV !== "production") {
@@ -64,0 +65,0 @@ try {

lib/ListItem.js

@@ -81,2 +81,3 @@ "use strict";
 });
+/* istanbul ignore next */
 if (process.env.NODE_ENV !== "production") {
@@ -83,0 +84,0 @@ try {

lib/ListItemAddon.js

@@ -52,2 +52,3 @@ "use strict";
 exports.ListItemAddon = ListItemAddon;
+/* istanbul ignore next */
 if (process.env.NODE_ENV !== "production") {
@@ -54,0 +55,0 @@ try {

lib/ListItemChildren.js

@@ -35,2 +35,3 @@ "use strict";
 exports.ListItemChildren = ListItemChildren;
+/* istanbul ignore next */
 if (process.env.NODE_ENV !== "production") {
@@ -37,0 +38,0 @@ try {

lib/ListItemLink.d.ts

@@ -9,4 +9,4 @@ import React, { AnchorHTMLAttributes, ElementType } from "react";
      * are using a router library like
-     * [react-router](https://github.com/ReactTraining/react-router) or
-     * [@reach/router](https://github.com/reach/router). This will call
+     * {@link https://github.com/ReactTraining/react-router|react-router} or
+     * {@link https://github.com/reach/router|@reach/router}. This will call
      * `createElement` with this value and provide all props and class name.
@@ -13,0 +13,0 @@ */

lib/ListItemLink.js

@@ -88,2 +88,3 @@ "use strict";
 });
+/* istanbul ignore next */
 if (process.env.NODE_ENV !== "production") {
@@ -90,0 +91,0 @@ try {

lib/ListItemText.js

@@ -26,2 +26,3 @@ "use strict";
 exports.ListItemText = ListItemText;
+/* istanbul ignore next */
 if (process.env.NODE_ENV !== "production") {
@@ -28,0 +29,0 @@ try {

lib/ListSubheader.js

@@ -61,2 +61,3 @@ "use strict";
 });
+/* istanbul ignore next */
 if (process.env.NODE_ENV !== "production") {
@@ -63,0 +64,0 @@ try {

lib/SimpleListItem.js

@@ -87,2 +87,3 @@ "use strict";
 });
+/* istanbul ignore next */
 if (process.env.NODE_ENV !== "production") {
@@ -89,0 +90,0 @@ try {

package.json

 {
   "name": "@react-md/list",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "description": "This package is used to create lists with the material design specs.",
@@ -41,9 +41,9 @@ "main": "./lib/index.js",
   "dependencies": {
-    "@react-md/avatar": "^2.6.0",
-    "@react-md/divider": "^2.6.0",
-    "@react-md/icon": "^2.6.0",
-    "@react-md/states": "^2.6.0",
-    "@react-md/theme": "^2.6.0",
-    "@react-md/typography": "^2.6.0",
-    "@react-md/utils": "^2.6.0",
+    "@react-md/avatar": "^2.7.0",
+    "@react-md/divider": "^2.7.0",
+    "@react-md/icon": "^2.7.0",
+    "@react-md/states": "^2.7.0",
+    "@react-md/theme": "^2.7.0",
+    "@react-md/typography": "^2.7.0",
+    "@react-md/utils": "^2.7.0",
     "classnames": "^2.2.6"
@@ -64,3 +64,3 @@ },
   },
-  "gitHead": "fe442494d054126c0ba9ee40260d234668e2ba18"
+  "gitHead": "931e81f628b580837df3a97267a42c9880b13815"
 }

src/getListItemHeight.ts

@@ -29,3 +29,3 @@ import { HTMLAttributes } from "react";
    * Note: This does nothing if the `disabled` prop is not enabled.
-   * @since 2.4.3
+   * @remarks \@since 2.4.3
    */
@@ -56,7 +56,7 @@ disabledOpacity?: boolean;
    *
-   * - height !== "auto" -> height
-   * - secondaryText or left/right addon is media/media-large  -> "extra-large"
-   * - left/right addon is avatar -> "large"
-   * - left/right addon is icon -> "medium"
-   * - no addons and no secondary text -> "normal"
+   * - height !== "auto" -> height
+   * - secondaryText or left/right addon is media/media-large  -> "extra-large"
+   * - left/right addon is avatar -> "large"
+   * - left/right addon is icon -> "medium"
+   * - no addons and no secondary text -> "normal"
    */
@@ -72,9 +72,9 @@ height?: ListItemHeight;
  *
- * - height !== "auto" -> height
- * - secondaryText or left/right addon is media/media-large  -> "extra-large"
- * - left/right addon is avatar -> "large"
- * - left/right addon is icon -> "medium"
- * - no addons and no secondary text -> "normal"
+ * - height !== "auto" -> height
+ * - secondaryText or left/right addon is media/media-large  -> "extra-large"
+ * - left/right addon is avatar -> "large"
+ * - left/right addon is icon -> "medium"
+ * - no addons and no secondary text -> "normal"
  *
- * @private
+ * @internal
  */
@@ -81,0 +81,0 @@ export function getListItemHeight({

src/scssVariables.ts

@@ -1,2 +0,2 @@
-/**
+/*
  * This file was generated from @react-md/dev-utils and should not be updated
@@ -3,0 +3,0 @@ * manually.

types/getListItemHeight.d.ts

@@ -18,3 +18,3 @@ import { HTMLAttributes } from "react";
      * Note: This does nothing if the `disabled` prop is not enabled.
-     * @since 2.4.3
+     * @remarks \@since 2.4.3
      */
@@ -42,7 +42,7 @@ disabledOpacity?: boolean;
      *
-     * - height !== "auto" -> height
-     * - secondaryText or left/right addon is media/media-large  -> "extra-large"
-     * - left/right addon is avatar -> "large"
-     * - left/right addon is icon -> "medium"
-     * - no addons and no secondary text -> "normal"
+     * - height !== "auto" -> height
+     * - secondaryText or left/right addon is media/media-large  -> "extra-large"
+     * - left/right addon is avatar -> "large"
+     * - left/right addon is icon -> "medium"
+     * - no addons and no secondary text -> "normal"
      */
@@ -57,10 +57,10 @@ height?: ListItemHeight;
  *
- * - height !== "auto" -> height
- * - secondaryText or left/right addon is media/media-large  -> "extra-large"
- * - left/right addon is avatar -> "large"
- * - left/right addon is icon -> "medium"
- * - no addons and no secondary text -> "normal"
+ * - height !== "auto" -> height
+ * - secondaryText or left/right addon is media/media-large  -> "extra-large"
+ * - left/right addon is avatar -> "large"
+ * - left/right addon is icon -> "medium"
+ * - no addons and no secondary text -> "normal"
  *
- * @private
+ * @internal
  */
 export declare function getListItemHeight({ height, leftAddon, leftAddonType, rightAddon, rightAddonType, secondaryText, }: SimpleListItemProps): ListItemHeight;

types/ListItemLink.d.ts

@@ -9,4 +9,4 @@ import React, { AnchorHTMLAttributes, ElementType } from "react";
      * are using a router library like
-     * [react-router](https://github.com/ReactTraining/react-router) or
-     * [@reach/router](https://github.com/reach/router). This will call
+     * {@link https://github.com/ReactTraining/react-router|react-router} or
+     * {@link https://github.com/reach/router|@reach/router}. This will call
      * `createElement` with this value and provide all props and class name.
@@ -13,0 +13,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

295172

increased by0.58%

Lines of code

4002

increased by0.5%

Dependency changes

• Updated@react-md/avatar@^2.7.0

• Updated@react-md/divider@^2.7.0

• Updated@react-md/icon@^2.7.0

• Updated@react-md/states@^2.7.0

• Updated@react-md/theme@^2.7.0

• Updated@react-md/typography@^2.7.0

• Updated@react-md/utils@^2.7.0