@react-md/transition - 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-transition-sharp": 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/Collapse.js

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

es/CrossFade.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/getClassNames.js

@@ -8,3 +8,3 @@ import { defaults } from "@react-md/utils";
  *
- * @private
+ * @internal
  */
@@ -11,0 +11,0 @@ export function getClassNames(classNames, timeout) {

es/getElementSizing.js

@@ -7,3 +7,3 @@ /**
  *
- * @private
+ * @internal
  */
@@ -10,0 +10,0 @@ export function getElementSizing(element) {

es/getNextStage.js

 import { ENTER, ENTERED, ENTERING, EXIT, EXITED, EXITING, } from "./constants";
 /**
  *
- * @private
+ * @internal
  */
@@ -6,0 +6,0 @@ export function getNextStage(stage) {

es/getTimeout.js

@@ -5,3 +5,3 @@ var error = function (part) {
 /**
- * @private
+ * @internal
  */
@@ -8,0 +8,0 @@ export function getTimeout(timeout, appear) {

es/getTimeoutDuration.js

@@ -6,3 +6,3 @@ import { ENTERING, EXITING } from "./constants";
  *
- * @private
+ * @internal
  */
@@ -9,0 +9,0 @@ export function getTimeoutDuration(stage, appear, enter, exit, appearing) {

es/ScaleTransition.js

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

es/useCollapse.js

@@ -41,7 +41,7 @@ import { useMemo, useState } from "react";
  *
- * @param collapsed Boolean if the element is currently collapsed. Changing this
- * value will cause the animation to trigger.
- * @param options All the additional options available for the collapse
+ * @param collapsed - Boolean if the element is currently collapsed. Changing
+ * this value will cause the animation to trigger.
+ * @param options - All the additional options available for the collapse
  * transition.
- * @return An ordered list containing a boolean if the collapse should be
+ * @returns An ordered list containing a boolean if the collapse should be
  * rendered in the DOM followed by an object of props to pass to the collapsible
@@ -48,0 +48,0 @@ * element to handle the transition.

es/useCrossFade.js

@@ -43,5 +43,5 @@ import { CROSS_FADE_CLASSNAMES, CROSS_FADE_TIMEOUT } from "./constants";
  *
- * @param options Any additional options and configuration that should be used
+ * @param options - Any additional options and configuration that should be used
  * for the transition.
- * @return An ordered list of a boolean if the component should be rendered,
+ * @returns An ordered list of a boolean if the component should be rendered,
  * transition props to provide to the transitioning element, a dispatch function
@@ -48,0 +48,0 @@ * for triggering the transition manually (should not be used much), and the

es/useCSSTransition.js

@@ -70,4 +70,4 @@ import cn from "classnames";
  * a custom CSS Transition.
- * @param options The transition options
- * @return An ordered list of a boolean if the component should be rendered,
+ * @param options - The transition options
+ * @returns An ordered list of a boolean if the component should be rendered,
  * transition props to provide to the transitioning element, a dispatch function
@@ -74,0 +74,0 @@ * for triggering the transition manually (should not be used much), and the

es/useFixedPositioning.js

@@ -31,11 +31,13 @@ var __assign = (this && this.__assign) || function () {
 /**
- * This hook is used to automatically handle fixed positioning when an element is used alongside a
- * `Transition` from `react-transition-group`. This will provide merged `onEnter`, `onEntering`,
- * `onEntered`, and `onExited` handlers to pass down as well as the current style object to apply
- * to the element.
+ * This hook is used to automatically handle fixed positioning when an element
+ * is used alongside a `Transition` from `react-transition-group`. This will
+ * provide merged `onEnter`, `onEntering`, `onEntered`, and `onExited` handlers
+ * to pass down as well as the current style object to apply to the element.
  *
- * Until the element has been removed from the DOM and is visible, the position will automatically
- * update when the user scrolls or resizes the screen.
+ * Until the element has been removed from the DOM and is visible, the position
+ * will automatically update when the user scrolls or resizes the screen.
  *
- * > It is recommended to start the exit animation when that happens though.
+ * @remarks
+ *
+ * It is recommended to start the exit animation when that happens though.
  */
@@ -42,0 +44,0 @@ export function useFixedPositioning(_a) {

es/useTransition.js

@@ -20,3 +20,3 @@ var __assign = (this && this.__assign) || function () {
  *
- * @private
+ * @internal
  */
@@ -41,3 +41,3 @@ var reducer = function (state, action) {
  *
- * @private
+ * @internal
  */
@@ -51,3 +51,3 @@ var INITIAL_STATE = {
  *
- * @private
+ * @internal
  */
@@ -69,4 +69,4 @@ var getInitialState = function (transitionIn, temporary, appear) { return function () {
  *
- * @param options All the options used for the transition.
- * @return An object describing the current transition stage and props that
+ * @param options - All the options used for the transition.
+ * @returns An object describing the current transition stage and props that
  * should be passed to a component.
@@ -77,4 +77,4 @@ */
     var _e = useReducer(reducer, INITIAL_STATE, getInitialState(transitionIn, temporary, appear)), _f = _e[0], stage = _f.stage, rendered = _f.rendered, appearing = _f.appearing, dispatch = _e[1];
-    // need to store in mutable ref since these are mostly going to be arrow functions
-    // and shouldn't cause the transitions to change
+    // need to store in mutable ref since these are mostly going to be arrow
+    // functions and shouldn't cause the transitions to change
     var handlers = useRef({
@@ -81,0 +81,0 @@ onEnter: onEnter,

lib/Collapse.js

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

lib/CrossFade.js

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

lib/getClassNames.d.ts

@@ -10,5 +10,5 @@ import { CSSTransitionClassNames } from "react-transition-group/CSSTransition";
  *
- * @private
+ * @internal
  */
 export declare function getClassNames(classNames: CSSTransitionClassNames | string, timeout: DefinedTimeout): DefinedCSSTransitionClassNames;
 export {};

lib/getClassNames.js

@@ -11,3 +11,3 @@ "use strict";
  *
- * @private
+ * @internal
  */
@@ -14,0 +14,0 @@ function getClassNames(classNames, timeout) {

lib/getElementSizing.d.ts

@@ -12,5 +12,5 @@ interface CollapseSizing {
  *
- * @private
+ * @internal
  */
 export declare function getElementSizing(element: HTMLElement | null): CollapseSizing;
 export {};

lib/getElementSizing.js

@@ -10,3 +10,3 @@ "use strict";
  *
- * @private
+ * @internal
  */
@@ -13,0 +13,0 @@ function getElementSizing(element) {

lib/getNextStage.d.ts

 import { TransitionStage } from "./constants";
 /**
  *
- * @private
+ * @internal
  */
 export declare function getNextStage(stage: TransitionStage): TransitionStage;

lib/getNextStage.js

@@ -7,3 +7,3 @@ "use strict";
  *
- * @private
+ * @internal
  */
@@ -10,0 +10,0 @@ function getNextStage(stage) {

lib/getTimeout.d.ts

 import { TransitionTimeout } from "./types";
 /**
- * @private
+ * @internal
  */
@@ -11,4 +11,4 @@ export interface DefinedTimeout {
 /**
- * @private
+ * @internal
  */
 export declare function getTimeout(timeout: TransitionTimeout, appear: boolean): DefinedTimeout;

lib/getTimeout.js

@@ -8,3 +8,3 @@ "use strict";
 /**
- * @private
+ * @internal
  */
@@ -11,0 +11,0 @@ function getTimeout(timeout, appear) {

lib/getTimeoutDuration.d.ts

@@ -6,4 +6,4 @@ import { TransitionStage } from "./constants";
  *
- * @private
+ * @internal
  */
 export declare function getTimeoutDuration(stage: TransitionStage, appear: number, enter: number, exit: number, appearing: boolean): number;

lib/getTimeoutDuration.js

@@ -9,3 +9,3 @@ "use strict";
  *
- * @private
+ * @internal
  */
@@ -12,0 +12,0 @@ function getTimeoutDuration(stage, appear, enter, exit, appearing) {

lib/ScaleTransition.js

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

lib/types.d.ts

@@ -95,6 +95,6 @@ import { CSSProperties, Ref, RefCallback } from "react";
      * Changing from `false` to `true`, the stagees will change in this order:
-     * `EXITED` -> `ENTER` -> `ENTERING` -> `ENTERED`
+     * `EXITED -> ENTER -> ENTERING -> ENTERED`
      *
      * Changing from `true` to `false`, the stagees will change in this order:
-     * `ENTERED` -> `EXIT` -> `EXITING` -> `EXITED`
+     * `ENTERED -> EXIT -> EXITING -> EXITED`
      */
@@ -101,0 +101,0 @@ transitionIn: boolean;

lib/useCollapse.d.ts

@@ -41,7 +41,7 @@ import { CollapseOptions, CollapseTransitionProvidedProps } from "./types";
  *
- * @param collapsed Boolean if the element is currently collapsed. Changing this
- * value will cause the animation to trigger.
- * @param options All the additional options available for the collapse
+ * @param collapsed - Boolean if the element is currently collapsed. Changing
+ * this value will cause the animation to trigger.
+ * @param options - All the additional options available for the collapse
  * transition.
- * @return An ordered list containing a boolean if the collapse should be
+ * @returns An ordered list containing a boolean if the collapse should be
  * rendered in the DOM followed by an object of props to pass to the collapsible
@@ -48,0 +48,0 @@ * element to handle the transition.

lib/useCollapse.js

@@ -47,7 +47,7 @@ "use strict";
  *
- * @param collapsed Boolean if the element is currently collapsed. Changing this
- * value will cause the animation to trigger.
- * @param options All the additional options available for the collapse
+ * @param collapsed - Boolean if the element is currently collapsed. Changing
+ * this value will cause the animation to trigger.
+ * @param options - All the additional options available for the collapse
  * transition.
- * @return An ordered list containing a boolean if the collapse should be
+ * @returns An ordered list containing a boolean if the collapse should be
  * rendered in the DOM followed by an object of props to pass to the collapsible
@@ -54,0 +54,0 @@ * element to handle the transition.

lib/useCrossFade.d.ts

@@ -46,5 +46,5 @@ import { CSSTransitionOptions } from "./types";
  *
- * @param options Any additional options and configuration that should be used
+ * @param options - Any additional options and configuration that should be used
  * for the transition.
- * @return An ordered list of a boolean if the component should be rendered,
+ * @returns An ordered list of a boolean if the component should be rendered,
  * transition props to provide to the transitioning element, a dispatch function
@@ -51,0 +51,0 @@ * for triggering the transition manually (should not be used much), and the

lib/useCrossFade.js

@@ -46,5 +46,5 @@ "use strict";
  *
- * @param options Any additional options and configuration that should be used
+ * @param options - Any additional options and configuration that should be used
  * for the transition.
- * @return An ordered list of a boolean if the component should be rendered,
+ * @returns An ordered list of a boolean if the component should be rendered,
  * transition props to provide to the transitioning element, a dispatch function
@@ -51,0 +51,0 @@ * for triggering the transition manually (should not be used much), and the

lib/useCSSTransition.d.ts

@@ -75,4 +75,4 @@ import { Dispatch } from "react";
  * a custom CSS Transition.
- * @param options The transition options
- * @return An ordered list of a boolean if the component should be rendered,
+ * @param options - The transition options
+ * @returns An ordered list of a boolean if the component should be rendered,
  * transition props to provide to the transitioning element, a dispatch function
@@ -79,0 +79,0 @@ * for triggering the transition manually (should not be used much), and the

lib/useCSSTransition.js

@@ -76,4 +76,4 @@ "use strict";
  * a custom CSS Transition.
- * @param options The transition options
- * @return An ordered list of a boolean if the component should be rendered,
+ * @param options - The transition options
+ * @returns An ordered list of a boolean if the component should be rendered,
  * transition props to provide to the transitioning element, a dispatch function
@@ -80,0 +80,0 @@ * for triggering the transition manually (should not be used much), and the

lib/useFixedPositioning.d.ts

@@ -57,13 +57,15 @@ import { CSSProperties } from "react";
 /**
- * This hook is used to automatically handle fixed positioning when an element is used alongside a
- * `Transition` from `react-transition-group`. This will provide merged `onEnter`, `onEntering`,
- * `onEntered`, and `onExited` handlers to pass down as well as the current style object to apply
- * to the element.
+ * This hook is used to automatically handle fixed positioning when an element
+ * is used alongside a `Transition` from `react-transition-group`. This will
+ * provide merged `onEnter`, `onEntering`, `onEntered`, and `onExited` handlers
+ * to pass down as well as the current style object to apply to the element.
  *
- * Until the element has been removed from the DOM and is visible, the position will automatically
- * update when the user scrolls or resizes the screen.
+ * Until the element has been removed from the DOM and is visible, the position
+ * will automatically update when the user scrolls or resizes the screen.
  *
- * > It is recommended to start the exit animation when that happens though.
+ * @remarks
+ *
+ * It is recommended to start the exit animation when that happens though.
  */
 export declare function useFixedPositioning({ onEnter, onEntering, onEntered, onExited, fixedTo, getOptions, onResize, onScroll, anchor: currentAnchor, initialX, initialY, xMargin, vwMargin, yMargin, vhMargin, width, onPositionChange, transformOrigin, preventOverlap, disableSwapping, disableVHBounds, }: FixedPositioningOptions): ReturnValue;
 export {};

lib/useFixedPositioning.js

@@ -34,11 +34,13 @@ "use strict";
 /**
- * This hook is used to automatically handle fixed positioning when an element is used alongside a
- * `Transition` from `react-transition-group`. This will provide merged `onEnter`, `onEntering`,
- * `onEntered`, and `onExited` handlers to pass down as well as the current style object to apply
- * to the element.
+ * This hook is used to automatically handle fixed positioning when an element
+ * is used alongside a `Transition` from `react-transition-group`. This will
+ * provide merged `onEnter`, `onEntering`, `onEntered`, and `onExited` handlers
+ * to pass down as well as the current style object to apply to the element.
  *
- * Until the element has been removed from the DOM and is visible, the position will automatically
- * update when the user scrolls or resizes the screen.
+ * Until the element has been removed from the DOM and is visible, the position
+ * will automatically update when the user scrolls or resizes the screen.
  *
- * > It is recommended to start the exit animation when that happens though.
+ * @remarks
+ *
+ * It is recommended to start the exit animation when that happens though.
  */
@@ -45,0 +47,0 @@ function useFixedPositioning(_a) {

lib/useTransition.d.ts

@@ -60,6 +60,6 @@ import { Dispatch, RefCallback } from "react";
  *
- * @param options All the options used for the transition.
- * @return An object describing the current transition stage and props that
+ * @param options - All the options used for the transition.
+ * @returns An object describing the current transition stage and props that
  * should be passed to a component.
  */
 export declare function useTransition<E extends HTMLElement = HTMLDivElement>({ appear, repaint, temporary, transitionIn, timeout: propTimeout, onEnter, onEntering, onEntered, onExit, onExiting, onExited, ref: propRef, }: TransitionOptions<E>): TransitionReturnValue<E>;

lib/useTransition.js

@@ -23,3 +23,3 @@ "use strict";
  *
- * @private
+ * @internal
  */
@@ -44,3 +44,3 @@ var reducer = function (state, action) {
  *
- * @private
+ * @internal
  */
@@ -54,3 +54,3 @@ var INITIAL_STATE = {
  *
- * @private
+ * @internal
  */
@@ -72,4 +72,4 @@ var getInitialState = function (transitionIn, temporary, appear) { return function () {
  *
- * @param options All the options used for the transition.
- * @return An object describing the current transition stage and props that
+ * @param options - All the options used for the transition.
+ * @returns An object describing the current transition stage and props that
  * should be passed to a component.
@@ -80,4 +80,4 @@ */
     var _e = react_1.useReducer(reducer, INITIAL_STATE, getInitialState(transitionIn, temporary, appear)), _f = _e[0], stage = _f.stage, rendered = _f.rendered, appearing = _f.appearing, dispatch = _e[1];
-    // need to store in mutable ref since these are mostly going to be arrow functions
-    // and shouldn't cause the transitions to change
+    // need to store in mutable ref since these are mostly going to be arrow
+    // functions and shouldn't cause the transitions to change
     var handlers = react_1.useRef({
@@ -84,0 +84,0 @@ onEnter: onEnter,

package.json

 {
   "name": "@react-md/transition",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "description": "A package for working with react-md to use some simple transitions.",
@@ -39,5 +39,5 @@ "main": "./lib/index.js",
   "dependencies": {
-    "@react-md/portal": "^2.5.0",
-    "@react-md/theme": "^2.6.0",
-    "@react-md/utils": "^2.6.0",
+    "@react-md/portal": "^2.7.0",
+    "@react-md/theme": "^2.7.0",
+    "@react-md/utils": "^2.7.0",
     "@types/react-transition-group": "^4.2.4",
@@ -60,3 +60,3 @@ "classnames": "^2.2.6",
   },
-  "gitHead": "fe442494d054126c0ba9ee40260d234668e2ba18"
+  "gitHead": "931e81f628b580837df3a97267a42c9880b13815"
 }

src/getClassNames.ts

@@ -14,3 +14,3 @@ import { CSSTransitionClassNames } from "react-transition-group/CSSTransition";
  *
- * @private
+ * @internal
  */
@@ -17,0 +17,0 @@ export function getClassNames(

src/getElementSizing.ts

@@ -13,3 +13,3 @@ interface CollapseSizing {
  *
- * @private
+ * @internal
  */
@@ -16,0 +16,0 @@ export function getElementSizing(element: HTMLElement | null): CollapseSizing {

src/getNextStage.ts

@@ -13,3 +13,3 @@ import {
  *
- * @private
+ * @internal
  */
@@ -16,0 +16,0 @@ export function getNextStage(stage: TransitionStage): TransitionStage {

src/getTimeout.ts

 import { TransitionTimeout } from "./types";
 
 /**
- * @private
+ * @internal
  */
@@ -17,3 +17,3 @@ export interface DefinedTimeout {
 /**
- * @private
+ * @internal
  */
@@ -20,0 +20,0 @@ export function getTimeout(

src/getTimeoutDuration.ts

@@ -7,3 +7,3 @@ import { ENTERING, EXITING, TransitionStage } from "./constants";
  *
- * @private
+ * @internal
  */
@@ -10,0 +10,0 @@ export function getTimeoutDuration(

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/types.ts

@@ -143,6 +143,6 @@ import { CSSProperties, Ref, RefCallback } from "react";
    * Changing from `false` to `true`, the stagees will change in this order:
-   * `EXITED` -> `ENTER` -> `ENTERING` -> `ENTERED`
+   * `EXITED -> ENTER -> ENTERING -> ENTERED`
    *
    * Changing from `true` to `false`, the stagees will change in this order:
-   * `ENTERED` -> `EXIT` -> `EXITING` -> `EXITED`
+   * `ENTERED -> EXIT -> EXITING -> EXITED`
    */
@@ -149,0 +149,0 @@ transitionIn: boolean;

src/useCollapse.ts

@@ -60,7 +60,7 @@ import { CSSProperties, useMemo, useState } from "react";
  *
- * @param collapsed Boolean if the element is currently collapsed. Changing this
- * value will cause the animation to trigger.
- * @param options All the additional options available for the collapse
+ * @param collapsed - Boolean if the element is currently collapsed. Changing
+ * this value will cause the animation to trigger.
+ * @param options - All the additional options available for the collapse
  * transition.
- * @return An ordered list containing a boolean if the collapse should be
+ * @returns An ordered list containing a boolean if the collapse should be
  * rendered in the DOM followed by an object of props to pass to the collapsible
@@ -67,0 +67,0 @@ * element to handle the transition.

src/useCrossFade.ts

@@ -53,5 +53,5 @@ import { CROSS_FADE_CLASSNAMES, CROSS_FADE_TIMEOUT } from "./constants";
  *
- * @param options Any additional options and configuration that should be used
+ * @param options - Any additional options and configuration that should be used
  * for the transition.
- * @return An ordered list of a boolean if the component should be rendered,
+ * @returns An ordered list of a boolean if the component should be rendered,
  * transition props to provide to the transitioning element, a dispatch function
@@ -58,0 +58,0 @@ * for triggering the transition manually (should not be used much), and the

src/useCSSTransition.ts

@@ -92,4 +92,4 @@ import { Dispatch } from "react";
  * a custom CSS Transition.
- * @param options The transition options
- * @return An ordered list of a boolean if the component should be rendered,
+ * @param options - The transition options
+ * @returns An ordered list of a boolean if the component should be rendered,
  * transition props to provide to the transitioning element, a dispatch function
@@ -96,0 +96,0 @@ * for triggering the transition manually (should not be used much), and the

src/useFixedPositioning.ts

@@ -110,11 +110,13 @@ import { CSSProperties, useCallback, useEffect, useState } from "react";
 /**
- * This hook is used to automatically handle fixed positioning when an element is used alongside a
- * `Transition` from `react-transition-group`. This will provide merged `onEnter`, `onEntering`,
- * `onEntered`, and `onExited` handlers to pass down as well as the current style object to apply
- * to the element.
+ * This hook is used to automatically handle fixed positioning when an element
+ * is used alongside a `Transition` from `react-transition-group`. This will
+ * provide merged `onEnter`, `onEntering`, `onEntered`, and `onExited` handlers
+ * to pass down as well as the current style object to apply to the element.
  *
- * Until the element has been removed from the DOM and is visible, the position will automatically
- * update when the user scrolls or resizes the screen.
+ * Until the element has been removed from the DOM and is visible, the position
+ * will automatically update when the user scrolls or resizes the screen.
  *
- * > It is recommended to start the exit animation when that happens though.
+ * @remarks
+ *
+ * It is recommended to start the exit animation when that happens though.
  */
@@ -121,0 +123,0 @@ export function useFixedPositioning({

src/useTransition.ts

@@ -76,3 +76,3 @@ import { Dispatch, RefCallback, useEffect, useReducer, useRef } from "react";
  *
- * @private
+ * @internal
  */
@@ -101,3 +101,3 @@ const reducer = (
  *
- * @private
+ * @internal
  */
@@ -112,3 +112,3 @@ const INITIAL_STATE: TransitionState = {
  *
- * @private
+ * @internal
  */
@@ -135,4 +135,4 @@ const getInitialState = (
  *
- * @param options All the options used for the transition.
- * @return An object describing the current transition stage and props that
+ * @param options - All the options used for the transition.
+ * @returns An object describing the current transition stage and props that
  * should be passed to a component.
@@ -160,4 +160,4 @@ */
 
-  // need to store in mutable ref since these are mostly going to be arrow functions
-  // and shouldn't cause the transitions to change
+  // need to store in mutable ref since these are mostly going to be arrow
+  // functions and shouldn't cause the transitions to change
   const handlers = useRef({
@@ -164,0 +164,0 @@ onEnter,

types/CrossFade.d.ts

@@ -47,2 +47,2 @@ import React, { HTMLAttributes } from "react";
  */
-export declare const CrossFade: React.ForwardRefExoticComponent<Pick<CrossFadeProps, "hidden" | "color" | "style" | "wrap" | "translate" | "prefix" | "slot" | "title" | "children" | "enter" | "timeout" | "onEnter" | "onEntering" | "onEntered" | "onExit" | "onExiting" | "onExited" | "classNames" | "transitionIn" | "appear" | "exit" | "temporary" | "onScroll" | "aria-label" | "aria-labelledby" | "className" | "onChange" | "onKeyDown" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "id" | "lang" | "placeholder" | "spellCheck" | "tabIndex" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture"> & React.RefAttributes<HTMLDivElement>>;
+export declare const CrossFade: React.ForwardRefExoticComponent<Pick<CrossFadeProps, "hidden" | "color" | "style" | "wrap" | "translate" | "prefix" | "slot" | "title" | "children" | "enter" | "timeout" | "onEnter" | "onEntering" | "onEntered" | "onExit" | "onExiting" | "onExited" | "classNames" | "transitionIn" | "appear" | "exit" | "temporary" | "onScroll" | "aria-label" | "aria-labelledby" | "className" | "onChange" | "onKeyDown" | "id" | "aria-checked" | "tabIndex" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "lang" | "placeholder" | "spellCheck" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture"> & React.RefAttributes<HTMLDivElement>>;

types/getClassNames.d.ts

@@ -10,5 +10,5 @@ import { CSSTransitionClassNames } from "react-transition-group/CSSTransition";
  *
- * @private
+ * @internal
  */
 export declare function getClassNames(classNames: CSSTransitionClassNames | string, timeout: DefinedTimeout): DefinedCSSTransitionClassNames;
 export {};

types/getElementSizing.d.ts

@@ -12,5 +12,5 @@ interface CollapseSizing {
  *
- * @private
+ * @internal
  */
 export declare function getElementSizing(element: HTMLElement | null): CollapseSizing;
 export {};

types/getNextStage.d.ts

 import { TransitionStage } from "./constants";
 /**
  *
- * @private
+ * @internal
  */
 export declare function getNextStage(stage: TransitionStage): TransitionStage;

types/getTimeout.d.ts

 import { TransitionTimeout } from "./types";
 /**
- * @private
+ * @internal
  */
@@ -11,4 +11,4 @@ export interface DefinedTimeout {
 /**
- * @private
+ * @internal
  */
 export declare function getTimeout(timeout: TransitionTimeout, appear: boolean): DefinedTimeout;

types/getTimeoutDuration.d.ts

@@ -6,4 +6,4 @@ import { TransitionStage } from "./constants";
  *
- * @private
+ * @internal
  */
 export declare function getTimeoutDuration(stage: TransitionStage, appear: number, enter: number, exit: number, appearing: boolean): number;

types/types.d.ts

@@ -95,6 +95,6 @@ import { CSSProperties, Ref, RefCallback } from "react";
      * Changing from `false` to `true`, the stagees will change in this order:
-     * `EXITED` -> `ENTER` -> `ENTERING` -> `ENTERED`
+     * `EXITED -> ENTER -> ENTERING -> ENTERED`
      *
      * Changing from `true` to `false`, the stagees will change in this order:
-     * `ENTERED` -> `EXIT` -> `EXITING` -> `EXITED`
+     * `ENTERED -> EXIT -> EXITING -> EXITED`
      */
@@ -101,0 +101,0 @@ transitionIn: boolean;

types/useCollapse.d.ts

@@ -41,7 +41,7 @@ import { CollapseOptions, CollapseTransitionProvidedProps } from "./types";
  *
- * @param collapsed Boolean if the element is currently collapsed. Changing this
- * value will cause the animation to trigger.
- * @param options All the additional options available for the collapse
+ * @param collapsed - Boolean if the element is currently collapsed. Changing
+ * this value will cause the animation to trigger.
+ * @param options - All the additional options available for the collapse
  * transition.
- * @return An ordered list containing a boolean if the collapse should be
+ * @returns An ordered list containing a boolean if the collapse should be
  * rendered in the DOM followed by an object of props to pass to the collapsible
@@ -48,0 +48,0 @@ * element to handle the transition.

types/useCrossFade.d.ts

@@ -46,5 +46,5 @@ import { CSSTransitionOptions } from "./types";
  *
- * @param options Any additional options and configuration that should be used
+ * @param options - Any additional options and configuration that should be used
  * for the transition.
- * @return An ordered list of a boolean if the component should be rendered,
+ * @returns An ordered list of a boolean if the component should be rendered,
  * transition props to provide to the transitioning element, a dispatch function
@@ -51,0 +51,0 @@ * for triggering the transition manually (should not be used much), and the

types/useCSSTransition.d.ts

@@ -75,4 +75,4 @@ import { Dispatch } from "react";
  * a custom CSS Transition.
- * @param options The transition options
- * @return An ordered list of a boolean if the component should be rendered,
+ * @param options - The transition options
+ * @returns An ordered list of a boolean if the component should be rendered,
  * transition props to provide to the transitioning element, a dispatch function
@@ -79,0 +79,0 @@ * for triggering the transition manually (should not be used much), and the

types/useFixedPositioning.d.ts

@@ -57,13 +57,15 @@ import { CSSProperties } from "react";
 /**
- * This hook is used to automatically handle fixed positioning when an element is used alongside a
- * `Transition` from `react-transition-group`. This will provide merged `onEnter`, `onEntering`,
- * `onEntered`, and `onExited` handlers to pass down as well as the current style object to apply
- * to the element.
+ * This hook is used to automatically handle fixed positioning when an element
+ * is used alongside a `Transition` from `react-transition-group`. This will
+ * provide merged `onEnter`, `onEntering`, `onEntered`, and `onExited` handlers
+ * to pass down as well as the current style object to apply to the element.
  *
- * Until the element has been removed from the DOM and is visible, the position will automatically
- * update when the user scrolls or resizes the screen.
+ * Until the element has been removed from the DOM and is visible, the position
+ * will automatically update when the user scrolls or resizes the screen.
  *
- * > It is recommended to start the exit animation when that happens though.
+ * @remarks
+ *
+ * It is recommended to start the exit animation when that happens though.
  */
 export declare function useFixedPositioning({ onEnter, onEntering, onEntered, onExited, fixedTo, getOptions, onResize, onScroll, anchor: currentAnchor, initialX, initialY, xMargin, vwMargin, yMargin, vhMargin, width, onPositionChange, transformOrigin, preventOverlap, disableSwapping, disableVHBounds, }: FixedPositioningOptions): ReturnValue;
 export {};

types/useTransition.d.ts

@@ -60,6 +60,6 @@ import { Dispatch, RefCallback } from "react";
  *
- * @param options All the options used for the transition.
- * @return An object describing the current transition stage and props that
+ * @param options - All the options used for the transition.
+ * @returns An object describing the current transition stage and props that
  * should be passed to a component.
  */
 export declare function useTransition<E extends HTMLElement = HTMLDivElement>({ appear, repaint, temporary, transitionIn, timeout: propTimeout, onEnter, onEntering, onEntered, onExit, onExiting, onExited, ref: propRef, }: TransitionOptions<E>): TransitionReturnValue<E>;

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

379479

increased by0.26%

Lines of code

7174

increased by0.21%

Dependency changes

• Updated@react-md/portal@^2.7.0

• Updated@react-md/theme@^2.7.0

• Updated@react-md/utils@^2.7.0