Class Form<TModel, TElt, TSharer>

User input form.

A component shares form (e.g. using @SharedForm decorator) to make its accessible by component itself and nested ones. E.g. to add fields to it or submit it.

A form may be nested within another one, as it implements a Field interface.

The form instance is not usable until it is bound to its sharer component. The latter is done automatically when the form is shared by FormShare.

Type Parameters

TModel = any

A model type of the form, i.e. a type of its control value.
TElt extends HTMLElement = HTMLElement

A type of HTML form element.
TSharer extends object = any

Form sharer component type.

Hierarchy

FormUnit<TModel, Form.Body<TModel, TElt>, TSharer>
- Form
  - Whole

Index

Constructors

constructor

new Form<TModel, TElt, TSharer>(controls: Form.Controls<TModel, TElt> | Form.Provider<TModel, TElt, TSharer>): Form<TModel, TElt, TSharer>
Constructs form.
Type Parameters
- TModel = any
- TElt extends HTMLElement<TElt> = HTMLElement
- TSharer extends object = any
Parameters
- controls: Form.Controls<TModel, TElt> | Form.Provider<TModel, TElt, TSharer>
  
  Either form controls instance, or its provider.
Returns Form<TModel, TElt, TSharer>
Overrides FormUnit.constructor
- Defined in wesib/forms/src/form.ts:148

Accessors

body

get body(): TBody
Shareable body.

Accessing is throws an exception until bound to sharer.

Returns TBody
Inherited from FormUnit.body
- Defined in wesib/generic/dist/wesib-generic.d.ts:783

control

get control(): undefined | InControl<TValue>
Input control of the field, if present.

Returns undefined | InControl<TValue>
Inherited from FormUnit.control
- Defined in wesib/forms/src/form-unit.ts:34

element

get element(): undefined | InFormElement<TElt>
Form element control, if present.

Unlike input control this one is not supposed to be submitted, but rather contains a <form> element issuing a submit event.

Returns undefined | InFormElement<TElt>
- Defined in wesib/forms/src/form.ts:158

read

get read(): AfterEvent<[TBody]>
An AfterEvent keeper of shareable body.

An [AfterEvent__symbol] method always returns this value.

Returns AfterEvent<[TBody]>
Inherited from FormUnit.read
- Defined in wesib/generic/dist/wesib-generic.d.ts:766

sharer

get sharer(): ComponentContext<TSharer>
Sharer component context.

Accessing it throws an exception until bound to sharer.

Returns ComponentContext<TSharer>
Inherited from FormUnit.sharer
- Defined in wesib/generic/dist/wesib-generic.d.ts:760

`Static` [InAspect__symbol]

get [InAspect__symbol](): InAspect<null | Whole<any, HTMLElement, any>, "default">
An input control aspect representing a form this control belongs to.

This aspect is available in submittable form control and form element control.

Returns InAspect<null | Whole<any, HTMLElement, any>, "default">
- Defined in wesib/forms/src/form.ts:139

Methods

[AfterEvent__symbol]

[AfterEvent__symbol](): AfterEvent<[undefined | Form.Body<TModel, TElt, any>]>
Returns AfterEvent<[undefined | Form.Body<TModel, TElt, any>]>
Inherited from FormUnit.[AfterEvent__symbol]
- Defined in wesib/generic/dist/wesib-generic.d.ts:775

sharedBy

sharedBy(sharer: ComponentContext<TSharer>): void
Parameters
- sharer: ComponentContext<TSharer>
Returns void
Inherited from FormUnit.sharedBy
- Defined in wesib/forms/src/form-unit.ts:38

toString

toString(): string
Returns string
- Defined in wesib/forms/src/form.ts:162

`Static` by

by<TModel, TElt, TSharer>(factory: Factory<InControl<TModel>, TModel>, elementFactory: ((this: void, options: {
aspects?: Aspect<void, void>;
} & {
form: InControl<TModel>;
}) => InFormElement<TElt>)): Form<TModel, TElt, TSharer>
Creates a form instance by the given control factories.

Returns
New form instance.
Type Parameters
- TModel
- TElt extends HTMLElement<TElt> = HTMLElement
- TSharer extends object = any
Parameters
- factory: Factory<InControl<TModel>, TModel>
  
  Submittable form control factory.
- elementFactory: ((this: void, options: {
  aspects?: Aspect<void, void>;
  } & {
  form: InControl<TModel>;
  }) => InFormElement<TElt>)
  
  Form element control factory or options.
  - - (this: void, options: {
      aspects?: Aspect<void, void>;
      } & {
      form: InControl<TModel>;
      }): InFormElement<TElt>
    - Parameters
      
      this: void
      
      options: {
      aspects?: Aspect<void, void>;
      } & {
      form: InControl<TModel>;
      }
      
      Returns InFormElement<TElt>
Returns Form<TModel, TElt, TSharer>
- Defined in wesib/forms/src/form.ts:80

`Static` forElement

forElement<TModel, TElt>(control: InControl<TModel>, element: TElt, options?: Omit<Options, "form">): Form.Controls<TModel, TElt>
Builds a user input form for the given form control and HTML element.

Returns
New form instance.
Type Parameters
- TModel
- TElt extends HTMLElement<TElt>
Parameters
- control: InControl<TModel>
  
  Submitted control. Typically a container one.
- element: TElt
  
  HTML element to create control for.
