@girs/panel-1 4.2.0 → 4.3.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.
Files changed (3) hide show
  1. package/README.md +8 -8
  2. package/package.json +17 -17
  3. package/panel-1.d.ts +24 -26
package/README.md CHANGED
@@ -5,25 +5,25 @@
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/panel-1)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for Panel-1, generated from library version 1.10.4 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.2.0.
8
+ GJS TypeScript type definitions for Panel-1, generated from library version 1.10.4 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.3.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/panel-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 Panel from '@girs/panel-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/panel-1` or `@girs/panel-1/ambient` in your `tsconfig` or entry point Typescript file:
28
28
 
29
29
  `index.ts`:
@@ -42,7 +42,7 @@ import '@girs/panel-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 Panel from 'gi://Panel?version=1';
@@ -50,7 +50,7 @@ import Panel from 'gi://Panel?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/panel-1` or `@girs/panel-1/import` in your `tsconfig` or entry point Typescript file:
55
55
 
56
56
  `index.ts`:
@@ -69,7 +69,7 @@ import '@girs/panel-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 Panel = imports.gi.Panel;
@@ -77,7 +77,7 @@ const Panel = imports.gi.Panel;
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
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/panel-1",
3
- "version": "4.2.0",
3
+ "version": "4.3.0",
4
4
  "libraryVersion": "1.10.4",
5
5
  "description": "GJS TypeScript type definitions for Panel-1, generated from library version 1.10.4",
6
6
  "type": "module",
@@ -37,22 +37,22 @@
37
37
  "test": "tsc --project tsconfig.json"
38
38
  },
39
39
  "dependencies": {
40
- "@girs/gjs": "^4.2.0",
41
- "@girs/gtk-4.0": "^4.2.0",
42
- "@girs/gsk-4.0": "^4.2.0",
43
- "@girs/graphene-1.0": "^4.2.0",
44
- "@girs/gobject-2.0": "^4.2.0",
45
- "@girs/glib-2.0": "^4.2.0",
46
- "@girs/gdk-4.0": "^4.2.0",
47
- "@girs/cairo-1.0": "^4.2.0",
48
- "@girs/pangocairo-1.0": "^4.2.0",
49
- "@girs/pango-1.0": "^4.2.0",
50
- "@girs/harfbuzz-0.0": "^4.2.0",
51
- "@girs/freetype2-2.0": "^4.2.0",
52
- "@girs/gio-2.0": "^4.2.0",
53
- "@girs/gmodule-2.0": "^4.2.0",
54
- "@girs/gdkpixbuf-2.0": "^4.2.0",
55
- "@girs/adw-1": "^4.2.0" },
40
+ "@girs/gjs": "^4.3.0",
41
+ "@girs/gtk-4.0": "^4.3.0",
42
+ "@girs/gsk-4.0": "^4.3.0",
43
+ "@girs/graphene-1.0": "^4.3.0",
44
+ "@girs/gobject-2.0": "^4.3.0",
45
+ "@girs/glib-2.0": "^4.3.0",
46
+ "@girs/gdk-4.0": "^4.3.0",
47
+ "@girs/cairo-1.0": "^4.3.0",
48
+ "@girs/pangocairo-1.0": "^4.3.0",
49
+ "@girs/pango-1.0": "^4.3.0",
50
+ "@girs/harfbuzz-0.0": "^4.3.0",
51
+ "@girs/freetype2-2.0": "^4.3.0",
52
+ "@girs/gio-2.0": "^4.3.0",
53
+ "@girs/gmodule-2.0": "^4.3.0",
54
+ "@girs/gdkpixbuf-2.0": "^4.3.0",
55
+ "@girs/adw-1": "^4.3.0" },
56
56
  "devDependencies": {
57
57
  "typescript": "*"
58
58
  },
