GtkSource-5

GJS TypeScript type definitions for GtkSource-5, generated from library version 5.9.0 using ts-for-gir v3.2.3.

GtkSourceView is a GNOME library that extends GtkTextView, the standard GTK+ widget for multiline text editing. GtkSourceView adds support for syntax highlighting, undo/redo, file loading and saving, search and replace, a completion system, printing, displaying line numbers, and other features typical of a source code editor.

Install

To use this type definitions, install them with NPM:

npm install @girs/gtksource-5

Usage

You can import this package into your project like this:

import GtkSource from '@girs/gtksource-5';

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

const GtkSource = require('@girs/gtksource-5');

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

index.ts:

import '@girs/gtksource-5'

tsconfig.json:

{
  "compilerOptions": {
    ...
  },
  "include": ["@girs/gtksource-5"],
  ...
}

Now you can import the ambient module with TypeScript support:

import GtkSource from 'gi://GtkSource?version=5';

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

index.ts:

import '@girs/gtksource-5'

tsconfig.json:

{
  "compilerOptions": {
    ...
  },
  "include": ["@girs/gtksource-5"],
  ...
}

Now you have also type support for this, too:

const GtkSource = imports.gi.GtkSource;

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.