@kurot/ui 3.6.0 → 3.6.2

package/docs/api/Button-class/contentHeight-accessor.md

@@ -0,0 +1,11 @@
+# contentHeight
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+get contentHeight(): number;
+```
+
+Inherited from `contentHeight`; shown with this receiver's substituted types.
+
+The declaration above is the available reference; no additional behavioral JSDoc is present.

package/docs/api/Button-class/contentWidth-accessor.md

@@ -0,0 +1,11 @@
+# contentWidth
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+get contentWidth(): number;
+```
+
+Inherited from `contentWidth`; shown with this receiver's substituted types.
+
+The declaration above is the available reference; no additional behavioral JSDoc is present.

package/docs/api/Button-class/createChildren-method.md

@@ -0,0 +1,13 @@
+# createChildren
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+createChildren(): void;
+```
+
+Inherited from `createChildren`; shown with this receiver's substituted types.
+
+One-time initialization hook on first stage attachment. Applies the active
+theme's skin when no explicit skin is set. Call super.createChildren() when
+overriding; stage reattachment does not call this hook again.

package/docs/api/Button-class/currentState-accessor.md

@@ -0,0 +1,13 @@
+# currentState
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+get currentState(): string;
+set currentState(value: string);
+```
+
+Inherited from `currentState`; shown with this receiver's substituted types.
+
+The current view state. Setting this explicitly overrides `getCurrentState()`.
+Set to `''` to revert to the computed state.

package/docs/api/Button-class/dispatchEvent-method.md

@@ -0,0 +1,15 @@
+# dispatchEvent
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+dispatchEvent(event: Event): boolean;
+```
+
+Inherited from `dispatchEvent`; shown with this receiver's substituted types.
+
+Dispatches synchronously; bubbling events traverse display ancestors through
+capture, target and bubble phases. Returns false when default is prevented.
+Do not retain pooled event instances after their dispatch owner releases them.
+
+Related types: [Event](../../../../core/docs/api/Event-class.md).

package/docs/api/Button-class/dispatchEventWith-method.md

@@ -0,0 +1,11 @@
+# dispatchEventWith
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+dispatchEventWith(type: string, bubbles?: boolean, data?: unknown, cancelable?: boolean): boolean;
+```
+
+Inherited from `dispatchEventWith`; shown with this receiver's substituted types.
+
+The declaration above is the available reference; no additional behavioral JSDoc is present.

package/docs/api/Button-class/enabled-accessor.md

@@ -0,0 +1,12 @@
+# enabled
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+get enabled(): boolean;
+set enabled(value: boolean);
+```
+
+Whether this component accepts input; defaults to true. Disabling immediately
+suppresses touchEnabled/touchChildren and invalidates the skin state; re-enabling
+restores requested flags. This does not stop game callbacks, timers or tweens.

package/docs/api/Button-class/filters-accessor.md

@@ -0,0 +1,16 @@
+# filters
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+get filters(): Filter[];
+set filters(value: Filter[]);
+```
+
+Inherited from `filters`; shown with this receiver's substituted types.
+
+Ordered filter list, initially empty. Assignment copies the list and
+updates filter attachment; reassign after changing its membership. Application
+resource ownership is not transferred when a filter is attached or removed.
+
+Related types: [Filter](../../../../core/docs/api/Filter-class.md).

package/docs/api/Button-class/flipX-accessor.md

@@ -0,0 +1,13 @@
+# flipX
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+get flipX(): boolean;
+set flipX(value: boolean);
+```
+
+Inherited from `flipX`; shown with this receiver's substituted types.
+
+Mirrors content horizontally around its local bounds center without
+changing position, scale or anchor. UI components use their layout frame.

package/docs/api/Button-class/flipY-accessor.md

@@ -0,0 +1,13 @@
+# flipY
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+get flipY(): boolean;
+set flipY(value: boolean);
+```
+
+Inherited from `flipY`; shown with this receiver's substituted types.
+
+Mirrors content vertically around its local bounds center without
+changing position, scale or anchor. UI components use their layout frame.

package/docs/api/Button-class/getBounds-method.md

@@ -0,0 +1,17 @@
+# getBounds
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+getBounds(resultRect?: Rectangle, calculateAnchor: boolean): Rectangle;
+```
+
+Inherited from `getBounds`; shown with this receiver's substituted types.
+
+Returns local logical content bounds, optionally writing into resultRect.
+calculateAnchor defaults to true and subtracts anchor offsets. Omit the
+result rectangle to allocate one; bounds do not include the parent's transform.
+
+**Default calculateAnchor:** `true`
+
+Related types: [Rectangle](../../../../core/docs/api/Rectangle-class.md).

package/docs/api/Button-class/getChildAt-method.md

@@ -0,0 +1,13 @@
+# getChildAt
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+getChildAt(index: number): DisplayObject | undefined;
+```
+
+Inherited from `getChildAt`; shown with this receiver's substituted types.
+
+Returns the child at a zero-based index, or undefined outside the list.
+
+Related types: [DisplayObject](../../../../core/docs/api/DisplayObject-class.md).

