fix: update types

Author: mkosir

src/features/glare/types.public.ts

@@ -1,26 +1,26 @@
 export type GlareProps = {
   /**
-   * Boolean to enable/disable glare effect.
+   * Enables/disables the glare effect.
    */
   glareEnable?: boolean;
   /**
-   * The maximum glare opacity (0.5 = 50%, 1 = 100%, etc.). Range: 0 - 1
+   * Maximum glare opacity (`0.5 = 50%, 1 = 100%`). Range: `0-1`
    */
   glareMaxOpacity?: number;
   /**
-   * Set color of glare effect.
+   * Sets the color of the glare effect.
    */
   glareColor?: string;
   /**
-   * Set position of glare effect.
+   * Sets the position of the glare effect.
    */
   glarePosition?: GlarePosition;
   /**
-   * Reverse the glare direction.
+   * Reverses the glare direction.
    */
   glareReverse?: boolean;
   /**
-   * Set the border radius of the glare.
+   * Sets the border radius of the glare. Accepts any standard CSS border radius value.
    */
   glareBorderRadius?: string;
 };

src/features/tilt/types.public.ts

@@ -1,38 +1,38 @@
 export type TiltProps = {
   /**
-   * Boolean to enable/disable tilt effect.
+   * Enables/disables the tilt effect.
    */
   tiltEnable?: boolean;
   /**
-   * Reverse the tilt direction.
+   * Reverses the tilt direction.
    */
   tiltReverse?: boolean;
   /**
-   * Initial tilt value (degrees) on x axis.
+   * Initial tilt angle (in degrees) on the x-axis.
    */
   tiltAngleXInitial?: number;
   /**
-   * Initial tilt value (degrees) on y axis.
+   * Initial tilt angle (in degrees) on the y-axis.
    */
   tiltAngleYInitial?: number;
   /**
-   * Max tilt rotation (degrees) on x axis. Range: 0 - 90
+   * Maximum tilt rotation (in degrees) on the x-axis (range: `0°-90°`).
    */
   tiltMaxAngleX?: number;
   /**
-   * Max tilt rotation (degrees) on y axis. Range: 0 - 90
+   * Maximum tilt rotation (in degrees) on the y-axis (range: `0°-90°`).
    */
   tiltMaxAngleY?: number;
   /**
-   * Which axis should be enabled.
+   * Enables tilt on a single axis only.
    */
   tiltAxis?: Axis;
   /**
-   * Manual tilt rotation (degrees) on x axis.
+   * Manual tilt rotation (in degrees) on the x-axis.
    */
   tiltAngleXManual?: number | null;
   /**
-   * Manual tilt rotation (degrees) on y axis.
+   * Manual tilt rotation (in degrees) on the y-axis.
    */
   tiltAngleYManual?: number | null;
 };

src/react-parallax-tilt/types.public.ts

@@ -37,51 +37,51 @@ export type ReactParallaxTiltProps = TiltProps &
      */
     children?: React.ReactNode;
     /**
-     * Scale of the component (1.5 = 150%, 2 = 200%, etc.).
+     * Scale of the component (`1.5 = 150%, 2 = 200%`).
      */
     scale?: number;
     /**
-     * The perspective property defines how far the object (wrapped/child component) is away from the user. The lower the more extreme the tilt gets.
+     * Defines how far the tilt component appears from the user. Lower values create more extreme tilt effects.
      */
     perspective?: number;
     /**
-     * Boolean to enable/disable vertical flip of component.
+     * Enables/disables vertical flipping of the component.
      */
     flipVertically?: boolean;
     /**
-     * Boolean to enable/disable horizontal flip of component.
+     * Enables/disables horizontal flipping of the component.
      */
     flipHorizontally?: boolean;
     /**
-     * If the effects has to be reset on "onLeave" event.
+     * Determines if effects should reset on `onLeave` event.
      */
     reset?: boolean;
     /**
-     * Easing of the transition when manipulating the component.
+     * Easing function for the transition.
      */
     transitionEasing?: string;
     /**
-     * Speed of the transition when manipulating the component.
+     * Speed of the transition.
      */
     transitionSpeed?: number;
     /**
-     * Track mouse and touch events on the whole window.
+     * Tracks mouse and touch events across the entire window.
      */
     trackOnWindow?: boolean;
     /**
-     * Boolean to enable/disable device orientation detection.
+     * Enables/disables device orientation detection.
      */
     gyroscope?: boolean;
     /**
-     * Gets triggered when user moves on the component.
+     * Callback triggered when user moves on the component.
      */
     onMove?: OnMove;
     /**
-     * Gets triggered when user enters the component.
+     * Callback triggered when user enters the component.
      */
     onEnter?: OnEnter;
     /**
-     * Gets triggered when user leaves the component.
+     * Callback triggered when user leaves the component.
      */
     onLeave?: OnLeave;
   };