WEBRAD / TECHNICAL REFERENCE

Reusable Element

A reusable element instance, in the normal flow or floating.

WebReusableElementContainersVisual0 events

Quick start

Add Reusable1 in the Designer. Use the example in a page method.

Reusable1.placement = 'floating';
Reusable1.floatingHorizontalAnchor = 'right';
Reusable1.floatingVerticalAnchor = 'bottom';
Reusable1.floatingZIndex = 100;
Reusable1.show();

Create the definition in Reusable elements and select it in the instance’s Inspector.
Link events and write logic in the definition’s TypeScript file.
Use placement to choose normal flow or a floating layer; configure anchors and floatingZIndex as needed.
Children belong to the definition’s scope and do not automatically become public host properties.

Inspector properties

Component options and defaults. Fields without runtime access are configured in the Inspector.

Property / source	Type and options	Default	Runtime access
`name`Name · Identity	`string`	`—`	name
`x`Left · Size & position	`number`	`0`	x
`y`Top · Size & position	`number`	`0`	y
`width`Width · Size & position	`number`	`360`	width
`height`Height · Size & position	`number`	`240`	height
`itemWidth`Responsive width · Responsive sizeFit content grows the item to its widest rendered child and preserves child intrinsic widths; minimum and maximum width remain limits.	`enumfixed` `stretch` `fit-content`	`"fixed"`	Inspector / configuration
`itemHeight`Responsive height · Responsive sizeFit content grows the item to its lowest rendered child and preserves child intrinsic heights; minimum and maximum height remain limits.	`enumfixed` `stretch` `fit-content`	`"fixed"`	Inspector / configuration
`itemMinWidth`Minimum width · Responsive size	`number`	`0`	Inspector / configuration
`itemMaxWidth`Maximum width · Responsive size	`number`	`null`	Inspector / configuration
`itemMinHeight`Minimum height · Responsive size	`number`	`0`	Inspector / configuration
`itemMaxHeight`Maximum height · Responsive size	`number`	`null`	Inspector / configuration
`itemGrow`Grow · Responsive size	`number`	`0`	Inspector / configuration
`itemShrink`Shrink · Responsive sizeAllows fixed and stretch flow items to yield space. Fit-content keeps its intrinsic size so its children are not compressed.	`boolean`	`true`	Inspector / configuration
`itemAlignSelf`Item alignment · Responsive sizeCross-axis alignment for this item in a row or column. Auto inherits the parent alignment; responsive cross-axis stretch retains its sizing behavior.	`enumauto` `start` `center` `end` `stretch`	`"auto"`	Inspector / configuration
`itemHorizontalAnchor`Horizontal anchor · Anchors & offsets	`enumstart` `center` `end` `stretch`	`"start"`	Inspector / configuration
`itemVerticalAnchor`Vertical anchor · Anchors & offsets	`enumstart` `center` `end` `stretch`	`"start"`	Inspector / configuration
`itemLeft`Left inset · Anchors & offsets	`number`	`0`	Inspector / configuration
`itemRight`Right inset · Anchors & offsets	`number`	`0`	Inspector / configuration
`itemTop`Top inset · Anchors & offsets	`number`	`0`	Inspector / configuration
`itemBottom`Bottom inset · Anchors & offsets	`number`	`0`	Inspector / configuration
`margin`Margin · SpacingOuter spacing on all four sides, in pixels. Row and column layouts include this spacing between components.	`number`	`0`	margin
`marginTop`Margin top · SpacingOuter spacing on this side, in pixels. Overrides the shared Margin value.	`number`	`0`Derived from saved properties	marginTop
`marginRight`Margin right · SpacingOuter spacing on this side, in pixels. Overrides the shared Margin value.	`number`	`0`Derived from saved properties	marginRight
`marginBottom`Margin bottom · SpacingOuter spacing on this side, in pixels. Overrides the shared Margin value.	`number`	`0`Derived from saved properties	marginBottom
`marginLeft`Margin left · SpacingOuter spacing on this side, in pixels. Overrides the shared Margin value.	`number`	`0`Derived from saved properties	marginLeft
`visible`Visible · Behavior	`boolean`	`true`	visible
`collapseWhenHidden`Collapse when hidden · BehaviorRemoves the component from the layout while it is not visible.	`boolean`	`true`	collapseWhenHidden
`enabled`Enabled · Behavior	`boolean`	`true`	enabled
`reusableElementId`Reusable component · Reusable componentThe shared component definition rendered by this instance.	`reusable-element`	`""`	reusableElementId
`placement`Placement · Reusable componentFloating instances are fixed to the viewport and do not consume page flow.	`enumin-flow` `floating`	`"in-flow"`	placement
`floatingHorizontalAnchor`Floating horizontal anchor · Floating placement	`enumleft` `center` `right`	`"left"`	floatingHorizontalAnchorConditional availability in the Inspector
`floatingVerticalAnchor`Floating vertical anchor · Floating placement	`enumtop` `center` `bottom`	`"top"`	floatingVerticalAnchorConditional availability in the Inspector
`floatingZIndex`Floating layer · Floating placement	`number`	`100`	floatingZIndex
`currentRowBindings`Current row · DataBind writable visual values to fields of this repeated row.	`current-row-bindings`Editor: current-row-bindings	`[]`	currentRowBindings

