Clutter-3

GJS TypeScript type definitions for Clutter-3, generated from library version 1.26.1 using ts-for-gir v4.0.0-rc.1.

Install

To use this type definitions, install them with NPM:

npm install @girs/clutter-3

Usage

You can import this package into your project like this:

import Clutter from '@girs/clutter-3';

Ambient Modules

You can also use ambient modules to import this module like you would do this in JavaScript. For this you need to include @girs/clutter-3 or @girs/clutter-3/ambient in your tsconfig or entry point Typescript file:

index.ts:

import '@girs/clutter-3'

tsconfig.json:

{
  "compilerOptions": {
    ...
  },
  "include": ["@girs/clutter-3"],
  ...
}

Now you can import the ambient module with TypeScript support:

import Clutter from 'gi://Clutter?version=3';

Global import

You can also import the module with Typescript support using the global imports.gi object of GJS. For this you need to include @girs/clutter-3 or @girs/clutter-3/import in your tsconfig or entry point Typescript file:

index.ts:

import '@girs/clutter-3'

tsconfig.json:

{
  "compilerOptions": {
    ...
  },
  "include": ["@girs/clutter-3"],
  ...
}

Now you have also type support for this, too:

const Clutter = imports.gi.Clutter;

Bundle

Depending on your project configuration, it is recommended to use a bundler like esbuild. You can find examples using different bundlers here.

Other packages

All existing pre-generated packages can be found on gjsify/types.