@girs/handy-1 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 CHANGED
@@ -5,25 +5,25 @@
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/handy-1)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for Handy-1 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.2.0.
8
+ GJS TypeScript type definitions for Handy-1 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.4.0.
9
9
 
10
10
  ## Install
11
11
 
12
- To use this type definitions, install them with NPM:
12
+ Install the type definitions with npm:
13
13
  ```bash
14
14
  npm install @girs/handy-1
15
15
  ```
16
16
 
17
17
  ## Usage
18
18
 
19
- You can import this package into your project like this:
19
+ Import it like any other module:
20
20
  ```ts
21
21
  import Handy from '@girs/handy-1';
22
22
  ```
23
23
 
24
24
  ### Ambient Modules
25
25
 
26
- 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.
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/handy-1` or `@girs/handy-1/ambient` in your `tsconfig` or entry point Typescript file:
28
28
 
29
29
  `index.ts`:
@@ -42,7 +42,7 @@ import '@girs/handy-1'
42
42
  }
43
43
  ```
44
44
 
45
- Now you can import the ambient module with TypeScript support:
45
+ The ambient module now resolves with types:
46
46
 
47
47
  ```ts
48
48
  import Handy from 'gi://Handy?version=1';
@@ -50,7 +50,7 @@ import Handy from 'gi://Handy?version=1';
50
50
 
51
51
  ### Global import
52
52
 
53
- You can also import the module with Typescript support using the global `imports.gi` object of GJS.
53
+ GJS's global `imports.gi` works too, with types.
54
54
  For this you need to include `@girs/handy-1` or `@girs/handy-1/import` in your `tsconfig` or entry point Typescript file:
55
55
 
56
56
  `index.ts`:
@@ -69,7 +69,7 @@ import '@girs/handy-1'
69
69
  }
70
70
  ```
71
71
 
72
- Now you have also type support for this, too:
72
+ That form carries types as well:
73
73
 
74
74
  ```ts
75
75
  const Handy = imports.gi.Handy;
@@ -77,7 +77,7 @@ const Handy = imports.gi.Handy;
77
77
 
78
78
  ### Bundle
79
79
 
80
- 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).
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
 
@@ -1129,6 +1129,23 @@ export interface Widgets {
1129
1129
  /** Every GType this namespace can create. A consumer derives its own tag map. */
1130
1130
  export type WidgetGType = keyof Widgets;
1131
1131
 
1132
+ // ---------------------------------------------------------------------------
1133
+ // Child holders — the same shape, for objects that CARRY a widget without being one.
1134
+ //
1135
+ // `GtkListItem`, `GtkListHeader`, `GtkColumnViewCell` and `AdwToggle` descend from
1136
+ // `GObject.Object` and hold a widget through `set_child`/`get_child`. A renderer places
1137
+ // them exactly like a container, so they belong in the vocabulary; a check asking "is
1138
+ // this a widget" must still be able to say no. Hence a sibling table rather than four
1139
+ // more rows in `Widgets`: concatenate them when you mean both.
1140
+ // ---------------------------------------------------------------------------
1141
+
1142
+ export interface ChildHolders {
1143
+
1144
+ }
1145
+
1146
+ /** Every GType this namespace holds a child in without it being a widget. */
1147
+ export type ChildHolderGType = keyof ChildHolders;
1148
+
1132
1149
  /** The writable, optional, GObject-keyed property surface of one GType. */
1133
1150
  export type PropsOf<G extends WidgetGType> = Widgets[G]['props'];
1134
1151
 
@@ -1164,6 +1181,9 @@ export const OWN_SIGNALS: Readonly<Record<string, readonly string[]>>;
1164
1181
  /** Widget GType -> every declaration its members come from, self first. */
1165
1182
  export const DECLS: Readonly<Record<string, readonly string[]>>;
1166
1183
 
1184
+ /** The GTypes in `DECLS` that hold a widget without being one — see `ChildHolders`. */
1185
+ export const CHILD_HOLDERS: readonly string[];
1186
+
1167
1187
  /** Enum GType -> the nicks this surface offers. */
1168
1188
  export const ENUM_NICKS: Readonly<Record<string, readonly string[]>>;
1169
1189
 
@@ -76,6 +76,12 @@ export const DECLS = {
76
76
  HdyWindowHandle: ['HdyWindowHandle', 'GtkEventBox', 'GtkBin', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
77
77
  };
78
78
 
79
+ // The GTypes above that are NOT widgets: they hold one through `set_child`/`get_child`
80
+ // and descend from `GObject.Object`. A renderer places them like a container; a check
81
+ // asking "is this a widget" must not count them. Derived from the accessor pair, never
82
+ // from a list — the count is in the provenance line above.
83
+ export const CHILD_HOLDERS = [];
84
+
79
85
  export const ENUM_NICKS = {
80
86
  HdyCenteringPolicy: ['loose', 'strict'],
81
87
  HdyColorScheme: ['default', 'force-light', 'prefer-light', 'prefer-dark', 'force-dark'],