Nested Fields

Specs

Label	Value
Version	1.2.0 (updated on 2025-01-10)
Developer	Labii Inc.
Type	Column
Support Configuration	Yes
Support Readonly view	Yes
Support Edit view	Yes
Support Form view	Yes
Support Default value	Yes
Support Import	Yes
Allow multiple	Yes

Overview

Labii’s Nested Fields feature allows users to track and manage multiple related items using custom-defined fields, providing flexibility and precision in data organization. With Nested Fields, you can define a list of items and associate specific attributes with each item, such as tracking the number of books ordered by setting up fields for “Book” and “Number Ordered.” This feature streamlines complex data tracking needs by enabling users to store detailed, hierarchical information directly within the application.

Use case

1. Use this widget to record different social accounts with their id for contact.
2. Use this widget to track the products and quantity ordered
3. Use this widget to display specific IDs with certain components

Configuration

The widget will function without additional setup, but you have the option to utilize the configuration to customize the button.

• Schema - The schema of nested fields. Use the properties from https://react-jsonschema-form.readthedocs.io/en/latest/. Use 'order' to sort the fields inside the properties.
  • To handle a list of items: Set type=array
  • To handle a single item: Set type=object
• Display - How to display the nested fields.
  • Key-Value by comma
  • Key-Value by linebreak
  • Value by comma
  • Value by linebreak
  • Value by dash
  • Value by nothing

Examples:

{
    "schema": { # use the propterties from https://react-jsonschema-form.readthedocs.io/en/latest/
      "properties": { # (required)
        "book": {
          "type": "string",
          "title": "Book",
          "description": "Select a book.",
          "enum": ["Book 1", "Book 2"],
          "enumNames": ["Book 1", "Book 2"],
          "widget": "MaterialFormSelect",
          "default": "Book 1",
          "order": 1
        },
        "quantity": {
          "type": "number",
          "title": "Quantity",
          "description": "The quantity book to order.",
          "widget": "MaterialFormNumber",
          "min": 1,
          "default": 1,
          "order": 2
        }
      },
      "minItems": 1, # number of nested fields to load on default
      "items": [], # (optional), if provided, it will overwrite the properties
      "required": [
        "test",
        "quantity"
      ]
    }
}

Views

See the interface of the widget in the following views.

Readonly view

Readonly view display the values of the column.

Edit view

The Edit view is the interface that allows you to modify the value.

Form view

The Form view is the field integrated into the add form for collecting values when creating a new record.

The form view is the same as the Edit view.

Data

Each widget in Labii stores data in a unique manner; refer below to understand how data from this widget is stored.

Data format

JSON

{
    "field_1": "xxx",
    "field_2": "xxx"
}

Default value

The Default Value field within the column allows you to specify the default value when a record is created.

Default value shall be the JSON

Import value

The Import Value is the value you need to include in your Excel table for it to be imported into Labii.

Import value shall be the JSON