Skip to content

MIGRATION.md

Latest commit

 

History

History
30 lines (19 loc) · 982 Bytes

MIGRATION.md

File metadata and controls

30 lines (19 loc) · 982 Bytes

TypeScript Types Migration

Important: Remove Community @types Package

Starting from version 1.0.0, react-scroll-sync provides its own TypeScript type definitions built-in.
You must uninstall the community @types/react-scroll-sync package to avoid type conflicts and ensure you are using the latest, official types.

Migration Steps

  1. Uninstall the community types:

    npm uninstall @types/react-scroll-sync
# or, if you use yarn:
yarn remove @types/react-scroll-sync

  2. Update your imports (if needed):

    You can now use react-scroll-sync directly in your TypeScript code without any additional type packages.

    import { ScrollSync, ScrollSyncPane } from "react-scroll-sync";

  3. Check your code:

    The official types are included automatically. If you encounter any type errors, ensure the old @types/react-scroll-sync package is fully removed from your node_modules and package.json.