Skip to main content

PaneConfigDto

Pane configuration with sections and buttons

idstringrequired

Unique identifier for the pane

Example: pane-parties
namestringrequired

Display name of the pane

Possible values: <= 255 characters

Example: Parties
sequenceinteger<int32>required

Display order of the pane

Possible values: >= 1

Example: 1
sections object[]required

Array of section configurations within the pane

Possible values: >= 1, <= 2147483647

  • Array [
  • idstringrequired

    Unique identifier for the section

    Example: section-applicant
    namestringrequired

    Display name of the section

    Possible values: <= 255 characters

    Example: Applicant Details
    sequenceinteger<int32>required

    Display order of the section within the pane

    Possible values: >= 1

    Example: 1
    rowsinteger<int32>required

    Number of grid rows in the section

    Possible values: >= 1 and <= 20

    Example: 1
    columnsinteger<int32>required

    Number of grid columns in the section

    Possible values: >= 1 and <= 12

    Example: 1
    isRepeatableboolean

    Whether the section can be repeated (for variable-length data)

    Example: false
    groupIdstringnullable

    Group identifier for repeatable sections

    Example: group-beneficiaries
  • ]
  • buttons object[]

    Array of button configurations for the pane

  • Array [
  • idstringrequired

    Unique identifier for the button

    Example: btn-next
    labelstringrequired

    Display label of the button

    Possible values: <= 50 characters

    Example: Next
    positionstringrequired

    Position of the button (left or right)

    Possible values: [left, right]

    Example: right
    variantstringrequired

    Visual variant of the button

    Possible values: [default, secondary, outline, destructive, ghost]

    Example: default
    actionstringrequired

    Action to perform when button is clicked

    Possible values: [next_pane, previous_pane, save_draft, save_template, submit, reject, discard, close, custom]

    Example: next_pane
    targetPaneIdstringnullable

    Target pane ID for custom navigation (when action is 'custom')

    Example: pane-documents
    isVisiblebooleanrequired

    Whether the button is visible

    Example: true
    orderinteger<int32>required

    Display order of the button

    Possible values: >= 1

    Example: 1
  • ]
  • showSwiftPreviewboolean

    Whether to show SWIFT preview for this pane

    Example: false
    PaneConfigDto
    {
    "id": "pane-parties",
    "name": "Parties",
    "sequence": 1,
    "sections": [
    {
    "id": "section-applicant",
    "name": "Applicant Details",
    "sequence": 1,
    "rows": 1,
    "columns": 1,
    "isRepeatable": false,
    "groupId": "group-beneficiaries"
    }
    ],
    "buttons": [
    {
    "id": "btn-next",
    "label": "Next",
    "position": "right",
    "variant": "default",
    "action": "next_pane",
    "targetPaneId": "pane-documents",
    "isVisible": true,
    "order": 1
    }
    ],
    "showSwiftPreview": false
    }