package/docs/api/Button-class/getChildByName-method.md

@@ -0,0 +1,14 @@
+# getChildByName
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+getChildByName(name: string): DisplayObject | undefined;
+```
+
+Inherited from `getChildByName`; shown with this receiver's substituted types.
+
+Returns the first direct child with the given name, or undefined.
+This does not search nested containers or require unique names.
+
+Related types: [DisplayObject](../../../../core/docs/api/DisplayObject-class.md).

package/docs/api/Button-class/getChildIndex-method.md

@@ -0,0 +1,14 @@
+# getChildIndex
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+getChildIndex(child: DisplayObject): number;
+```
+
+Inherited from `getChildIndex`; shown with this receiver's substituted types.
+
+Returns the child's zero-based direct-list index, or -1 when absent.
+A descendant nested in another container is not a direct child.
+
+Related types: [DisplayObject](../../../../core/docs/api/DisplayObject-class.md).

package/docs/api/Button-class/getCurrentState-method.md

@@ -0,0 +1,17 @@
+# getCurrentState
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+protected getCurrentState(): string;
+```
+
+Extension hook: protected; available to subclasses.
+
+Return the current view state, layering the selected state on top of
+the base up/down/disabled states.
+
+Matches egret `ToggleButton.getCurrentState` (L132-145): if the skin
+does not export an `AndSelected` variant, the state falls back to `down`
+(or `disabled`) instead of returning a skin-missing state name that
+would leave the button visually blank.

package/docs/api/Button-class/getElementAt-method.md

@@ -0,0 +1,13 @@
+# getElementAt
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+getElementAt(index: number): DisplayObject | undefined;
+```
+
+Inherited from `getElementAt`; shown with this receiver's substituted types.
+
+The declaration above is the available reference; no additional behavioral JSDoc is present.
+
+Related types: [DisplayObject](../../../../core/docs/api/DisplayObject-class.md).

package/docs/api/Button-class/getLayoutBounds-method.md

@@ -0,0 +1,14 @@
+# getLayoutBounds
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+getLayoutBounds(bounds: Rectangle): void;
+```
+
+Inherited from `getLayoutBounds`; shown with this receiver's substituted types.
+
+Write current transformed layout bounds in parent-space logical pixels into
+the caller's Rectangle. The rectangle is reused, not retained.
+
+Related types: [Rectangle](../../../../core/docs/api/Rectangle-class.md).

package/docs/api/Button-class/getPreferredBounds-method.md

@@ -0,0 +1,14 @@
+# getPreferredBounds
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+getPreferredBounds(bounds: Rectangle): void;
+```
+
+Inherited from `getPreferredBounds`; shown with this receiver's substituted types.
+
+Write preferred (explicit or measured) transformed bounds in parent-space
+logical pixels into the caller's Rectangle, before parent size allocation.
+
+Related types: [Rectangle](../../../../core/docs/api/Rectangle-class.md).

package/docs/api/Button-class/getTransformedBounds-method.md

@@ -0,0 +1,15 @@
+# getTransformedBounds
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+getTransformedBounds(targetCoordinateSpace: DisplayObject, resultRect?: Rectangle): Rectangle;
+```
+
+Inherited from `getTransformedBounds`; shown with this receiver's substituted types.
+
+Returns an axis-aligned logical bounding box in targetCoordinateSpace.
+Rotation/skew can enlarge the box. A supplied resultRect is overwritten and
+returned; otherwise a new rectangle is allocated.
+
+Related types: [Rectangle](../../../../core/docs/api/Rectangle-class.md), [DisplayObject](../../../../core/docs/api/DisplayObject-class.md).

package/docs/api/Button-class/getVirtualElementAt-method.md

@@ -0,0 +1,13 @@
+# getVirtualElementAt
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+getVirtualElementAt(index: number): DisplayObject | undefined;
+```
+
+Inherited from `getVirtualElementAt`; shown with this receiver's substituted types.
+
+The declaration above is the available reference; no additional behavioral JSDoc is present.
+
+Related types: [DisplayObject](../../../../core/docs/api/DisplayObject-class.md).

package/docs/api/Button-class/globalToLocal-method.md

