UIForm

class UIForm

extends UIRenderableController

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

Note: This component encapsulates content in a UICell component. To set a form context binding without grouping content, use UIFormContextController.

Constructor

(content?: UIRenderable): UIForm

.formContext

UIFormContext<any>

Form state context; should be bound to a UIFormContext component.

.renderContext

UIRenderContext

Inherited from UIRenderableController.renderContext.

.content

TContent

Inherited from UIRenderableController.content.

.delegateEvent() protected

(e: ManagedEvent, propertyName: string): true

Inherited from UIRenderableController.delegateEvent.

.render()

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

Inherited from UIRenderableController.render.

.isPresetComponent() protected

(): boolean

Inherited from Component.isPresetComponent.

.getParentComponent()

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

Inherited from Component.getParentComponent.

.getBoundParentComponent()

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

Inherited from Component.getBoundParentComponent.

.emitAction()

(name: string, inner?: ManagedEvent, context?: ManagedObject): void

Inherited from Component.emitAction.

.propagateComponentEvent() deprecated

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

Inherited from Component.propagateComponentEvent.

.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

<TParent extends ManagedObject = 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.

.emitChange()

(name?: string): void

Inherited from ManagedObject.emitChange.

.propagateChildEvents() protected deprecated

(...types: ((new (...args: any[]) => ManagedEvent) | ((e: ManagedEvent) => any))[]): 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 context; should be bound to a UIFormContext component. If not set, automatically binds to a ‘formContext’ property on the bound parent component.

.onSubmit

ComponentEventHandler<UIForm, ComponentEvent<Component>>

Event handler for form submissions.

.decoration

Decoration

Inherited from UICell.Presets.decoration.

.padding

Offsets

Inherited from UICell.Presets.padding.

.margin

Offsets

Inherited from UICell.Presets.margin.

.background

string | UIColor

Inherited from UICell.Presets.background.

.textColor

string | UIColor

Inherited from UICell.Presets.textColor.

.borderThickness

Offsets

Inherited from UICell.Presets.borderThickness.

.borderColor

string | UIColor

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.

.opacity

number

Inherited from UICell.Presets.opacity.

.selectOnFocus

boolean

Inherited from UICell.Presets.selectOnFocus.

.allowFocus

boolean

Inherited from UICell.Presets.allowFocus.

.allowKeyboardFocus

boolean

Inherited from UICell.Presets.allowKeyboardFocus.

.revealTransition

string

Inherited from UICell.Presets.revealTransition.

.exitTransition

string

Inherited from UICell.Presets.exitTransition.

.css

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

Inherited from UICell.Presets.css.

.content

Iterable<UIRenderable>

Inherited from UIContainer.Presets.content.

.layout

Partial<{} | ContainerLayout>

Inherited from UIContainer.Presets.layout.

.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<{} | Dimensions>

Inherited from UIComponent.Presets.dimensions.

.position

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.