@makeform/common v2.0.1

@makeform/common

Base block implementing common features of a widget.

Supported Meta

@makeform/common provides ld selectors and default DOMs for rendering following meta fields:

• title: field title.
• desc: description of this field.
• isRequired: true if this field is required.

Supported Configs

@makeform/common provides ld selectors and default DOMs for rendering following config fields:

• note: a list of string showing additional note about this field.
• limitation: a string shown as the main requirement of this field.
• display: either inline or block. The main difference of these display is:
  • inline: consider the widget as to be used inline, without header.
    • widget may be shown as block style element in CSS, so user should wrap widget properly.
  • block: header is shown.

ld selectors

As mentioned above, a child block can use following ld selectors to build its own DOM:

• base: node with form-group class.
• limitation: node displaying limitation
• note: iterable node displaying widget note.
• is-required: show when value of this widget is required.
• label: display widget title
• desc: display widget description
• variant: display widget variant
• display: this node will be hidden if display mode is different from data-display value.
• error: iterable node displaying widget errros.
• error-root: node containing error information.
  • by default @makeform/common use @loadingio/bootstrap.ext tips to show tips. if error-root contains has-tips class, manual will be toggled based on widget status automatically.

interface

@makeform/common provides additional members for child block to access, which are created by @makeform/common:

• info
  • meta: the meta object
  • config: the config object
  • display: display mode, either inline of block. when omitted, default to block.
  • view: ldview object created by @makeform/common.
• child
  • preserved for child block to use

default classes

Following are classes used by @makeform/common and all blocks inheriting @makeform/common. While you can build the exactly same logic or design conventions with different class names by your own, following these conventions makes it easier to customize your blocks along with the default blocks in headless manner.

• functional classes:
  • m-view: for nodes that should only be shown in view mode.
  • m-edit: for nodes that should only be shown in view mode.
• style classes:
  • mf-note: decorator for note nodes.

License

MIT