@@ -0,0 +1,19 @@
+# globalToLocal
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+globalToLocal(stageX: number, stageY: number, resultPoint?: Point): Point;
+```
+
+Inherited from `globalToLocal`; shown with this receiver's substituted types.
+
+Converts logical stage coordinates to this object's local coordinates,
+including ancestors, anchors and scrolling. Defaults to stage (0, 0).
+Writes into resultPoint when supplied; browser client coordinates need conversion first.
+
+**Default stageX:** `0`
+
+**Default stageY:** `0`
+
+Related types: [Point](../../../../core/docs/api/Point-class.md).

package/docs/api/Button-class/graphics-accessor.md

@@ -0,0 +1,14 @@
+# graphics
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+get graphics(): Graphics;
+```
+
+Inherited from `graphics`; shown with this receiver's substituted types.
+
+Retained drawing commands when the subclass provides Graphics. Base nodes
+return undefined; use Shape or Sprite for vector drawing.
+
+Related types: [Graphics](../../../../core/docs/api/Graphics-class.md).

package/docs/api/Button-class/hasEventListener-method.md

@@ -0,0 +1,11 @@
+# hasEventListener
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+hasEventListener(type: string): boolean;
+```
+
+Inherited from `hasEventListener`; shown with this receiver's substituted types.
+
+The declaration above is the available reference; no additional behavioral JSDoc is present.

package/docs/api/Button-class/height-accessor.md

@@ -0,0 +1,18 @@
+# height
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+get height(): number;
+set height(v: number);
+```
+
+Inherited from `height`; shown with this receiver's substituted types.
+
+Current unscaled UI height in logical pixels. Explicit height starts as NaN
+(automatic measurement); assigning NaN restores automatic sizing. Parent layout
+constraints may allocate a different size. Reading can validate pending size.
+
+Unscaled logical height: measured content unless explicitly assigned.
+NaN restores automatic measurement; changing this value does not change scaleY.
+Subclasses define how an explicit height constrains or draws their content.

package/docs/api/Button-class/hitTestPoint-method.md

@@ -0,0 +1,13 @@
+# hitTestPoint
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+hitTestPoint(x: number, y: number, shapeFlag?: boolean): boolean;
+```
+
+Inherited from `hitTestPoint`; shown with this receiver's substituted types.
+
+Tests a point in logical stage coordinates. By default tests bounds and
+rectangular clipping; shapeFlag = true additionally uses display hit testing.
+A zero scale returns false. The bounds-only path is not an input-enabled check.

package/docs/api/Button-class/horizontalCenter-accessor.md

@@ -0,0 +1,16 @@
+# horizontalCenter
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+get horizontalCenter(): string | number;
+set horizontalCenter(v: string | number);
+```
+
+Inherited from `horizontalCenter`; shown with this receiver's substituted types.
+
+Offset from the horizontal center of the parent container.
+
+Horizontal center offset in logical pixels, or a percentage string; defaults
+to NaN (unset). BasicLayout measures percentage offsets against half the parent
+width, with 0 centering the element.

package/docs/api/Button-class/hostComponentKey-accessor.md

@@ -0,0 +1,13 @@
+# hostComponentKey
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+get hostComponentKey(): string;
+set hostComponentKey(value: string);
+```
+
+Inherited from `hostComponentKey`; shown with this receiver's substituted types.
+
+Key used to look up the default skin in the active Theme.
+Defaults to the component's class name if not set.

package/docs/api/Button-class/icon-accessor.md

@@ -0,0 +1,13 @@
+# icon
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+get icon(): string | Texture | undefined;
+set icon(value: string | Texture | undefined);
+```
+
+Borrowed Texture or image-adapter string, initially undefined. Passed to the
+optional iconDisplay skin part; replacement does not dispose a texture.
+
+Related types: [Texture](../../../../core/docs/api/Texture-class.md).

package/docs/api/Button-class/iconDisplay-property.md

@@ -0,0 +1,11 @@
+# iconDisplay
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+iconDisplay?: Image;
+```
+
+The declaration above is the available reference; no additional behavioral JSDoc is present.
+
+Related types: [Image](../Image-class.md).

package/docs/api/Button-class/includeInLayout-accessor.md

@@ -0,0 +1,15 @@
+# includeInLayout
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+get includeInLayout(): boolean;
+set includeInLayout(v: boolean);
+```
+
+Inherited from `includeInLayout`; shown with this receiver's substituted types.
+
+Whether this component participates in its parent's layout.
+
+Whether the parent layout measures and positions this element; defaults to
+true. Setting false does not hide it, disable input or stop its callbacks.

package/docs/api/Button-class/invalidateDisplayList-method.md

@@ -0,0 +1,11 @@
+# invalidateDisplayList
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+invalidateDisplayList(): void;
+```
+
+Inherited from `invalidateDisplayList`; shown with this receiver's substituted types.
+
+Queue a deferred layout/redraw pass using the current unscaled UI size.

package/docs/api/Button-class/invalidateProperties-method.md

@@ -0,0 +1,12 @@
+# invalidateProperties
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+invalidateProperties(): void;
+```
+
+Inherited from `invalidateProperties`; shown with this receiver's substituted types.
+
+Queue a deferred commitProperties() pass. Repeated invalidations coalesce;
+this does not synchronously commit or schedule application game logic.