API in code

Member	Signature	Access
`reusableElementId`	`reusableElementId: string;`	Read and write

Inherited members (41)

Member	Signature	Access
`aspectRatio`	`aspectRatio: WebAspectRatio;`	Read and write
`floatingAlignment`	`floatingAlignment: WebPanelFloatingAlignment;`	Read and write
`placement`	`placement: 'in-flow' \| 'floating';`	Read and write
`floatingHorizontalAnchor`	`floatingHorizontalAnchor: 'left' \| 'center' \| 'right';`	Read and write
`floatingVerticalAnchor`	`floatingVerticalAnchor: 'top' \| 'center' \| 'bottom';`	Read and write
`floatingZIndex`	`floatingZIndex: number;`	Read and write
`caption`	`caption: string;`	Read and write
`progressEnabled`	`progressEnabled: boolean;`	Read and write
`progressValue`	`progressValue: number;`	Read and write
`progressVisible`	`readonly progressVisible: boolean;`	Read-only
`backgroundImage`	`backgroundImage: string;`	Read and write
`backgroundSize`	`backgroundSize: WebPanelBackgroundSize;`	Read and write
`backgroundPosition`	`backgroundPosition: WebPanelBackgroundPosition;`	Read and write
`backgroundRepeat`	`backgroundRepeat: WebPanelBackgroundRepeat;`	Read and write
`currentRowBindings`	`currentRowBindings: readonly WebCurrentRowBinding[];`	Read and write
`element`	`readonly element: TElement;`	Read-only
`id`	`readonly id: string;`	Read-only
`name`	`readonly name: string;`	Read-only
`visible`	`visible: boolean;`	Read and write
`collapseWhenHidden`	`collapseWhenHidden: boolean;`	Read and write
`enabled`	`enabled: boolean;`	Read and write
`x`	`x: number;`	Read and write
`y`	`y: number;`	Read and write
`width`	`width: number;`	Read and write
`height`	`height: number;`	Read and write
`margin`Outer spacing on all four sides, in pixels.	`margin: number;`	Read and write
`marginTop`	`marginTop: number;`	Read and write
`marginRight`	`marginRight: number;`	Read and write
`marginBottom`	`marginBottom: number;`	Read and write
`marginLeft`	`marginLeft: number;`	Read and write
`alignSelf`	`alignSelf: RuntimeLayoutAlignSelf;`	Read and write
`tabIndex`	`tabIndex: number;`	Read and write
`backgroundColor`	`backgroundColor: string;`	Read and write
`color`	`color: string;`	Read and write
`borderColor`	`borderColor: string;`	Read and write

`focus`

method

focus(options?: FocusOptions): void;

`show`

method

show(): void;

`hide`

method

hide(): void;

`bindEvent`

method

bindEvent(eventName: string, handler: WebComponentEventHandler<this> | null): () => void;

`emit`

method

emit(eventName: string, detail?: unknown): boolean;

`dispose`

method

dispose(): void;

Events

Link methods in Interaction. How to use events.

This component’s host does not register events in Interaction. Edit internal component events in the reusable definition’s code.