@minecraft/server-ui 2.2.0-beta.1.26.40-preview.26 → 2.2.0-beta.1.26.40-preview.30

package/index.d.ts

@@ -498,6 +498,31 @@ export class CustomForm {
      * {@link InvalidFormModificationError}
      */
     header(text: ObservableString | ObservableUIRawMessage | string | UIRawMessage, options?: TextOptions): CustomForm;
+    /**
+     * @beta
+     * @remarks
+     * Adds an image component to the form layout.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * @param src
+     * The image source path to display. Must be a relative path to
+     * an image file within the provided pack.
+     * @param pack
+     * The resource pack identifier that contains the provided
+     * image source.
+     * @param options
+     * Optional configuration for the image, such as visibility or
+     * width.
+     * @returns
+     * The form instance to allow method chaining.
+     * @throws This function can throw errors.
+     *
+     * {@link InvalidFormModificationError}
+     *
+     * {@link InvalidObservableError}
+     */
+    image(src: ObservableString | string, pack: ObservableString | string, options?: ImageOptions): CustomForm;
     /**
      * @remarks
      * Returns true if the form is currently being shown to the
@@ -1602,6 +1627,42 @@ export interface DropdownOptions {
     visible?: boolean | ObservableBoolean;
 }
 
+/**
+ * @beta
+ * Options for configuring an image component.
+ */
+export interface ImageOptions {
+    /**
+     * @remarks
+     * Sets a callback to be executed when the image is clicked.
+     *
+     */
+    onClick?: () => void;
+    /**
+     * @remarks
+     * Sets a tooltip to be displayed when the user hovers over the
+     * image.
+     *
+     */
+    tooltip?: ObservableString | ObservableUIRawMessage | string | UIRawMessage;
+    /**
+     * @remarks
+     * When false or bound to a false ObservableBoolean, the image
+     * is hidden.
+     *
+     */
+    visible?: boolean | ObservableBoolean;
+    /**
+     * @remarks
+     * Sets the width of the image as a percentage of the width of
+     * the form. 1 is the entire form width, 0.5 is half of the
+     * form width. Greater than 1 or less than/equal to 0 will
+     * become 1.
+     *
+     */
+    width?: number | ObservableNumber;
+}
+
 /**
  * The result returned when an MessageBox is closed. Contains
  * the reason the message box was closed and the player's

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server-ui",
-  "version": "2.2.0-beta.1.26.40-preview.26",
+  "version": "2.2.0-beta.1.26.40-preview.30",
   "description": "",
   "contributors": [
     {
@@ -14,7 +14,7 @@
   ],
   "peerDependencies": {
     "@minecraft/common": "^1.0.0",
-    "@minecraft/server": "^2.0.0 || ^2.10.0-beta.1.26.40-preview.26"
+    "@minecraft/server": "^2.0.0 || ^2.10.0-beta.1.26.40-preview.30"
   },
   "license": "MIT"
 }