@react-md/icon - 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-icon-color": 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/FontIcon.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/IconProvider.js

@@ -28,5 +28,5 @@ import React, { createContext, useContext, useMemo, } from "react";
  *
- * @param name The name of the icon you want to use.
- * @param override An optional override to use instead of the inherited icon.
- * @return The overridden icon value or the inherited icon.
+ * @param name - The name of the icon you want to use.
+ * @param override - An optional override to use instead of the inherited icon.
+ * @returns The overridden icon value or the inherited icon.
  */
@@ -80,2 +80,3 @@ export function useIcon(name, override) {
 }
+/* istanbul ignore next */
 if (process.env.NODE_ENV !== "production") {
@@ -82,0 +83,0 @@ try {

es/IconRotator.js

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

es/SVGIcon.js

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

es/TextIconSpacing.js

@@ -35,2 +35,3 @@ import React, { Children, cloneElement, isValidElement, } from "react";
 }
+/* istanbul ignore next */
 if (process.env.NODE_ENV !== "production") {
@@ -37,0 +38,0 @@ try {

lib/FontIcon.js

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

lib/IconProvider.d.ts

@@ -23,3 +23,3 @@ import { ReactElement, ReactNode } from "react";
      *
-     * @since 2.5.0
+     * @remarks \@since 2.5.0
      */
@@ -75,5 +75,5 @@ error?: ReactNode;
  *
- * @param name The name of the icon you want to use.
- * @param override An optional override to use instead of the inherited icon.
- * @return The overridden icon value or the inherited icon.
+ * @param name - The name of the icon you want to use.
+ * @param override - An optional override to use instead of the inherited icon.
+ * @returns The overridden icon value or the inherited icon.
  */
@@ -80,0 +80,0 @@ export declare function useIcon(name: keyof ConfigurableIcons, override?: ReactNode | undefined): ReactNode;

lib/IconProvider.js

@@ -50,5 +50,5 @@ "use strict";
  *
- * @param name The name of the icon you want to use.
- * @param override An optional override to use instead of the inherited icon.
- * @return The overridden icon value or the inherited icon.
+ * @param name - The name of the icon you want to use.
+ * @param override - An optional override to use instead of the inherited icon.
+ * @returns The overridden icon value or the inherited icon.
  */
@@ -104,2 +104,3 @@ function useIcon(name, override) {
 exports.IconProvider = IconProvider;
+/* istanbul ignore next */
 if (process.env.NODE_ENV !== "production") {
@@ -106,0 +107,0 @@ try {

lib/IconRotator.js

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

lib/SVGIcon.d.ts

@@ -42,4 +42,6 @@ import React, { HTMLAttributes, ReactNode } from "react";
      *
-     * > NOTE: IE **does not support** external SVGs. Please see the demo for more
-     * > details.
+     * @remarks
+     *
+     * NOTE: IE **does not support** external SVGs. Please see the demo for more
+     * details.
      */
@@ -46,0 +48,0 @@ use?: string;

lib/SVGIcon.js

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

lib/TextIconSpacing.d.ts

@@ -58,4 +58,4 @@ import { ReactElement, ReactNode } from "react";
      * Boolean if the icon and text should be stacked instead of inline. Note:
-     * You'll normally want to update the container element to have `display:
-     * flex` and `flex-direction: column` for this to work.
+     * You'll normally want to update the container element to have
+     * `display: flex` and `flex-direction: column` for this to work.
      */
@@ -67,3 +67,3 @@ stacked?: boolean;
      *
-     * @since 2.5.0
+     * @remarks \@since 2.5.0
      */
@@ -70,0 +70,0 @@ flexReverse?: boolean;

lib/TextIconSpacing.js

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

package.json

 {
   "name": "@react-md/icon",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "description": "This package is for including icons within react-md. There is included support for both font icons and SVG icons.  There is also a helper component for applying spacing between icons and text.",
@@ -40,5 +40,5 @@ "main": "./lib/index.js",
   "dependencies": {
-    "@react-md/theme": "^2.6.0",
-    "@react-md/typography": "^2.6.0",
-    "@react-md/utils": "^2.6.0",
+    "@react-md/theme": "^2.7.0",
+    "@react-md/typography": "^2.7.0",
+    "@react-md/utils": "^2.7.0",
     "classnames": "^2.2.6"
@@ -59,3 +59,3 @@ },
   },
-  "gitHead": "fe442494d054126c0ba9ee40260d234668e2ba18"
+  "gitHead": "931e81f628b580837df3a97267a42c9880b13815"
 }

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/IconProvider.d.ts

@@ -23,3 +23,3 @@ import { ReactElement, ReactNode } from "react";
      *
-     * @since 2.5.0
+     * @remarks \@since 2.5.0
      */
@@ -75,5 +75,5 @@ error?: ReactNode;
  *
- * @param name The name of the icon you want to use.
- * @param override An optional override to use instead of the inherited icon.
- * @return The overridden icon value or the inherited icon.
+ * @param name - The name of the icon you want to use.
+ * @param override - An optional override to use instead of the inherited icon.
+ * @returns The overridden icon value or the inherited icon.
  */
@@ -80,0 +80,0 @@ export declare function useIcon(name: keyof ConfigurableIcons, override?: ReactNode | undefined): ReactNode;

types/SVGIcon.d.ts

@@ -42,4 +42,6 @@ import React, { HTMLAttributes, ReactNode } from "react";
      *
-     * > NOTE: IE **does not support** external SVGs. Please see the demo for more
-     * > details.
+     * @remarks
+     *
+     * NOTE: IE **does not support** external SVGs. Please see the demo for more
+     * details.
      */
@@ -46,0 +48,0 @@ use?: string;

types/TextIconSpacing.d.ts

@@ -58,4 +58,4 @@ import { ReactElement, ReactNode } from "react";
      * Boolean if the icon and text should be stacked instead of inline. Note:
-     * You'll normally want to update the container element to have `display:
-     * flex` and `flex-direction: column` for this to work.
+     * You'll normally want to update the container element to have
+     * `display: flex` and `flex-direction: column` for this to work.
      */
@@ -67,3 +67,3 @@ stacked?: boolean;
      *
-     * @since 2.5.0
+     * @remarks \@since 2.5.0
      */
@@ -70,0 +70,0 @@ flexReverse?: boolean;

No alert changes

Improved metrics

Total package byte prevSize

194761

increased by0.68%

Lines of code

2503

increased by0.68%

Dependency changes

• Updated@react-md/theme@^2.7.0

• Updated@react-md/typography@^2.7.0

• Updated@react-md/utils@^2.7.0