Back to Website
Show / Hide Table of Contents

Checkbox

  • Less than a minute to read

A simple widget that adds a checkbox.

Selected checkbox widget.

General info

  • type: checkbox

Params

  • prompt - a text string displaying the checkbox caption.
  • value or _ - a checkbox value, whether it is checked or not (false if omitted).

Example

Let's assume you want to add a checkbox that should lock the FinishButton when it is not set. The config may appear as follows:

{
    "widgets": [
        {
            "name": "agree-checkbox",
            "type": "checkbox",
            "params": {
                "prompt": "I approve the design.",
                "value": true
            }
        },
        {
            "name": "finish-button",
            "type": "finish-button",
            "params": {
                "enabled": "{{$['agree-checkbox']._}}"
            }
        }

    ]
}

Now, when you select the checkbox, the Finish button gets enabled.

Cleared checkbox widget. Selected checkbox widget.

Was this page helpful?
Thanks for your feedback!
Back to top Copyright © 2001–2024 Aurigma, Inc. All rights reserved.
Loading...
    Thank for your vote
    Your opinion is important to us. To provide details, send feedback.
    Send feedback