UIForm

class UIForm

extends UICell

Represents a UI component that groups form controls and other content in a cell.

Note: This component is optional and has the same effect as UIFormContextController which does not render its own cell.

Constructor

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

.find() static

(component: Component): UIFormContextController | UIForm

Returns the closest parent form (or form context controller, see UIFormContextController) for given component; can be used by input components to find and observe the form context component before rendering.

Does not return components beyond the scope of the current AppActivity parent.

.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.

.accessibleRole

string

WAI-ARIA role for this component, if applicable.

.formContext

ManagedObject

Form state context; defaults to an empty managed record.

.isFocusable()

(): boolean

Inherited from UICell.isFocusable.

.isKeyboardFocusable()

(): boolean

Inherited from UICell.isKeyboardFocusable.

.allowFocus

boolean

Inherited from UICell.allowFocus.

.allowKeyboardFocus

boolean

Inherited from UICell.allowKeyboardFocus.

.padding

Offsets

Inherited from UICell.padding.

.margin

Offsets

Inherited from UICell.margin.

.background

Stringable

Inherited from UICell.background.

.textColor

Stringable

Inherited from UICell.textColor.

.borderThickness

Offsets

Inherited from UICell.borderThickness.

.borderColor

Stringable

Inherited from UICell.borderColor.

.borderStyle

string

Inherited from UICell.borderStyle.

.borderRadius

string | number

Inherited from UICell.borderRadius.

.dropShadow

number

Inherited from UICell.dropShadow.

.css

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

Inherited from UICell.css.

.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.

.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.


UIForm.Presets

extends UICell.Presets

UIForm presets type, for use with Component.with.

.formContext

ManagedRecord

Form state object; must be a (binding to a) managed record, see ManagedRecord.

.onFormContextChange

ComponentEventHandler<UIForm, ComponentEvent>

Event handler for any change to the form state.

.onSubmit

ComponentEventHandler<UIForm, ComponentEvent>

Event handler for form submissions.

.padding

Offsets

Inherited from UICell.Presets.padding.

.margin

Offsets

Inherited from UICell.Presets.margin.

.background

Stringable

Inherited from UICell.Presets.background.

.textColor

Stringable

Inherited from UICell.Presets.textColor.

.borderThickness

Offsets

Inherited from UICell.Presets.borderThickness.

.borderColor

Stringable

Inherited from UICell.Presets.borderColor.

.borderStyle

string

Inherited from UICell.Presets.borderStyle.

.borderRadius

string | number

Inherited from UICell.Presets.borderRadius.

.dropShadow

number

Inherited from UICell.Presets.dropShadow.

.highlight

HighlightProperties

Inherited from UICell.Presets.highlight.

.selectOnFocus

boolean

Inherited from UICell.Presets.selectOnFocus.

.allowFocus

boolean

Inherited from UICell.Presets.allowFocus.

.allowKeyboardFocus

boolean

Inherited from UICell.Presets.allowKeyboardFocus.

.css

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

Inherited from UICell.Presets.css.

.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.