Documentation

UICell

The UICell component groups other components together within its own boundaries.

class UICell

extends UIContainer

Represents a UI component that visually groups other components in a rectangular cell.

See Also

UICoverCell, UIFlowCell, UIListCellAdapter.

Example (preset)

const MyCell = UICell.with(
    {
        background: "@background",
        dimensions: { height: 128, width: 128 }
    },
    UIRow.with( /* ... */ )
)

Constructor

(...content: UIRenderable[]): UICell

.style

UIStyle

Combined style set; when this is set to an instance of UIStyle, the individual style object properties (e.g. UIComponent.dimensions) are set to read-only objects taken from the UIStyle instance. To override individual properties, set these properties after setting style, or use Component.with to create a new constructor.

.isFocusable()

(): boolean

Returns true if this component can be focused directly using mouse or touch, or manually using UIComponent.requestFocus. This method may be overridden by derived component classes, but the value returned must always be the same.

.isKeyboardFocusable()

(): boolean

Returns true if this component can be focused using the keyboard or other methods; a true return value implies the same for UIComponent.isFocusable. This method may be overridden by derived component classes, but the value returned must always be the same.

.allowFocus

boolean

True if this cell itself may receive direct input focus using the mouse, touch, or using UIComponent.requestFocus (cannot be changed after rendering this component), defaults to false.

.allowKeyboardFocus

boolean

True if this cell itself may receive input focus using the keyboard and all other methods (cannot be changed after rendering this component), defaults to false.

.padding

UICellOffsets

Padding around contained elements (in dp or CSS string, or separate offset values, defaults to 0).

.margin

UICellOffsets

Margin around the entire cell (in dp or CSS string, or separate offset values, defaults to 0).

.background

string

Cell background (see UITheme.replaceColor), defaults to transparent.

.textColor

string

Text color (see UITheme.replaceColor), defaults to inherit to inherit the text color from a containing cell or background window.

.borderThickness

UICellOffsets

Border thickness (in dp or string with unit, or separate offset values, defaults to 0).

.borderColor

string

Border color (see UITheme.replaceColor).

.borderStyle

string

Border style (CSS), defaults to “solid”.

.borderRadius

string | number

Border radius (in dp or CSS string, defaults to 0).

.dropShadow

number

Intensity of drop shadow based on visual ‘elevation’ level (0-1, defaults to 0).

.css

Partial<CSSStyleDeclaration> & { className?: string; }

Other CSS attributes that are applied directly to the container, if supported (plain object).

Note: Changes to individual properties are not observed by the renderer.

.applyStyle() protected

(style: UIStyle): void

Inherited from UIContainer.applyStyle.

.applyLayout() protected

(layout: Partial<ContainerLayout>): void

Inherited from UIContainer.applyLayout.

.layout

ContainerLayout

Inherited from UIContainer.layout.

.separator

SeparatorOptions

Inherited from UIContainer.separator.

.asyncContentRendering

boolean

Inherited from UIContainer.asyncContentRendering.

.animatedContentRenderingDuration

number

Inherited from UIContainer.animatedContentRenderingDuration.

.animatedContentRenderingVelocity

number

Inherited from UIContainer.animatedContentRenderingVelocity.

.content

ManagedList<UIRenderable>

Inherited from UIContainer.content.

.propagateComponentEvent()

(name: string, inner?: ManagedEvent, event?: any): void

Inherited from UIComponent.propagateComponentEvent.

.render()

(callback: RenderCallback<Output<UIRenderable, any>>): void

Inherited from UIComponent.render.

.requestFocus()

(): void

Inherited from UIComponent.requestFocus.

.requestFocusNext()

(): void

Inherited from UIComponent.requestFocusNext.

.requestFocusPrevious()

(): void

Inherited from UIComponent.requestFocusPrevious.

.hidden

boolean

Inherited from UIComponent.hidden.

.dimensions

Dimensions

Inherited from UIComponent.dimensions.

.position

Position

Inherited from UIComponent.position.

.accessibleRole

string

Inherited from UIComponent.accessibleRole.

.accessibleLabel

string

Inherited from UIComponent.accessibleLabel.

.revealTransition

UITransitionType

Inherited from UIComponent.revealTransition.

.exitTransition

UITransitionType

Inherited from UIComponent.exitTransition.

.lastRenderOutput

Output<this, any>

Inherited from UIComponent.lastRenderOutput.

.isPresetComponent() protected

(): boolean

Inherited from Component.isPresetComponent.

.getParentComponent()

[1]. (): Component
[2]. <TParent extends Component>(ParentClass: ComponentConstructor<TParent>): TParent

Inherited from Component.getParentComponent.

.getCompositeParent()

<TParent extends Component>(ParentClass?: ComponentConstructor<TParent>): TParent

Inherited from Component.getCompositeParent.

.managedId

number

Inherited from ManagedObject.managedId.

.managedState

ManagedState

Inherited from ManagedObject.managedState.

.getReferenceCount() protected

(): number

Inherited from ManagedObject.getReferenceCount.

.getManagedReferrers() protected

(): ManagedObject[]

Inherited from ManagedObject.getManagedReferrers.

.getManagedParent() protected

[1]. (): ManagedObject
[2]. <TParent extends ManagedObject>(ParentClass: ManagedObjectConstructor<TParent>): TParent

Inherited from ManagedObject.getManagedParent.

.emit()

<TEvent extends ManagedEvent = ManagedEvent, TConstructorArgs extends any[] = any[]>(e: string | TEvent | (new (...args: TConstructorArgs) => TEvent), ...constructorArgs: TConstructorArgs): this

Inherited from ManagedObject.emit.

.propagateChildEvents() protected