- Optional options: Omit<Options, "form">
  
  Form element control options.
Returns Form.Controls<TModel, TElt>
- Defined in wesib/forms/src/form.ts:61

`Static` provider

provider<TBody, TSharer>(body: TBody | Provider<TBody, TSharer>): ((this: void, sharer: ComponentContext<TSharer>) => AfterEvent<[TBody]>)
Converts shareable body or its provider to provider that always returns an AfterEvent keeper of shareable body.

Returns
Shareable body provider.
Type Parameters
- TBody = unknown
  
  Shareable body type.
- TSharer extends object = any
  
  Sharer component type.
Parameters
- body: TBody | Provider<TBody, TSharer>
  
  Either shareable body, or its provider.
Returns ((this: void, sharer: ComponentContext<TSharer>) => AfterEvent<[TBody]>)
- - (this: void, sharer: ComponentContext<TSharer>): AfterEvent<[TBody]>
  - Converts shareable body or its provider to provider that always returns an AfterEvent keeper of shareable body.
    
    Returns
    Shareable body provider.
    Parameters
    - this: void
    - sharer: ComponentContext<TSharer>
    Returns AfterEvent<[TBody]>
Inherited from FormUnit.provider
- Defined in wesib/generic/dist/wesib-generic.d.ts:746

`Static` providerBy

providerBy<TModel, TElt, TSharer>(factory: Factory<InControl<TModel>, TModel>, elementFactory: ((this: void, options: {
aspects?: Aspect<void, void>;
} & {
form: InControl<TModel>;
}) => InFormElement<TElt>)): Form.Provider<TModel, TElt, TSharer>
Creates a form controls provider by the given control factories.

Returns
New form controls provider.
Type Parameters
- TModel
- TElt extends HTMLElement<TElt> = HTMLElement
- TSharer extends object = any
Parameters
- factory: Factory<InControl<TModel>, TModel>
  
  Submittable form control factory.
- elementFactory: ((this: void, options: {
  aspects?: Aspect<void, void>;
  } & {
  form: InControl<TModel>;
  }) => InFormElement<TElt>)
  
  Form element control factory or options.
  - - (this: void, options: {
      aspects?: Aspect<void, void>;
      } & {
      form: InControl<TModel>;
      }): InFormElement<TElt>
    - Parameters
      
      this: void
      
      options: {
      aspects?: Aspect<void, void>;
      } & {
      form: InControl<TModel>;
      }
      
      Returns InFormElement<TElt>
Returns Form.Provider<TModel, TElt, TSharer>
- Defined in wesib/forms/src/form.ts:100

Class Form<TModel, TElt, TSharer>

Type Parameters

TModel = any

TElt extends HTMLElement = HTMLElement

TSharer extends object = any

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

TModel = any

TElt extends HTMLElement<TElt> = HTMLElement

TSharer extends object = any

Parameters

controls: Form.Controls<TModel, TElt> | Form.Provider<TModel, TElt, TSharer>

Returns Form<TModel, TElt, TSharer>

Accessors

body

Returns TBody

control

Returns undefined | InControl<TValue>

element

Returns undefined | InFormElement<TElt>

read

Returns AfterEvent<[TBody]>

sharer

Returns ComponentContext<TSharer>

Static [InAspect__symbol]

Returns InAspect<null | Whole<any, HTMLElement, any>, "default">

Methods

[AfterEvent__symbol]

Returns AfterEvent<[undefined | Form.Body<TModel, TElt, any>]>

sharedBy

Parameters

sharer: ComponentContext<TSharer>

Returns void

toString

Returns string

Static by

Returns

Type Parameters

TModel

TElt extends HTMLElement<TElt> = HTMLElement

TSharer extends object = any

Parameters

factory: Factory<InControl<TModel>, TModel>

elementFactory: ((this: void, options: { aspects?: Aspect<void, void>; } & { form: InControl<TModel>; }) => InFormElement<TElt>)

Parameters

this: void

options: { aspects?: Aspect<void, void>; } & { form: InControl<TModel>; }

Returns InFormElement<TElt>

Returns Form<TModel, TElt, TSharer>

Static forElement

Returns

Type Parameters

TModel

TElt extends HTMLElement<TElt>

Parameters

control: InControl<TModel>

element: TElt

Optional options: Omit<Options, "form">

Returns Form.Controls<TModel, TElt>

Static provider

Returns

Type Parameters

TBody = unknown

TSharer extends object = any

Parameters

body: TBody | Provider<TBody, TSharer>

Returns ((this: void, sharer: ComponentContext<TSharer>) => AfterEvent<[TBody]>)

Returns

Parameters

this: void

sharer: ComponentContext<TSharer>

Returns AfterEvent<[TBody]>

Static providerBy

Returns

`Static` [InAspect__symbol]

`Static` by

elementFactory: ((this: void, options: {
aspects?: Aspect<void, void>;
} & {
form: InControl<TModel>;
}) => InFormElement<TElt>)

options: {
aspects?: Aspect<void, void>;
} & {
form: InControl<TModel>;
}

`Static` forElement

`Optional` options: Omit<Options, "form">

`Static` provider

`Static` providerBy

elementFactory: ((this: void, options: {
aspects?: Aspect<void, void>;
} & {
form: InControl<TModel>;
}) => InFormElement<TElt>)

options: {
aspects?: Aspect<void, void>;
} & {
form: InControl<TModel>;
}