package/panel-1.d.ts CHANGED
@@ -702,11 +702,9 @@ export namespace Panel {
702
702
  interface SignalSignatures extends Adw.Application.SignalSignatures {
703
703
  "notify::style-manager": (pspec: GObject.ParamSpec) => void;
704
704
  "notify::active-window": (pspec: GObject.ParamSpec) => void;
705
- "notify::autosave-interval": (pspec: GObject.ParamSpec) => void;
706
705
  "notify::menubar": (pspec: GObject.ParamSpec) => void;
707
706
  "notify::register-session": (pspec: GObject.ParamSpec) => void;
708
707
  "notify::screensaver-active": (pspec: GObject.ParamSpec) => void;
709
- "notify::support-save": (pspec: GObject.ParamSpec) => void;
710
708
  "notify::action-group": (pspec: GObject.ParamSpec) => void;
711
709
  "notify::application-id": (pspec: GObject.ParamSpec) => void;
712
710
  "notify::flags": (pspec: GObject.ParamSpec) => void;
@@ -1705,7 +1703,7 @@ export namespace Panel {
1705
1703
  /**
1706
1704
  * Stores the id attribute given in the {@link Gtk.Builder} UI definition.
1707
1705
  * {@link Gtk.Widget} stores the name as object data. Implement this method if your
1708
- * object has some notion of “ID” and it makes sense to map the XML id
1706
+ * object has some notion of ID and it makes sense to map the XML id
1709
1707
  * attribute to it.
1710
1708
  * @param id
1711
1709
  * @virtual
@@ -2537,7 +2535,7 @@ export namespace Panel {
2537
2535
  /**
2538
2536
  * Stores the id attribute given in the {@link Gtk.Builder} UI definition.
2539
2537
  * {@link Gtk.Widget} stores the name as object data. Implement this method if your
2540
- * object has some notion of “ID” and it makes sense to map the XML id
2538
+ * object has some notion of ID and it makes sense to map the XML id
2541
2539
  * attribute to it.
2542
2540
  * @param id
2543
2541
  * @virtual
@@ -2552,7 +2550,7 @@ export namespace Panel {
2552
2550
 
2553
2551
  /**
2554
2552
  * Sets the orientation of the `orientable`.
2555
- * @param orientation the orientable’s new orientation
2553
+ * @param orientation the orientables new orientation
2556
2554
  */
2557
2555
  set_orientation(orientation: Gtk.Orientation): void;
2558
2556
  }
@@ -3027,7 +3025,7 @@ export namespace Panel {
3027
3025
  /**
3028
3026
  * Stores the id attribute given in the {@link Gtk.Builder} UI definition.
3029
3027
  * {@link Gtk.Widget} stores the name as object data. Implement this method if your
3030
- * object has some notion of “ID” and it makes sense to map the XML id
3028
+ * object has some notion of ID and it makes sense to map the XML id
3031
3029
  * attribute to it.
3032
3030
  * @param id
3033
3031
  * @virtual
@@ -3547,7 +3545,7 @@ export namespace Panel {
3547
3545
  /**
3548
3546
  * Stores the id attribute given in the {@link Gtk.Builder} UI definition.
3549
3547
  * {@link Gtk.Widget} stores the name as object data. Implement this method if your
3550
- * object has some notion of “ID” and it makes sense to map the XML id
3548
+ * object has some notion of ID and it makes sense to map the XML id
3551
3549
  * attribute to it.
3552
3550
  * @param id
3553
3551
  * @virtual
@@ -3562,7 +3560,7 @@ export namespace Panel {
3562
3560
 
3563
3561
  /**
3564
3562
  * Sets the orientation of the `orientable`.
3565
- * @param orientation the orientable’s new orientation
3563
+ * @param orientation the orientables new orientation
3566
3564
  */
3567
3565
  set_orientation(orientation: Gtk.Orientation): void;
3568
3566
 
@@ -4143,7 +4141,7 @@ export namespace Panel {
4143
4141
  /**
4144
4142
  * Stores the id attribute given in the {@link Gtk.Builder} UI definition.
4145
4143
  * {@link Gtk.Widget} stores the name as object data. Implement this method if your
4146
- * object has some notion of “ID” and it makes sense to map the XML id
4144
+ * object has some notion of ID and it makes sense to map the XML id
4147
4145
  * attribute to it.
4148
4146
  * @param id
4149
4147
  * @virtual
@@ -5246,7 +5244,7 @@ export namespace Panel {
5246
5244
  /**
5247
5245
  * Stores the id attribute given in the {@link Gtk.Builder} UI definition.
5248
5246
  * {@link Gtk.Widget} stores the name as object data. Implement this method if your
5249
- * object has some notion of “ID” and it makes sense to map the XML id
5247
+ * object has some notion of ID and it makes sense to map the XML id
5250
5248
  * attribute to it.
5251
5249
  * @param id
5252
5250
  * @virtual
@@ -5697,7 +5695,7 @@ export namespace Panel {
5697
5695
  /**
5698
5696
  * Stores the id attribute given in the {@link Gtk.Builder} UI definition.
5699
5697
  * {@link Gtk.Widget} stores the name as object data. Implement this method if your
5700
- * object has some notion of “ID” and it makes sense to map the XML id
5698
+ * object has some notion of ID and it makes sense to map the XML id
5701
5699
  * attribute to it.
5702
5700
  * @param id
5703
5701
  * @virtual
@@ -6612,7 +6610,7 @@ export namespace Panel {
6612
6610
  * Usually this function is used when the widget is located (or will be
6613
6611
  * located) within the hierarchy of a {@link Gtk.ApplicationWindow}.
6614
6612
  *
6615
- * Names are of the form “win.save” or “app.quit” for actions on the
6613
+ * Names are of the form win.save or app.quit for actions on the
6616
6614
  * containing {@link ApplicationWindow} or its associated {@link Application},
6617
6615
  * respectively. This is the same form used for actions in the {@link Gio.Menu}
6618
6616
  * associated with the window.
@@ -6628,14 +6626,14 @@ export namespace Panel {
6628
6626
  * The target value has two purposes. First, it is used as the parameter
6629
6627
  * to activation of the action associated with the {@link Gtk.Actionable} widget.
6630
6628
  * Second, it is used to determine if the widget should be rendered as
6631
- * “active” — the widget is active if the state is equal to the given target.
6629
+ * active the widget is active if the state is equal to the given target.
6632
6630
  *
6633
6631
  * Consider the example of associating a set of buttons with a {@link Gio.Action}
6634
- * with string state in a typical “radio button” situation. Each button
6632
+ * with string state in a typical radio button situation. Each button
6635
6633
  * will be associated with the same action, but with a different target
6636
6634
  * value for that action. Clicking on a particular button will activate
6637
6635
  * the action with the target of that button, which will typically cause
6638
- * the action’s state to change to that value. Since the action’s state
6636
+ * the actions state to change to that value. Since the actions state
6639
6637
  * is now equal to the target value of the button, the button will now
6640
6638
  * be rendered as active (and the other buttons, with different targets,
6641
6639
  * rendered inactive).
@@ -6675,7 +6673,7 @@ export namespace Panel {
6675
6673
  * Usually this function is used when the widget is located (or will be
6676
6674
  * located) within the hierarchy of a {@link Gtk.ApplicationWindow}.
6677
6675
  *
6678
- * Names are of the form “win.save” or “app.quit” for actions on the
6676
+ * Names are of the form win.save or app.quit for actions on the
6679
6677
  * containing {@link ApplicationWindow} or its associated {@link Application},
6680
6678
  * respectively. This is the same form used for actions in the {@link Gio.Menu}
6681
6679
  * associated with the window.
@@ -6692,14 +6690,14 @@ export namespace Panel {
6692
6690
  * The target value has two purposes. First, it is used as the parameter
6693
6691
  * to activation of the action associated with the {@link Gtk.Actionable} widget.
6694
6692
  * Second, it is used to determine if the widget should be rendered as
6695
- * “active” — the widget is active if the state is equal to the given target.
6693
+ * active the widget is active if the state is equal to the given target.
6696
6694
  *
6697
6695
  * Consider the example of associating a set of buttons with a {@link Gio.Action}
6698
- * with string state in a typical “radio button” situation. Each button
6696
+ * with string state in a typical radio button situation. Each button
6699
6697
  * will be associated with the same action, but with a different target
6700
6698
  * value for that action. Clicking on a particular button will activate
6701
6699
  * the action with the target of that button, which will typically cause
6702
- * the action’s state to change to that value. Since the action’s state
6700
+ * the actions state to change to that value. Since the actions state
6703
6701
  * is now equal to the target value of the button, the button will now
6704
6702
  * be rendered as active (and the other buttons, with different targets,
6705
6703
  * rendered inactive).
@@ -6799,7 +6797,7 @@ export namespace Panel {
6799
6797
  /**
6800
6798
  * Stores the id attribute given in the {@link Gtk.Builder} UI definition.
6801
6799
  * {@link Gtk.Widget} stores the name as object data. Implement this method if your
6802
- * object has some notion of “ID” and it makes sense to map the XML id
6800
+ * object has some notion of ID and it makes sense to map the XML id
6803
6801
  * attribute to it.
6804
6802
  * @param id
6805
6803
  * @virtual
@@ -7288,7 +7286,7 @@ export namespace Panel {
7288
7286
  /**
7289
7287
  * Stores the id attribute given in the {@link Gtk.Builder} UI definition.
7290
7288
  * {@link Gtk.Widget} stores the name as object data. Implement this method if your
7291
- * object has some notion of “ID” and it makes sense to map the XML id
7289
+ * object has some notion of ID and it makes sense to map the XML id
7292
7290
  * attribute to it.
7293
7291
  * @param id
7294
7292
  * @virtual
@@ -7303,7 +7301,7 @@ export namespace Panel {
7303
7301
 
7304
7302
  /**
7305
7303
  * Sets the orientation of the `orientable`.
7306
- * @param orientation the orientable’s new orientation
7304
+ * @param orientation the orientables new orientation
7307
7305
  */
7308
7306
  set_orientation(orientation: Gtk.Orientation): void;
7309
7307
  }
@@ -9514,7 +9512,7 @@ export namespace Panel {
9514
9512
  /**
9515
9513
  * Stores the id attribute given in the {@link Gtk.Builder} UI definition.
9516
9514
  * {@link Gtk.Widget} stores the name as object data. Implement this method if your
9517
- * object has some notion of “ID” and it makes sense to map the XML id
9515
+ * object has some notion of ID and it makes sense to map the XML id
9518
9516
  * attribute to it.
9519
9517
  * @param id
9520
9518
  * @virtual
@@ -9983,7 +9981,7 @@ export namespace Panel {
9983
9981
  /**
9984
9982
  * Stores the id attribute given in the {@link Gtk.Builder} UI definition.
9985
9983
  * {@link Gtk.Widget} stores the name as object data. Implement this method if your
9986
- * object has some notion of “ID” and it makes sense to map the XML id
9984
+ * object has some notion of ID and it makes sense to map the XML id
9987
9985
  * attribute to it.
9988
9986
  * @param id
9989
9987
  * @virtual
@@ -10439,7 +10437,7 @@ export namespace Panel {
10439
10437
  /**
10440
10438
  * Stores the id attribute given in the {@link Gtk.Builder} UI definition.
10441
10439
  * {@link Gtk.Widget} stores the name as object data. Implement this method if your
10442
- * object has some notion of “ID” and it makes sense to map the XML id
10440
+ * object has some notion of ID and it makes sense to map the XML id
10443
10441
  * attribute to it.
10444
10442
  * @param id
10445
10443
  * @virtual
@@ -11278,7 +11276,7 @@ export namespace Panel {
11278
11276
  /**
11279
11277
  * Stores the id attribute given in the {@link Gtk.Builder} UI definition.
11280
11278
  * {@link Gtk.Widget} stores the name as object data. Implement this method if your
11281
- * object has some notion of “ID” and it makes sense to map the XML id
11279
+ * object has some notion of ID and it makes sense to map the XML id
11282
11280
  * attribute to it.
11283
11281
  * @param id
11284
11282
  * @virtual