@girs/atk-1.0

Atk-1.0

GJS TypeScript type definitions for Atk-1.0, generated from library version 2.45.1 using ts-for-gir v4.0.0-beta.1.

Install

To use this type definitions, install them with NPM:

npm install @girs/atk-1.0

Usage

You can import this package into your project like this:

import Atk from '@girs/atk-1.0';

Or if you prefer CommonJS, you can also use this:

const Atk = require('@girs/atk-1.0');

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/atk-1.0 or @girs/atk-1.0/ambient in your tsconfig or entry point Typescript file:

index.ts:

import '@girs/atk-1.0'

tsconfig.json:

{
  "compilerOptions": {
    ...
  },
  "include": ["@girs/atk-1.0"],
  ...
}

Now you can import the ambient module with TypeScript support:

import Atk from 'gi://Atk?version=1.0';

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/atk-1.0 or @girs/atk-1.0/import in your tsconfig or entry point Typescript file:

index.ts:

import '@girs/atk-1.0'

tsconfig.json:

{
  "compilerOptions": {
    ...
  },
  "include": ["@girs/atk-1.0"],
  ...
}

Now you have also type support for this, too:

const Atk = imports.gi.Atk;

ESM vs. CommonJS

GJS supports two different import syntaxes. The new modern ESM syntax and the old global imports syntax.

In TypeScript projects for GJS and GNOME Shell extensions, you have the flexibility to use ESM syntax and then decide the import syntax for your bundled file. If your bundler is configured to use CommonJS, it will convert to the GJS-specific global imports syntax, like const moduleName = imports.gi[moduleName]. This is different from the traditional require syntax seen in Node.js. The global imports syntax is chosen because it aligns with the CommonJS format supported by NPM, which is used for the generated type definitions and this package.

On the other hand, if you configure your bundler to use ESM, it will retain the ESM import syntax. It's crucial to ensure that your bundler is set up to correctly translate and bundle these imports into either CommonJS or ESM format, depending on your project's requirements.

This approach is particularly important due to the @girs types, which include both *.cjs files, using the GJS global imports syntax, and *.js files, which utilize the ESM syntax. By appropriately setting up your bundler, you can control which syntax—CommonJS or ESM—is used in your project. The choice of CommonJS in this context is also due to the similarity between the GJS-specific global imports and CommonJS syntax, allowing for easier management and bundling in these specific types of projects.

Since GNOME Shell 45, you should only use ESM, even for GNOME Shell extensions. Before that, extensions had to use the global import syntax, unlike normal GJS applications, where ESM has been available for some time.

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.