update ags

This commit is contained in:
2023-11-15 16:09:26 +01:00
parent a6292fe031
commit 73e2b949a0
4025 changed files with 3168562 additions and 5715 deletions

View File

@@ -0,0 +1,92 @@
# Gtk-3.0
![version](https://img.shields.io/npm/v/@girs/gtk-3.0)
![downloads/week](https://img.shields.io/npm/dw/@girs/gtk-3.0)
GJS TypeScript type definitions for Gtk-3.0, generated from library version 3.24.39 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.2.
GTK+ is the primary library used to construct user interfaces in GNOME applications. It provides user interface controls and signal callbacks to control user interfaces.
## Install
To use this type definitions, install them with NPM:
```bash
npm install @girs/gtk-3.0
```
## Usage
You can import this package into your project like this:
```ts
import Gtk from '@girs/gtk-3.0';
```
Or if you prefer CommonJS, you can also use this:
```ts
const Gtk = require('@girs/gtk-3.0');
```
### Ambient Modules
You can also use [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules) to import this module like you would do this in JavaScript.
For this you need to include `@girs/gtk-3.0` or `@girs/gtk-3.0/ambient` in your `tsconfig` or entry point Typescript file:
`index.ts`:
```ts
import '@girs/gtk-3.0'
```
`tsconfig.json`:
```json
{
"compilerOptions": {
...
},
"include": ["@girs/gtk-3.0"],
...
}
```
Now you can import the ambient module with TypeScript support:
```ts
import Gtk from 'gi://Gtk?version=3.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/gtk-3.0` or `@girs/gtk-3.0/import` in your `tsconfig` or entry point Typescript file:
`index.ts`:
```ts
import '@girs/gtk-3.0'
```
`tsconfig.json`:
```json
{
"compilerOptions": {
...
},
"include": ["@girs/gtk-3.0"],
...
}
```
Now you have also type support for this, too:
```ts
const Gtk = imports.gi.Gtk;
```
### Bundle
Depending on your project configuration, it is recommended to use a bundler like [esbuild](https://esbuild.github.io/). You can find examples using different bundlers [here](https://github.com/gjsify/ts-for-gir/tree/main/examples).
## Other packages
All existing pre-generated packages can be found on [gjsify/types](https://github.com/gjsify/types).