Typescript Support?

[JasonLandbridge]

Hi,

Are there plans to create some Typescript declaration files? It currently throws errors when used in a Vue Typescript project.

TS7016: Could not find a declaration file for module 'vanta/dist/vanta.waves.min'. '/src/WebUI/node_modules/vanta/dist/vanta.waves.min.js' implicitly has an 'any' type.
  Try `npm install @types/vanta` if it exists or add a new declaration (.d.ts) file containing `declare module 'vanta/dist/vanta.waves.min';`
    144 | import PathsOverview from '@overviews/PathsOverview.vue';
    145 | import * as THREE from 'three';
  > 146 | import WAVES from 'vanta/dist/vanta.waves.min';
        |                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^

[rohitkrishna094]

How were you able to fix this?

[JasonLandbridge]

import * as THREE from 'three';
import WAVES from 'vanta/dist/vanta.waves.min';

I just did this and it works, ignoring the error

[MightyPhoenix]

you can also declare it as a module in a .d.ts file

declare module "vanta/dist/vanta.halo.min"; declare module "vanta/dist/vanta.net.min"; declare module "vanta/dist/vanta.dots.min"; declare module "vanta/src/vanta.halo.js";

[rajpurohityogesh]

Hey where should I put this .d.ts file?

I am trying to use this is ts react app and created index.d.ts file in my component file directory. But It didn't seem to work. Please respond asap.

Thank you.

[TangoPJ]

@rajpurohityogesh Hello, did you find the solution? I need help too :)

[codrkoaz]

I'm getting the same error in Nextjs with typescript.

[rajpurohityogesh]

Yes @TangoPJ. I put the file in src folder of react application. It seems to work that way.

[knekvasil]

I had this issue as well. This article was extremely helpful in understanding/solving it.

[OThyagoCarvalho]

this solved my problem, not sure if this is the most appropriate way to handle it; content of the vanta.types.d.ts file in the root folder:

declare module 'vanta/dist/vanta.birds.min' {
    const birds: any;
    export default birds;
}

[rajpurohityogesh]

@rajpurohityogesh Hello, did you find the solution? I need help too :)

Sorry I didn't saw your question. Yes, I did found the solution.

Create a file with '.d.ts' extension in src folder and put (declare module 'vanta/dist/vanta.globe.min.js';) this kind of code inside that for whatever module you need to use.

[ghost]

[Next JS]

Install Vanta and Three dependencies:

npm i vanta
npm i three
npm install --save @types/three

or

Include below script in: "_app.tsx"

import Script from "next/script";
import { useRouter } from "next/router";
<Layout>
{router.pathname === "/" && (
        // load third party scripts only on home page
        <>
          <Script src="https://cdnjs.cloudflare.com/ajax/libs/three.js/r134/three.min.js" />
          <Script src="https://cdn.jsdelivr.net/npm/vanta/dist/vanta.halo.min.js" />
        </>
      )}
      <Component {...pageProps} />
</Layout>

THEN: Instead including rest of the code under (pages) example: /pages/index.tsx, do this on component level - example: /components/HeroBanner.tsx

Component level example:

import HALO from "vanta/dist/vanta.halo.min"
import * as THREE from "three";

export default function HeroBanner() {

// Here comes Vanta React Hook code

const [vantaEffect, setVantaEffect] = useState(0);
  const vantaRef = useRef(null);
  useEffect(() => {
    if (!vantaEffect) {
      setVantaEffect(
        HALO({
          el: vantaRef.current,
          THREE,
          color: 0x14b679,
          backgroundColor: 0x15173c,
          maxDistance: 34.0,
        })
      );
    }
    return () => {
      if (vantaEffect) vantaEffect.destory();
    };
  }, [vantaEffect]);
  
  return (
<div className="container" ref={vantaRef}">
  // Rest of your code
</div>
  )
}

Remember to add ref={vantaRef} attribute to your container element.

Hope this will help someone.

[majkl-zumberi]

for whoever is trying to integrate the Halo effect, here's the ts support create a file vantahalo.d.ts and paste the following content

export interface HaloParams {
  el: string
  mouseControls: boolean
  touchControls: boolean
  gyroControls: boolean
  minHeight: number
  minWidth: number
  xOffset?: number
  yOffset?: number
  size?: number
  backgroundColor?: string
}

export interface HaloInstance {
  setOptions: ({
    el,
    mouseControls,
    touchControls,
    gyroControls,
    minHeight,
    minWidth,
    size,
    xOffset,
    yOffset,
    backgroundColor
  }: Omit<HaloParams, 'el'>) => void
  resize: () => void
  destroy: () => void
}

declare global {
  interface Window {
    VANTA: {
      HALO: ({
        el,
        mouseControls,
        touchControls,
        gyroControls,
        minHeight,
        minWidth,
        size,
        xOffset,
        yOffset,
        backgroundColor
      }: HaloParams) => HaloInstance
    }
  }
}

remember to include this file into tsconfig.json into include array in order to be recognised

[AJIJIi]

Additionally @MightyPhoenix answer I will say that I put declaration file to the same directory as the file where I want to import. I named it 'index.d.ts', but for a long time I had an error because I also had a file named 'index.ts' there