@react-md/autocomplete - 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 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 +26,0 @@

es/AutoComplete.js

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

es/HighlightedResult.js

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

es/useAutoComplete.js

@@ -19,3 +19,3 @@ var __assign = (this && this.__assign) || function () {
  *
- * @private
+ * @internal
  */
@@ -22,0 +22,0 @@ export function useAutoComplete(_a) {

es/utils.js

@@ -5,5 +5,5 @@ import { caseInsensitiveFilter, fuzzyFilter } from "@react-md/utils";
  *
- * @param id The listbox's id
- * @param index The index of the result in the list
- * @return an id string
+ * @param id - The listbox's id
+ * @param index - The index of the result in the list
+ * @returns an id string
  */
@@ -17,8 +17,8 @@ export function getResultId(id, index) {
  *
- * @param datum The current result datum to get a label for
- * @param labelKey The key to extract a label from if the datum is an object
- * @param query The current search query. This is useful if you want to
+ * @param datum - The current result datum to get a label for
+ * @param labelKey - The key to extract a label from if the datum is an object
+ * @param query - The current search query. This is useful if you want to
  * implement text "highlighting" (bold) of all the letters that match in the
  * item.
- * @return a renderable node to display
+ * @returns a renderable node to display
  */
@@ -35,6 +35,6 @@ export function getResultLabel(datum, labelKey, _query) {
  *
- * @param datum The current result datum that should have a string extracted
- * @param valueKey The key to use to extract a string value from if the datum is
- * an object
- * @return a searchable string.
+ * @param datum - The current result datum that should have a string extracted
+ * @param valueKey - The key to use to extract a string value from if the datum
+ * is an object
+ * @returns a searchable string.
  */
@@ -56,3 +56,3 @@ export function getResultValue(datum, valueKey) {
  * Useful when the filtering is done somewhere else like a server/API
- * @private
+ * @internal
  */
@@ -64,3 +64,3 @@ export var noFilter = function (_, data) { return data; };
  *
- * @private
+ * @internal
  */
@@ -108,3 +108,3 @@ export function getFilterFunction(filter) {
  *
- * @param datum The result data to type guard against.
+ * @param datum - The result data to type guard against.
  */
@@ -111,0 +111,0 @@ export function isResultOf(datum) {

lib/AutoComplete.js

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

lib/HighlightedResult.js

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

lib/types.d.ts

@@ -246,3 +246,3 @@ import { CSSProperties, ReactNode } from "react";
      *
-     * @since 2.1.0
+     * @remarks \@since 2.1.0
      */
@@ -255,5 +255,5 @@ beforeResultsChildren?: ReactNode;
      *
-     * @since 2.1.0
+     * @remarks \@since 2.1.0
      */
     afterResultsChildren?: ReactNode;
 }

lib/useAutoComplete.d.ts

@@ -38,5 +38,5 @@ import { ChangeEventHandler, CSSProperties, FocusEventHandler, HTMLAttributes, KeyboardEventHandler, MouseEventHandler, MutableRefObject, Ref } from "react";
  *
- * @private
+ * @internal
  */
 export declare function useAutoComplete({ suggestionsId, data, propValue, defaultValue, filter: filterFn, filterOptions, filterOnNoValue, valueKey, getResultId, getResultValue, onBlur, onFocus, onClick, onChange, onKeyDown, forwardedRef, onAutoComplete, clearOnAutoComplete, anchor, xMargin, yMargin, vwMargin, vhMargin, transformOrigin, listboxWidth, listboxStyle, preventOverlap, disableSwapping, disableVHBounds, closeOnResize, closeOnScroll, disableShowOnFocus: propDisableShowOnFocus, isListAutocomplete, isInlineAutocomplete, }: AutoCompleteOptions): AutoCompleteReturnValue;
 export {};

lib/useAutoComplete.js

@@ -22,3 +22,3 @@ "use strict";
  *
- * @private
+ * @internal
  */
@@ -25,0 +25,0 @@ function useAutoComplete(_a) {

lib/utils.d.ts

@@ -6,5 +6,5 @@ import { ReactNode } from "react";
  *
- * @param id The listbox's id
- * @param index The index of the result in the list
- * @return an id string
+ * @param id - The listbox's id
+ * @param index - The index of the result in the list
+ * @returns an id string
  */
@@ -16,8 +16,8 @@ export declare function getResultId(id: string, index: number): string;
  *
- * @param datum The current result datum to get a label for
- * @param labelKey The key to extract a label from if the datum is an object
- * @param query The current search query. This is useful if you want to
+ * @param datum - The current result datum to get a label for
+ * @param labelKey - The key to extract a label from if the datum is an object
+ * @param query - The current search query. This is useful if you want to
  * implement text "highlighting" (bold) of all the letters that match in the
  * item.
- * @return a renderable node to display
+ * @returns a renderable node to display
  */
@@ -28,6 +28,6 @@ export declare function getResultLabel(datum: Readonly<AutoCompleteData>, labelKey: string, _query: string): ReactNode;
  *
- * @param datum The current result datum that should have a string extracted
- * @param valueKey The key to use to extract a string value from if the datum is
- * an object
- * @return a searchable string.
+ * @param datum - The current result datum that should have a string extracted
+ * @param valueKey - The key to use to extract a string value from if the datum
+ * is an object
+ * @returns a searchable string.
  */
@@ -38,3 +38,3 @@ export declare function getResultValue(datum: Readonly<AutoCompleteData>, valueKey: string): string;
  * Useful when the filtering is done somewhere else like a server/API
- * @private
+ * @internal
  */
@@ -46,3 +46,3 @@ export declare const noFilter: FilterFunction;
  *
- * @private
+ * @internal
  */
@@ -73,4 +73,4 @@ export declare function getFilterFunction<O extends {} = {}>(filter: AutoCompleteFilterFunction<O>): FilterFunction<O>;
  *
- * @param datum The result data to type guard against.
+ * @param datum - The result data to type guard against.
  */
 export declare function isResultOf<T extends {}>(datum: Readonly<AutoCompleteData>): datum is T;

lib/utils.js

@@ -8,5 +8,5 @@ "use strict";
  *
- * @param id The listbox's id
- * @param index The index of the result in the list
- * @return an id string
+ * @param id - The listbox's id
+ * @param index - The index of the result in the list
+ * @returns an id string
  */
@@ -21,8 +21,8 @@ function getResultId(id, index) {
  *
- * @param datum The current result datum to get a label for
- * @param labelKey The key to extract a label from if the datum is an object
- * @param query The current search query. This is useful if you want to
+ * @param datum - The current result datum to get a label for
+ * @param labelKey - The key to extract a label from if the datum is an object
+ * @param query - The current search query. This is useful if you want to
  * implement text "highlighting" (bold) of all the letters that match in the
  * item.
- * @return a renderable node to display
+ * @returns a renderable node to display
  */
@@ -40,6 +40,6 @@ function getResultLabel(datum, labelKey, _query) {
  *
- * @param datum The current result datum that should have a string extracted
- * @param valueKey The key to use to extract a string value from if the datum is
- * an object
- * @return a searchable string.
+ * @param datum - The current result datum that should have a string extracted
+ * @param valueKey - The key to use to extract a string value from if the datum
+ * is an object
+ * @returns a searchable string.
  */
@@ -62,3 +62,3 @@ function getResultValue(datum, valueKey) {
  * Useful when the filtering is done somewhere else like a server/API
- * @private
+ * @internal
  */
@@ -71,3 +71,3 @@ var noFilter = function (_, data) { return data; };
  *
- * @private
+ * @internal
  */
@@ -116,3 +116,3 @@ function getFilterFunction(filter) {
  *
- * @param datum The result data to type guard against.
+ * @param datum - The result data to type guard against.
  */
@@ -119,0 +119,0 @@ function isResultOf(datum) {

package.json

 {
   "name": "@react-md/autocomplete",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "description": "",
@@ -41,10 +41,10 @@ "main": "./lib/index.js",
   "dependencies": {
-    "@react-md/form": "^2.6.0",
-    "@react-md/list": "^2.6.0",
-    "@react-md/portal": "^2.5.0",
-    "@react-md/states": "^2.6.0",
-    "@react-md/theme": "^2.6.0",
-    "@react-md/transition": "^2.6.0",
-    "@react-md/typography": "^2.6.0",
-    "@react-md/utils": "^2.6.0",
+    "@react-md/form": "^2.7.0",
+    "@react-md/list": "^2.7.0",
+    "@react-md/portal": "^2.7.0",
+    "@react-md/states": "^2.7.0",
+    "@react-md/theme": "^2.7.0",
+    "@react-md/transition": "^2.7.0",
+    "@react-md/typography": "^2.7.0",
+    "@react-md/utils": "^2.7.0",
     "classnames": "^2.2.6"
@@ -65,3 +65,3 @@ },
   },
-  "gitHead": "fe442494d054126c0ba9ee40260d234668e2ba18"
+  "gitHead": "931e81f628b580837df3a97267a42c9880b13815"
 }

src/types.ts

@@ -298,3 +298,3 @@ import { CSSProperties, ReactNode } from "react";
    *
-   * @since 2.1.0
+   * @remarks \@since 2.1.0
    */
@@ -308,5 +308,5 @@ beforeResultsChildren?: ReactNode;
    *
-   * @since 2.1.0
+   * @remarks \@since 2.1.0
    */
   afterResultsChildren?: ReactNode;
 }

src/useAutoComplete.ts

@@ -94,3 +94,3 @@ import {
  *
- * @private
+ * @internal
  */
@@ -97,0 +97,0 @@ export function useAutoComplete({

src/utils.ts

@@ -13,5 +13,5 @@ import { ReactNode } from "react";
  *
- * @param id The listbox's id
- * @param index The index of the result in the list
- * @return an id string
+ * @param id - The listbox's id
+ * @param index - The index of the result in the list
+ * @returns an id string
  */
@@ -26,8 +26,8 @@ export function getResultId(id: string, index: number): string {
  *
- * @param datum The current result datum to get a label for
- * @param labelKey The key to extract a label from if the datum is an object
- * @param query The current search query. This is useful if you want to
+ * @param datum - The current result datum to get a label for
+ * @param labelKey - The key to extract a label from if the datum is an object
+ * @param query - The current search query. This is useful if you want to
  * implement text "highlighting" (bold) of all the letters that match in the
  * item.
- * @return a renderable node to display
+ * @returns a renderable node to display
  */
@@ -50,6 +50,6 @@ export function getResultLabel(
  *
- * @param datum The current result datum that should have a string extracted
- * @param valueKey The key to use to extract a string value from if the datum is
- * an object
- * @return a searchable string.
+ * @param datum - The current result datum that should have a string extracted
+ * @param valueKey - The key to use to extract a string value from if the datum
+ * is an object
+ * @returns a searchable string.
  */
@@ -79,3 +79,3 @@ export function getResultValue(
  * Useful when the filtering is done somewhere else like a server/API
- * @private
+ * @internal
  */
@@ -88,3 +88,3 @@ export const noFilter: FilterFunction = (_, data) => data;
  *
- * @private
+ * @internal
  */
@@ -139,3 +139,3 @@ export function getFilterFunction<O extends {} = {}>(
  *
- * @param datum The result data to type guard against.
+ * @param datum - The result data to type guard against.
  */
@@ -142,0 +142,0 @@ export function isResultOf<T extends {}>(

types/types.d.ts

@@ -246,3 +246,3 @@ import { CSSProperties, ReactNode } from "react";
      *
-     * @since 2.1.0
+     * @remarks \@since 2.1.0
      */
@@ -255,5 +255,5 @@ beforeResultsChildren?: ReactNode;
      *
-     * @since 2.1.0
+     * @remarks \@since 2.1.0
      */
     afterResultsChildren?: ReactNode;
 }

types/useAutoComplete.d.ts

@@ -38,5 +38,5 @@ import { ChangeEventHandler, CSSProperties, FocusEventHandler, HTMLAttributes, KeyboardEventHandler, MouseEventHandler, MutableRefObject, Ref } from "react";
  *
- * @private
+ * @internal
  */
 export declare function useAutoComplete({ suggestionsId, data, propValue, defaultValue, filter: filterFn, filterOptions, filterOnNoValue, valueKey, getResultId, getResultValue, onBlur, onFocus, onClick, onChange, onKeyDown, forwardedRef, onAutoComplete, clearOnAutoComplete, anchor, xMargin, yMargin, vwMargin, vhMargin, transformOrigin, listboxWidth, listboxStyle, preventOverlap, disableSwapping, disableVHBounds, closeOnResize, closeOnScroll, disableShowOnFocus: propDisableShowOnFocus, isListAutocomplete, isInlineAutocomplete, }: AutoCompleteOptions): AutoCompleteReturnValue;
 export {};

types/utils.d.ts

@@ -6,5 +6,5 @@ import { ReactNode } from "react";
  *
- * @param id The listbox's id
- * @param index The index of the result in the list
- * @return an id string
+ * @param id - The listbox's id
+ * @param index - The index of the result in the list
+ * @returns an id string
  */
@@ -16,8 +16,8 @@ export declare function getResultId(id: string, index: number): string;
  *
- * @param datum The current result datum to get a label for
- * @param labelKey The key to extract a label from if the datum is an object
- * @param query The current search query. This is useful if you want to
+ * @param datum - The current result datum to get a label for
+ * @param labelKey - The key to extract a label from if the datum is an object
+ * @param query - The current search query. This is useful if you want to
  * implement text "highlighting" (bold) of all the letters that match in the
  * item.
- * @return a renderable node to display
+ * @returns a renderable node to display
  */
@@ -28,6 +28,6 @@ export declare function getResultLabel(datum: Readonly<AutoCompleteData>, labelKey: string, _query: string): ReactNode;
  *
- * @param datum The current result datum that should have a string extracted
- * @param valueKey The key to use to extract a string value from if the datum is
- * an object
- * @return a searchable string.
+ * @param datum - The current result datum that should have a string extracted
+ * @param valueKey - The key to use to extract a string value from if the datum
+ * is an object
+ * @returns a searchable string.
  */
@@ -38,3 +38,3 @@ export declare function getResultValue(datum: Readonly<AutoCompleteData>, valueKey: string): string;
  * Useful when the filtering is done somewhere else like a server/API
- * @private
+ * @internal
  */
@@ -46,3 +46,3 @@ export declare const noFilter: FilterFunction;
  *
- * @private
+ * @internal
  */
@@ -73,4 +73,4 @@ export declare function getFilterFunction<O extends {} = {}>(filter: AutoCompleteFilterFunction<O>): FilterFunction<O>;
  *
- * @param datum The result data to type guard against.
+ * @param datum - The result data to type guard against.
  */
 export declare function isResultOf<T extends {}>(datum: Readonly<AutoCompleteData>): datum is T;

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

219676

increased by0.45%

Lines of code

3988

increased by0.15%

Dependency changes

• Updated@react-md/form@^2.7.0

• Updated@react-md/list@^2.7.0

• Updated@react-md/portal@^2.7.0

• Updated@react-md/states@^2.7.0

• Updated@react-md/theme@^2.7.0

• Updated@react-md/transition@^2.7.0

• Updated@react-md/typography@^2.7.0

• Updated@react-md/utils@^2.7.0