@girs/gtksource-4 4.2.0 → 4.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -8
- package/gtksource-4-surface.d.ts +20 -0
- package/gtksource-4-surface.js +6 -0
- package/gtksource-4.d.ts +288 -1
- package/package.json +15 -15
package/README.md
CHANGED
|
@@ -5,25 +5,25 @@
|
|
|
5
5
|

|
|
6
6
|
|
|
7
7
|
|
|
8
|
-
GJS TypeScript type definitions for GtkSource-4 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.
|
|
8
|
+
GJS TypeScript type definitions for GtkSource-4 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.4.0.
|
|
9
9
|
|
|
10
10
|
## Install
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
Install the type definitions with npm:
|
|
13
13
|
```bash
|
|
14
14
|
npm install @girs/gtksource-4
|
|
15
15
|
```
|
|
16
16
|
|
|
17
17
|
## Usage
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
Import it like any other module:
|
|
20
20
|
```ts
|
|
21
21
|
import GtkSource from '@girs/gtksource-4';
|
|
22
22
|
```
|
|
23
23
|
|
|
24
24
|
### Ambient Modules
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
[Ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules) let you write the same import you would in plain JavaScript.
|
|
27
27
|
For this you need to include `@girs/gtksource-4` or `@girs/gtksource-4/ambient` in your `tsconfig` or entry point Typescript file:
|
|
28
28
|
|
|
29
29
|
`index.ts`:
|
|
@@ -42,7 +42,7 @@ import '@girs/gtksource-4'
|
|
|
42
42
|
}
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
|
|
45
|
+
The ambient module now resolves with types:
|
|
46
46
|
|
|
47
47
|
```ts
|
|
48
48
|
import GtkSource from 'gi://GtkSource?version=4';
|
|
@@ -50,7 +50,7 @@ import GtkSource from 'gi://GtkSource?version=4';
|
|
|
50
50
|
|
|
51
51
|
### Global import
|
|
52
52
|
|
|
53
|
-
|
|
53
|
+
GJS's global `imports.gi` works too, with types.
|
|
54
54
|
For this you need to include `@girs/gtksource-4` or `@girs/gtksource-4/import` in your `tsconfig` or entry point Typescript file:
|
|
55
55
|
|
|
56
56
|
`index.ts`:
|
|
@@ -69,7 +69,7 @@ import '@girs/gtksource-4'
|
|
|
69
69
|
}
|
|
70
70
|
```
|
|
71
71
|
|
|
72
|
-
|
|
72
|
+
That form carries types as well:
|
|
73
73
|
|
|
74
74
|
```ts
|
|
75
75
|
const GtkSource = imports.gi.GtkSource;
|
|
@@ -77,7 +77,7 @@ const GtkSource = imports.gi.GtkSource;
|
|
|
77
77
|
|
|
78
78
|
### Bundle
|
|
79
79
|
|
|
80
|
-
|
|
80
|
+
Most projects want a bundler. [esbuild](https://esbuild.github.io/) is the smallest thing that works; the [examples directory](https://github.com/gjsify/ts-for-gir/tree/main/examples) has setups for several others.
|
|
81
81
|
|
|
82
82
|
## Other packages
|
|
83
83
|
|
package/gtksource-4-surface.d.ts
CHANGED
|
@@ -183,6 +183,23 @@ export interface Widgets {
|
|
|
183
183
|
/** Every GType this namespace can create. A consumer derives its own tag map. */
|
|
184
184
|
export type WidgetGType = keyof Widgets;
|
|
185
185
|
|
|
186
|
+
// ---------------------------------------------------------------------------
|
|
187
|
+
// Child holders — the same shape, for objects that CARRY a widget without being one.
|
|
188
|
+
//
|
|
189
|
+
// `GtkListItem`, `GtkListHeader`, `GtkColumnViewCell` and `AdwToggle` descend from
|
|
190
|
+
// `GObject.Object` and hold a widget through `set_child`/`get_child`. A renderer places
|
|
191
|
+
// them exactly like a container, so they belong in the vocabulary; a check asking "is
|
|
192
|
+
// this a widget" must still be able to say no. Hence a sibling table rather than four
|
|
193
|
+
// more rows in `Widgets`: concatenate them when you mean both.
|
|
194
|
+
// ---------------------------------------------------------------------------
|
|
195
|
+
|
|
196
|
+
export interface ChildHolders {
|
|
197
|
+
|
|
198
|
+
}
|
|
199
|
+
|
|
200
|
+
/** Every GType this namespace holds a child in without it being a widget. */
|
|
201
|
+
export type ChildHolderGType = keyof ChildHolders;
|
|
202
|
+
|
|
186
203
|
/** The writable, optional, GObject-keyed property surface of one GType. */
|
|
187
204
|
export type PropsOf<G extends WidgetGType> = Widgets[G]['props'];
|
|
188
205
|
|
|
@@ -218,6 +235,9 @@ export const OWN_SIGNALS: Readonly<Record<string, readonly string[]>>;
|
|
|
218
235
|
/** Widget GType -> every declaration its members come from, self first. */
|
|
219
236
|
export const DECLS: Readonly<Record<string, readonly string[]>>;
|
|
220
237
|
|
|
238
|
+
/** The GTypes in `DECLS` that hold a widget without being one — see `ChildHolders`. */
|
|
239
|
+
export const CHILD_HOLDERS: readonly string[];
|
|
240
|
+
|
|
221
241
|
/** Enum GType -> the nicks this surface offers. */
|
|
222
242
|
export const ENUM_NICKS: Readonly<Record<string, readonly string[]>>;
|
|
223
243
|
|
package/gtksource-4-surface.js
CHANGED
|
@@ -26,6 +26,12 @@ export const DECLS = {
|
|
|
26
26
|
GtkSourceView: ['GtkSourceView', 'GtkTextView', 'GtkContainer', 'GtkWidget', 'GtkBuildable', 'GtkScrollable'],
|
|
27
27
|
};
|
|
28
28
|
|
|
29
|
+
// The GTypes above that are NOT widgets: they hold one through `set_child`/`get_child`
|
|
30
|
+
// and descend from `GObject.Object`. A renderer places them like a container; a check
|
|
31
|
+
// asking "is this a widget" must not count them. Derived from the accessor pair, never
|
|
32
|
+
// from a list — the count is in the provenance line above.
|
|
33
|
+
export const CHILD_HOLDERS = [];
|
|
34
|
+
|
|
29
35
|
export const ENUM_NICKS = {
|
|
30
36
|
GtkSourceBackgroundPatternType: ['none', 'grid'],
|
|
31
37
|
GtkSourceBracketMatchType: ['none', 'out-of-range', 'not-found', 'found'],
|