package/docs/api/Button-class/invalidateSize-method.md

@@ -0,0 +1,12 @@
+# invalidateSize
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+invalidateSize(): void;
+```
+
+Inherited from `invalidateSize`; shown with this receiver's substituted types.
+
+Queue deferred measurement and parent layout updates. Use validateNow() after
+attachment if code must read the resulting UI layout synchronously.

package/docs/api/Button-class/invalidateState-method.md

@@ -0,0 +1,11 @@
+# invalidateState
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+invalidateState(): void;
+```
+
+Inherited from `invalidateState`; shown with this receiver's substituted types.
+
+Mark the view state as dirty so it will be re-applied on next commit.

package/docs/api/Button-class/isCachedAsTexture-accessor.md

@@ -0,0 +1,12 @@
+# isCachedAsTexture
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+get isCachedAsTexture(): boolean;
+```
+
+Inherited from `isCachedAsTexture`; shown with this receiver's substituted types.
+
+Whether a display-list texture cache currently exists, initially false.
+The cache uses Canvas capture even when the application renders with WebGL.

package/docs/api/Button-class/isRenderGroup-property.md

@@ -0,0 +1,18 @@
+# isRenderGroup
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+isRenderGroup: boolean;
+```
+
+Inherited from `isRenderGroup`; shown with this receiver's substituted types.
+
+When true this container owns an independent InstructionSet.
+The renderer will build and execute its subtree separately, so changes
+inside this container never trigger a rebuild of the parent set.
+
+Typical use: mark a static background layer or a rarely-changing UI panel
+as a RenderGroup so the parent scene graph traversal skips it entirely.
+
+**Default/initializer:** `false`

package/docs/api/Button-class/label-accessor.md

@@ -0,0 +1,11 @@
+# label
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+get label(): string;
+set label(value: string);
+```
+
+Button caption, initially empty. Copied into labelDisplay when that optional
+skin part is available; changing the label does not load or attach a skin.

package/docs/api/Button-class/labelDisplay-property.md

@@ -0,0 +1,11 @@
+# labelDisplay
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+labelDisplay?: Label;
+```
+
+The declaration above is the available reference; no additional behavioral JSDoc is present.
+
+Related types: [Label](../Label-class.md).

package/docs/api/Button-class/left-accessor.md

@@ -0,0 +1,15 @@
+# left
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+get left(): string | number;
+set left(v: string | number);
+```
+
+Inherited from `left`; shown with this receiver's substituted types.
+
+Distance from the left edge of the parent container.
+
+Left-edge layout constraint: logical pixels, or a percentage string interpreted
+by the parent layout. NaN (default) means unset; BasicLayout supports percentages.

package/docs/api/Button-class/localToGlobal-method.md

@@ -0,0 +1,19 @@
+# localToGlobal
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+localToGlobal(localX: number, localY: number, resultPoint?: Point): Point;
+```
+
+Inherited from `localToGlobal`; shown with this receiver's substituted types.
+
+Converts local logical coordinates to logical stage coordinates, including
+ancestors, anchors and scrolling. Inputs default to (0, 0); resultPoint is
+reused when supplied. The result is not a browser client-pixel position.
+
+**Default localX:** `0`
+
+**Default localY:** `0`
+
+Related types: [Point](../../../../core/docs/api/Point-class.md).

package/docs/api/Button-class/mask-accessor.md

@@ -0,0 +1,16 @@
+# mask
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+get mask(): Rectangle | DisplayObject | undefined;
+set mask(value: Rectangle | DisplayObject | undefined);
+```
+
+Inherited from `mask`; shown with this receiver's substituted types.
+
+Optional DisplayObject or logical Rectangle clipping mask, initially
+undefined. Assign undefined to detach it. A display mask is shared by at most
+one masked object; assigning it elsewhere transfers that mask association.
+
+Related types: [Rectangle](../../../../core/docs/api/Rectangle-class.md), [DisplayObject](../../../../core/docs/api/DisplayObject-class.md).

package/docs/api/Button-class/matrix-accessor.md

@@ -0,0 +1,15 @@
+# matrix
+
+Package: `@kurot/ui@3.6.2`. Generated from public declarations and JSDoc.
+
+```ts
+get matrix(): Matrix;
+set matrix(value: Matrix);
+```
+
+Inherited from `matrix`; shown with this receiver's substituted types.
+
+Authored transform, excluding centered flips and anchor/scroll offsets.
+Assigning it preserves flipX/flipY. The getter returns a copy.
+
+Related types: [Matrix](../../../../core/docs/api/Matrix-class.md).