Published on

Integrating TypeScript with Inertia.js and Vue.js

Integrating TypeScript with Inertia.js and Vue.js

Why use Typescript?

If you are like me and have been web projecting in Laravel using Inertia and Vue you might think adding Typescript is a bit of overkill and too much of a learning curve. Why add another layer of complexity?

But adding Typescript to your project can be a great way to add some structure to your code and make it easier to maintain. It can also help you catch bugs before they happen.

Luckily, Typescript plays nicely with Vue 3 and adding it to your Inertia/Vue project is pretty easy. In this post, I will show you how to add Typescript to your Inertia/Vue project and how to use it.

Setup

Before getting started, you will need to have the following installed:

  • Node.js
  • Yarn/NPM/PNPM (I prefer Yarn which is what I will be using in this post)
  • A new Laravel project with Inertia and Vue installed (You can use Jetstream if you want to make it super easy)

Small note: If you are using VSCode, I highly recommend installing the Volar extension. It will make working with Typescript in Vue much easier. Here are the links to that extension: Vue.volar > Vue.vscode-typescript-vue-plugin

Lets start by creating a new Laravel project.

laravel new ts-inertia-vue && cd ts-inertia-vue

Next, we can install Jetstream. Alternatively, you could use Breeze or you can install Inertia and Vue manually if you want to.

composer require laravel/jetstream

Install the needed dependencies.

php artisan jetstream:install inertia

Now lets setup a basic tsconfig.json file.

touch tsconfig.json

And can add the following to it.

{
  "compilerOptions": {
    "target": "esnext",
    "module": "esnext",
    "moduleResolution": "node",
    "strict": true,
    "jsx": "preserve",
    "sourceMap": true,
    "resolveJsonModule": true,
    "esModuleInterop": true,
    "allowJs": true,
    "lib": ["esnext", "dom"],
    "types": ["@types/node", "@types/ziggy-js"],
    "paths": {
      "@/*": ["./resources/js/*"]
    },
    "outDir": "./public/build/assets"
  },
  "typeRoots": ["./node_modules/@types", "resources/js/types"],
  "include": [
    "resources/js/**/*.ts",
    "resources/js/**/*.d.ts",
    "resources/js/**/*.vue"
  ],
  "exclude": ["node_modules", "public"]
}

Now lets install the needed dependencies for npm/yarn.

yarn install

Add some extra dependencies for Typescript

yarn add -D @types/lodash @types/node @types/ziggy-js typescript ziggy-js

Now we are pretty close to being ready to start using Typescript. I like to create a resources/js/types directory and add a few files to it. The files could be named anything you want, but I like to name them vue-shim.d.ts, inertia.d.ts, and env.d.ts.

inertia.d.ts - is where we will add the types for our Inertia props. This will allow us to use the inertia namespace in our components and have access to the props that are passed to the component.

env.d.ts - is where you can list out any environment variables you want to use in your project. Making them easier to find and use in your code base.

mkdir resources/js/types && touch resources/js/types/vue-shim.d.ts

Can add the following to vue-shim.d.ts.

declare module "*.vue" {
  import { defineComponent } from "vue";
  const component: ReturnType<typeof defineComponent>;
  export default component;
}

And the following to inertia.d.ts.

touch resources/js/types/inertia.d.ts
import { PageProps } from "@inertiajs/inertia";

export {};
declare global {
  export namespace inertia {
    export interface Props extends PageProps {
      user: {
        id: number;
        name: string;
        email: string;
        created_at: Date;
        updated_at: Date;
      };
      jetstream: {
        [key: string]: boolean;
      };
      errorBags: unknown;
      errors: unknown;
    }
  }
}

Here you can create a env.d.ts file and add any environment variables you want to use in your project.

touch resources/js/Types/env.d.ts
/// <reference types="vite/client" />

interface ImportMetaEnv {
  // ... could include environment variables

  /** Stripe API Key */
  readonly VITE_STRIPE_API_KEY: string;
}

interface ImportMeta {
  readonly env: ImportMetaEnv;
}

Alright lets update the resources/js/Pages/Welcome.vue

<script lang="ts" setup>
import { PropType } from "vue";
import route from "ziggy-js";
import { Head, Link } from "@inertiajs/inertia-vue3";

defineProps({
  canLogin: Boolean as PropType<boolean>,
  canRegister: Boolean as PropType<boolean>,
  laravelVersion: String as PropType<string>,
  phpVersion: String as PropType<string>
});
</script>

<template>
  <Head title="Welcome" />

  <div
    class="relative flex items-top justify-center min-h-screen bg-gray-100 dark:bg-gray-900 sm:items-center sm:pt-0"
  >
    <div v-if="canLogin" class="hidden fixed top-0 right-0 px-6 py-4 sm:block">
      <Link
        v-if="($page.props as inertia.Props).user"
        :href="route('dashboard')"
        class="text-sm text-gray-700 dark:text-gray-500 underline"
      >
        Dashboard
      </Link>

      <template v-else>
        <Link
          :href="route('login')"
          class="text-sm text-gray-700 dark:text-gray-500 underline"
        >
          Log in
        </Link>

        <Link
          v-if="canRegister"
          :href="route('register')"
          class="ml-4 text-sm text-gray-700 dark:text-gray-500 underline"
        >
          Register
        </Link>
      </template>
    </div>
    <div class="max-w-6xl mx-auto sm:px-6 lg:px-8">
      <div class="flex justify-center mt-4 sm:items-center sm:justify-between">
        <div
          class="ml-4 text-center text-sm text-gray-500 sm:text-right sm:ml-0"
        >
          Laravel v{{ laravelVersion }} (PHP v{{ phpVersion }})
        </div>
      </div>
    </div>
  </div>
</template>

And that is it. You should now be able to use Typescript in your Jetstream project!

A few things you will now notice when using the <Link> component I can strongly type my expected inertia props. Which makes it easier to define things like what is a User, which you can define a type or interface for. To learn more about that checkout my Generating TypeScript Interfaces & Types from Laravel Models to learn how you can easily generate types for your models.