@react-md/app-bar - npm Package Compare versions

Comparing version 2.6.0 to 2.7.0

CHANGELOG.md

@@ -6,2 +6,20 @@ # 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))
+
+
+### 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 +26,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-app-bar-z-index": number;

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/AppBar.js

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

es/AppBarAction.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/AppBarTitle.js

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

es/useActionClassName.js

@@ -10,3 +10,3 @@ import cn from "classnames";
  *
- * @private
+ * @internal
  */
@@ -13,0 +13,0 @@ export function useActionClassName(_a) {

es/useInheritContext.js

 import { createContext, useContext } from "react";
 /**
  * Boolean if the child components should inherit the color of the app bar.
- * @private
+ * @internal
  */
@@ -13,5 +13,5 @@ export var InheritContext = createContext(false);
  *
- * @param inheritColor The prop inheritColor for the component
- * @return true if the color should be inherited.
- * @private
+ * @param inheritColor - The prop inheritColor for the component
+ * @returns true if the color should be inherited.
+ * @internal
  */
@@ -28,3 +28,3 @@ export function useInheritContext(inheritColor) {
  *
- * @private
+ * @internal
  */
@@ -34,3 +34,3 @@ export var ParentContext = createContext(false);
  *
- * @private
+ * @internal
  */
@@ -37,0 +37,0 @@ export function useParentContext() {

lib/AppBar.js

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

lib/AppBarAction.js

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

lib/AppBarTitle.js

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

lib/useActionClassName.d.ts

@@ -9,4 +9,4 @@ import { AppBarColorInherit } from "./useInheritContext";
      * Boolean if this is the first action within the app bar. This is really just
-     * used to automatically right-align all the actions by applying `margin-left:
-     * auto` to this action.
+     * used to automatically right-align all the actions by applying
+     * `margin-left: auto` to this action.
      */
@@ -27,4 +27,4 @@ first?: boolean;
  *
- * @private
+ * @internal
  */
 export declare function useActionClassName({ first, last, inheritColor, className, }?: AppBarActionClassNameProps): string;

lib/useActionClassName.js

@@ -16,3 +16,3 @@ "use strict";
  *
- * @private
+ * @internal
  */
@@ -19,0 +19,0 @@ function useActionClassName(_a) {

lib/useInheritContext.d.ts

 /// <reference types="react" />
 /**
  * Boolean if the child components should inherit the color of the app bar.
- * @private
+ * @internal
  */
@@ -21,5 +21,5 @@ export declare const InheritContext: import("react").Context<boolean>;
  *
- * @param inheritColor The prop inheritColor for the component
- * @return true if the color should be inherited.
- * @private
+ * @param inheritColor - The prop inheritColor for the component
+ * @returns true if the color should be inherited.
+ * @internal
  */
@@ -33,3 +33,3 @@ export declare function useInheritContext(inheritColor: boolean | undefined): boolean;
  *
- * @private
+ * @internal
  */
@@ -39,4 +39,4 @@ export declare const ParentContext: import("react").Context<boolean>;
  *
- * @private
+ * @internal
  */
 export declare function useParentContext(): boolean;

lib/useInheritContext.js

@@ -7,3 +7,3 @@ "use strict";
  * Boolean if the child components should inherit the color of the app bar.
- * @private
+ * @internal
  */
@@ -17,5 +17,5 @@ exports.InheritContext = react_1.createContext(false);
  *
- * @param inheritColor The prop inheritColor for the component
- * @return true if the color should be inherited.
- * @private
+ * @param inheritColor - The prop inheritColor for the component
+ * @returns true if the color should be inherited.
+ * @internal
  */
@@ -33,3 +33,3 @@ function useInheritContext(inheritColor) {
  *
- * @private
+ * @internal
  */
@@ -39,3 +39,3 @@ exports.ParentContext = react_1.createContext(false);
  *
- * @private
+ * @internal
  */
@@ -42,0 +42,0 @@ function useParentContext() {

package.json

 {
   "name": "@react-md/app-bar",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "description": "This small package implments the AppBar spec in material design.",
@@ -39,8 +39,8 @@ "main": "./lib/index.js",
   "dependencies": {
-    "@react-md/button": "^2.6.0",
-    "@react-md/elevation": "^2.6.0",
-    "@react-md/icon": "^2.6.0",
-    "@react-md/theme": "^2.6.0",
-    "@react-md/typography": "^2.6.0",
-    "@react-md/utils": "^2.6.0",
+    "@react-md/button": "^2.7.0",
+    "@react-md/elevation": "^2.7.0",
+    "@react-md/icon": "^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"
@@ -61,3 +61,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.

src/useActionClassName.ts

@@ -16,4 +16,4 @@ import cn from "classnames";
    * Boolean if this is the first action within the app bar. This is really just
-   * used to automatically right-align all the actions by applying `margin-left:
-   * auto` to this action.
+   * used to automatically right-align all the actions by applying
+   * `margin-left: auto` to this action.
    */
@@ -36,3 +36,3 @@ first?: boolean;
  *
- * @private
+ * @internal
  */
@@ -39,0 +39,0 @@ export function useActionClassName({

src/useInheritContext.ts

@@ -5,3 +5,3 @@ import { createContext, useContext } from "react";
  * Boolean if the child components should inherit the color of the app bar.
- * @private
+ * @internal
  */
@@ -25,5 +25,5 @@ export const InheritContext = createContext(false);
  *
- * @param inheritColor The prop inheritColor for the component
- * @return true if the color should be inherited.
- * @private
+ * @param inheritColor - The prop inheritColor for the component
+ * @returns true if the color should be inherited.
+ * @internal
  */
@@ -41,3 +41,3 @@ export function useInheritContext(inheritColor: boolean | undefined): boolean {
  *
- * @private
+ * @internal
  */
@@ -48,3 +48,3 @@ export const ParentContext = createContext(false);
  *
- * @private
+ * @internal
  */
@@ -51,0 +51,0 @@ export function useParentContext(): boolean {

types/useActionClassName.d.ts

@@ -9,4 +9,4 @@ import { AppBarColorInherit } from "./useInheritContext";
      * Boolean if this is the first action within the app bar. This is really just
-     * used to automatically right-align all the actions by applying `margin-left:
-     * auto` to this action.
+     * used to automatically right-align all the actions by applying
+     * `margin-left: auto` to this action.
      */
@@ -27,4 +27,4 @@ first?: boolean;
  *
- * @private
+ * @internal
  */
 export declare function useActionClassName({ first, last, inheritColor, className, }?: AppBarActionClassNameProps): string;

types/useInheritContext.d.ts

 /// <reference types="react" />
 /**
  * Boolean if the child components should inherit the color of the app bar.
- * @private
+ * @internal
  */
@@ -21,5 +21,5 @@ export declare const InheritContext: import("react").Context<boolean>;
  *
- * @param inheritColor The prop inheritColor for the component
- * @return true if the color should be inherited.
- * @private
+ * @param inheritColor - The prop inheritColor for the component
+ * @returns true if the color should be inherited.
+ * @internal
  */
@@ -33,3 +33,3 @@ export declare function useInheritContext(inheritColor: boolean | undefined): boolean;
  *
- * @private
+ * @internal
  */
@@ -39,4 +39,4 @@ export declare const ParentContext: import("react").Context<boolean>;
  *
- * @private
+ * @internal
  */
 export declare function useParentContext(): boolean;

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

189115

increased by0.46%

Lines of code

2292

increased by0.22%

Dependency changes

• Updated@react-md/button@^2.7.0

• Updated@react-md/elevation@^2.7.0

• Updated@react-md/icon@^2.7.0

• Updated@react-md/theme@^2.7.0

• Updated@react-md/typography@^2.7.0

• Updated@react-md/utils@^2.7.0