Form

form:before:create#

Hook emitted before form create.

Type: hook (handler may return a value).

Payload:

  • form — Form instance
  • name — form name string
  • params — form constructor params

Example:

app.on('form:before:create', ({ name, params }) => {
  if (name === 'image') params.width = '320px';
});

form:create#

Emitted when a form instance is created.

Type: signal.

Payload:

  • form — Form instance
  • name — form name string
  • params — form constructor params

Example:

app.on('form:create', ({ form, name }) => {
  if (name === 'blockBorder') form.focus('width');
});

form:data#

Emitted when form data changes.

Type: signal.

Payload:

  • form — Form instance
  • name — form name string
  • data — current form data object

Example:

app.on('form:data', ({ name, data }) => {
  if (name === 'image') previewUrl(data.url);
});

form:focus#

Emitted when a form field receives focus.

Type: signal.

Payload:

  • form — Form instance
  • name — form name string
  • field — focused field name or null

Example:

app.on('form:focus', ({ name, field }) => {
  console.log(`Form ${name}, field ${field}`);
});

form:setter#

Emitted after a form setter command runs.

Type: signal.

Payload:

  • form — Form instance
  • name — form name string
  • setter — setter command string
  • data — applied values

Example:

app.on('form:setter', ({ name, data }) => {
  if (name === 'blockSpacing') auditPaddingChange(data);
});

form:setter:before#

Emitted during form setter (setter:before).

Type: hook (handler may return a value).

Payload:

  • form — Form instance
  • name — form name string
  • setter — setter command string
  • data — values about to be applied

Example:

app.on('form:setter:before', ({ data }) => {
  if (data.width === '') data.width = '0';
});