[1]. (f?: (this: this, e: ManagedEvent, propertyName: string) => void | ManagedEvent | ManagedEvent[]): this
[2]. (...types: (ManagedEvent | (new (...args: any[]) => ManagedEvent))[]): this

Inherited from ManagedObject.propagateChildEvents.

.activateManagedAsync() protected

(): Promise<any>

Inherited from ManagedObject.activateManagedAsync.

.deactivateManagedAsync() protected

(): Promise<void>

Inherited from ManagedObject.deactivateManagedAsync.

.destroyManagedAsync() protected

(): Promise<void>

Inherited from ManagedObject.destroyManagedAsync.

.onManagedStateActivatingAsync() protected

(): Promise<void>

Inherited from ManagedObject.onManagedStateActivatingAsync.

.onManagedStateActiveAsync() protected

(): Promise<void>

Inherited from ManagedObject.onManagedStateActiveAsync.

.onManagedStateDeactivatingAsync() protected

(): Promise<void>

Inherited from ManagedObject.onManagedStateDeactivatingAsync.

.onManagedStateInactiveAsync() protected

(): Promise<void>

Inherited from ManagedObject.onManagedStateInactiveAsync.

.onManagedStateDestroyingAsync() protected

(): Promise<void>

Inherited from ManagedObject.onManagedStateDestroyingAsync.


UICell.Presets

extends UIContainer.Presets

UICell presets type, for use with Component.with.

.padding

UICellOffsets

Padding around contained elements (in dp or CSS string, defaults to 0).

.margin

UICellOffsets

Margin around the entire cell (in dp or CSS string, defaults to 0).

.background

string

Cell background (see UITheme.replaceColor).

.textColor

string

Text color (see UITheme.replaceColor), defaults to inherit to inherit the text color from a containing cell or background window.

.borderThickness

UICellOffsets

Border thickness (in dp or string with unit, defaults to 0).

.borderColor

string

Border color (see UITheme.replaceColor).

.borderStyle

string

Border style (CSS), defaults to “solid”.

.borderRadius

string | number

Corner radius (in dp or CSS string, defaults to 0).

.dropShadow

number

Size of drop shadow based on visual ‘elevation’ (0-1, defaults to 0).

.highlight

HighlightProperties

Visual highlights for focused/selected states.

.selectOnFocus

boolean

Set to true to select cells on focus (or click), implies allowFocus as well.

.allowFocus

boolean

Set to true to allow this cell itself to receive input focus using mouse, touch, or UIComponent.requestFocus.

.allowKeyboardFocus

boolean

Set to true to allow this cell itself to receive input focus using the keyboard as well as other methods; implies allowFocus.

.css

Partial<CSSStyleDeclaration> & { className?: string; }

Other CSS attributes that are applied directly to the container, if supported (plain object).

.content

Iterable<UIRenderable>

Inherited from UIContainer.Presets.content.

.layout

Partial<{}> | Partial<ContainerLayout>

Inherited from UIContainer.Presets.layout.

.separator

SeparatorOptions

Inherited from UIContainer.Presets.separator.

.asyncContentRendering

boolean

Inherited from UIContainer.Presets.asyncContentRendering.

.animatedContentRenderingDuration

number

Inherited from UIContainer.Presets.animatedContentRenderingDuration.

.animatedContentRenderingVelocity

number

Inherited from UIContainer.Presets.animatedContentRenderingVelocity.

.style

string | UIStyle

Inherited from UIComponent.Presets.style.

.hidden

boolean

Inherited from UIComponent.Presets.hidden.

.dimensions

Partial<{}> | Partial<Dimensions>

Inherited from UIComponent.Presets.dimensions.

.position

Partial<{}> | Partial<Position>

Inherited from UIComponent.Presets.position.

.accessibleRole

string

Inherited from UIComponent.Presets.accessibleRole.

.accessibleLabel

string

Inherited from UIComponent.Presets.accessibleLabel.

.requestFocus

boolean

Inherited from UIComponent.Presets.requestFocus.

.revealTransition

UITransitionType

Inherited from UIComponent.Presets.revealTransition.

.exitTransition

UITransitionType

Inherited from UIComponent.Presets.exitTransition.


UICell.HighlightProperties

UICell focus/select properties, for use with UICell.with.

.focusedBackground

string

Focused cell background.

.focusedTextColor

string

Focused cell text color.

.focusedBorderThickness

string | number

Focused cell border thickness (in dp or string with unit, defaults to 0).

.focusedBorderColor

string

Focused cell border color (see UITheme.replaceColor).

.focusedBorderStyle

string

Focused cell border style (CSS), defaults to “solid”.

.focusedDropShadow

number

Focused cell drop shadow size based on visual ‘elevation’ (0-1, defaults to 0).

.selectedBackground

string

Selected cell background.

.selectedTextColor

string

Selected cell text color.

.selectedBorderThickness

string | number

Selected cell border thickness (in dp or string with unit, defaults to 0).

.selectedBorderColor

string

Selected cell border color (see UITheme.replaceColor).

.selectedBorderStyle

string

Selected cell border style (CSS), defaults to “solid”.

.selectedDropShadow

number

Selected cell drop shadow size based on visual ‘elevation’ (0-1, defaults to 0).

.focusedSelectedBackground

string

Focused and selected cell background.

.focusedSelectedTextColor

string

Focused and selected cell text color.

.focusedSelectedBorderThickness

string | number

Focused and selected cell border thickness (in dp or string with unit, defaults to 0).

.focusedSelectedBorderColor

string

Focused and selected cell border color (see UITheme.replaceColor).

.focusedSelectedBorderStyle

string

Focused and selected cell border style (CSS), defaults to “solid”.

.focusedSelectedDropShadow

number

Focused and selected cell drop shadow size based on visual ‘elevation’ (0-1, defaults to 0).