@needle-tools/engine 4.12.0-beta → 4.12.0-next.ca2cebd

package/src/engine-components/ui/Button.ts

@@ -64,7 +64,7 @@ class AnimationTriggers {
  * Button is a UI component that can be clicked by the user to perform an action.  
  * It supports different visual states such as normal, highlighted, pressed, and disabled.  
  * You can customize the button's appearance using colors or animations for each state.
- * @summary Button UI Component
+ * @summary UI Button that can be clicked to perform actions
  * @category User Interface
  * @group Components
  */

package/src/engine-components/ui/Canvas.ts

@@ -29,7 +29,7 @@ const debugLayout = getParam("debuguilayout");
  * It defines the area where UI elements are rendered and manages their layout and rendering settings.  
  * Canvases can be set to render in world space or screen space (overlay or camera).  
  * Multiple canvases can exist in a scene, each with its own settings and hierarchy of UI elements.
- * @summary Canvas UI Component
+ * @summary Root component for UI elements, managing layout and rendering settings
  * @category User Interface
  * @group Components
  */

package/src/engine-components/ui/CanvasGroup.ts

@@ -10,7 +10,7 @@ import { type ICanvasGroup, type IHasAlphaFactor } from "./Interfaces.js";
  * CanvasGroup is a UI component that allows you to control the transparency and interactivity of a group of UI elements.  
  * By adjusting the alpha property, you can fade in or out all child UI elements simultaneously.  
  * The interactable and blocksRaycasts properties let you enable or disable user interaction for the entire group.
- * @summary CanvasGroup UI Component
+ * @summary Group UI elements to control transparency and interactivity
  * @category User Interface
  * @group Components
  */

package/src/engine-components/ui/EventSystem.ts

@@ -37,7 +37,7 @@ onInitialized((ctx) => {
 
 /**
  * The EventSystem is responsible for managing and dispatching input events to UI components within the scene.
- * @summary UI Input Event System
+ * @summary Manages and dispatches input events to UI components
  * @category User Interface
  * @group Components
  */

package/src/engine-components/ui/Image.ts

@@ -15,7 +15,7 @@ class Sprite {
  * Image is a UI component that displays a sprite (2D image) in the user interface.  
  * You can set the image property to assign a texture to be displayed.  
  * The sprite can be customized with various properties such as color tinting and pixel density.
- * @summary Image UI Component
+ * @summary Display a 2D image in the UI
  * @category User Interface
  * @group Components
  */

package/src/engine-components/ui/InputField.ts

@@ -13,7 +13,7 @@ const debug = getParam("debuginputfield");
  * InputField is a UI component that allows users to enter and edit text.  
  * It provides a text input area where users can type, delete, and modify text.  
  * The InputField supports placeholder text, events for value changes, and end edit actions.
- * @summary Text Input Field UI Component
+ * @summary Text field for user input
  * @category User Interface
  * @group Components
  */

package/src/engine-components/ui/Outline.ts

@@ -7,7 +7,7 @@ import { Behaviour } from "../Component.js";
 /**
  * Outline is a UI component that adds an outline effect to UI elements.  
  * You can customize the outline color and distance to create a visual border around the UI element.
- * @summary Outline UI Component
+ * @summary Add an outline effect to UI elements
  * @category User Interface
  * @group Components
  */

package/src/engine-components/ui/SpatialHtml.ts

@@ -6,6 +6,13 @@ import { serializable } from '../../engine/engine_serialization.js';
 import { getWorldRotation, setWorldRotationXYZ } from '../../engine/engine_three_utils.js';
 import { Behaviour } from '../Component.js';
 
+/**
+ * SpatialHtml is a component that allows you to integrate HTML elements into a 3D scene.  
+ * By specifying the ID of an existing HTML element, you can render it as a 3D object within the scene.
+ * @summary Render HTML elements as 3D objects in the scene
+ * @category User Interface
+ * @group Components
+ */
 export class SpatialHtml extends Behaviour {
 
     @serializable()

package/src/engine-components/ui/Text.ts

@@ -41,6 +41,8 @@ export enum FontStyle {
 
 /**
  * Text is a UI component that displays text in the user interface.
+ * 
+ * @summary Display text in the UI
  * @category User Interface
  * @group Components
  */