@girs/gcrui-3 4.2.0 → 4.3.0

package/README.md

@@ -5,25 +5,25 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/gcrui-3)
 
 
-GJS TypeScript type definitions for GcrUi-3 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.2.0.
+GJS TypeScript type definitions for GcrUi-3 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.3.0.
 
 ## Install
 
-To use this type definitions, install them with NPM:
+Install the type definitions with npm:
 ```bash
 npm install @girs/gcrui-3
 ```
 
 ## Usage
 
-You can import this package into your project like this:
+Import it like any other module:
 ```ts
 import GcrUi from '@girs/gcrui-3';
 ```
 
 ### 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.
+[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.
 For this you need to include `@girs/gcrui-3` or `@girs/gcrui-3/ambient` in your `tsconfig` or entry point Typescript file:
 
 `index.ts`:
@@ -42,7 +42,7 @@ import '@girs/gcrui-3'
 }
 ```
 
-Now you can import the ambient module with TypeScript support: 
+The ambient module now resolves with types:
 
 ```ts
 import GcrUi from 'gi://GcrUi?version=3';
@@ -50,7 +50,7 @@ import GcrUi from 'gi://GcrUi?version=3';
 
 ### Global import
 
-You can also import the module with Typescript support using the global `imports.gi` object of GJS.
+GJS's global `imports.gi` works too, with types.
 For this you need to include `@girs/gcrui-3` or `@girs/gcrui-3/import` in your `tsconfig` or entry point Typescript file:
 
 `index.ts`:
@@ -69,7 +69,7 @@ import '@girs/gcrui-3'
 }
 ```
 
-Now you have also type support for this, too:
+That form carries types as well:
 
 ```ts
 const GcrUi = imports.gi.GcrUi;
@@ -77,7 +77,7 @@ const GcrUi = imports.gi.GcrUi;
 
 ### 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).
+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.
 
 ## Other packages
 

package/gcrui-3.d.ts

@@ -485,11 +485,14 @@ export namespace GcrUi {
         set_attributes(attrs: Gck.Attributes | null): void;
 
         /**
+         * signal emitted when data being rendered changes
          * @virtual
          */
         vfunc_data_changed(): void;
 
         /**
+         * method invoked to populate a popup menu with additional
+         *                  renderer options
          * @param viewer 
          * @param menu 
          * @virtual
@@ -1899,11 +1902,14 @@ export namespace GcrUi {
         set_attributes(attrs: Gck.Attributes | null): void;
 
         /**
+         * signal emitted when data being rendered changes
          * @virtual
          */
         vfunc_data_changed(): void;
 
         /**
+         * method invoked to populate a popup menu with additional
+         *                  renderer options
          * @param viewer 
          * @param menu 
          * @virtual
@@ -2040,6 +2046,7 @@ export namespace GcrUi {
 
         // Virtual methods
         /**
+         * Emitted when the import completes, or fails.
          * @param importer 
          * @param error 
          * @virtual
@@ -2047,6 +2054,7 @@ export namespace GcrUi {
         vfunc_imported(importer: Gcr.Importer, error: GLib.Error): void;
 
         /**
+         * Emitted when the import begins.
          * @param importer 
          * @virtual
          */
@@ -2498,11 +2506,14 @@ export namespace GcrUi {
         render_view(viewer: Viewer): void;
 
         /**
+         * signal emitted when data being rendered changes
          * @virtual
          */
         vfunc_data_changed(): void;
 
         /**
+         * method invoked to populate a popup menu with additional
+         *                  renderer options
          * @param viewer 
          * @param menu 
          * @virtual
@@ -3033,48 +3044,56 @@ export namespace GcrUi {
         /**
          * Whether the choice check box is visible or not.
          * @read-only
+         * @default false
          */
         get choice_visible(): boolean;
 
         /**
          * Whether the choice check box is visible or not.
          * @read-only
+         * @default false
          */
         get choiceVisible(): boolean;
 
         /**
          * Whether the password confirm entry is visible or not.
          * @read-only
+         * @default false
          */
         get confirm_visible(): boolean;
 
         /**
          * Whether the password confirm entry is visible or not.
          * @read-only
+         * @default false
          */
         get confirmVisible(): boolean;
 
         /**
          * Whether the password entry is visible or not.
          * @read-only
+         * @default false
          */
         get password_visible(): boolean;
 
         /**
          * Whether the password entry is visible or not.
          * @read-only
+         * @default false
          */
         get passwordVisible(): boolean;
 
         /**
          * Whether the warning label is visible or not.
          * @read-only
+         * @default false
          */
         get warning_visible(): boolean;
 
         /**
          * Whether the warning label is visible or not.
          * @read-only
+         * @default false
          */
         get warningVisible(): boolean;
 
@@ -4156,9 +4175,15 @@ export namespace GcrUi {
         static $gtype: GObject.GType<UnlockOptionsWidget>;
 
         // Properties
+        /**
+         * @default null
+         */
         get choice(): string;
         set choice(val: string);
 
+        /**
+         * @default 0
+         */
         get ttl(): number;
         set ttl(val: number);
 
@@ -4349,6 +4374,7 @@ export namespace GcrUi {
          * 
          * Used as a hint when displaying a title for the data, but may be
          * overridden by the parsed data.
+         * @default null
          */
         get display_name(): string;
         set display_name(val: string);
@@ -4359,6 +4385,7 @@ export namespace GcrUi {
          * 
          * Used as a hint when displaying a title for the data, but may be
          * overridden by the parsed data.
+         * @default null
          */
         get displayName(): string;
         set displayName(val: string);
@@ -4688,11 +4715,14 @@ export namespace GcrUi {
 
             // Virtual methods
             /**
+             * signal emitted when data being rendered changes
              * @virtual
              */
             vfunc_data_changed(): void;
 
             /**
+             * method invoked to populate a popup menu with additional
+             *                  renderer options
              * @param viewer 
              * @param menu 
              * @virtual

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@girs/gcrui-3",
-    "version": "4.2.0",
+    "version": "4.3.0",
     "description": "GJS TypeScript type definitions for GcrUi-3",
     "type": "module",
     "module": "gcrui-3.js",
@@ -36,22 +36,22 @@
       "test": "tsc --project tsconfig.json"
     },
     "dependencies": {
-      "@girs/gjs": "^4.2.0",
-      "@girs/gtk-3.0": "^4.2.0",
-      "@girs/xlib-2.0": "^4.2.0",
-      "@girs/gdk-3.0": "^4.2.0",
-      "@girs/cairo-1.0": "^4.2.0",
-      "@girs/gobject-2.0": "^4.2.0",
-      "@girs/glib-2.0": "^4.2.0",
-      "@girs/pango-1.0": "^4.2.0",
-      "@girs/harfbuzz-0.0": "^4.2.0",
-      "@girs/freetype2-2.0": "^4.2.0",
-      "@girs/gio-2.0": "^4.2.0",
-      "@girs/gmodule-2.0": "^4.2.0",
-      "@girs/gdkpixbuf-2.0": "^4.2.0",
-      "@girs/atk-1.0": "^4.2.0",
-      "@girs/gcr-3": "^4.2.0",
-      "@girs/gck-1": "^4.2.0"    },
+      "@girs/gjs": "^4.3.0",
+      "@girs/gtk-3.0": "^4.3.0",
+      "@girs/xlib-2.0": "^4.3.0",
+      "@girs/gdk-3.0": "^4.3.0",
+      "@girs/cairo-1.0": "^4.3.0",
+      "@girs/gobject-2.0": "^4.3.0",
+      "@girs/glib-2.0": "^4.3.0",
+      "@girs/pango-1.0": "^4.3.0",
+      "@girs/harfbuzz-0.0": "^4.3.0",
+      "@girs/freetype2-2.0": "^4.3.0",
+      "@girs/gio-2.0": "^4.3.0",
+      "@girs/gmodule-2.0": "^4.3.0",
+      "@girs/gdkpixbuf-2.0": "^4.3.0",
+      "@girs/atk-1.0": "^4.3.0",
+      "@girs/gcr-3": "^4.3.0",
+      "@girs/gck-1": "^4.3.0"    },
     "devDependencies": {
       "typescript": "*"
     },