Skip to main content

Variable block

Use the variable block to store different types of values (text, number, date, boolean) and use those values inside forms.

info

This is a headless block. It doesn't require a UI implementation in the runner. See the runner section for instructions on how to use the block in a runner.

📺 Preview​

📽️ Demo​

Run Try on CodePen

📦 Package contents​

🏗️ Builder part​

The builder part instructs the builder how to manage the block. It defines the configurable properties and settings for the block, which can then be managed with the visual builder. This package contains:

  • Classes:
    • Variable: Variable headless block;
    • VariableBooleanCondition: Variable condition block to verify a boolean variable;
    • VariableDateCondition: Variable condition block to verify a date variable;
    • VariableNumericCondition: Variable condition block to verify a numeric variable;
    • VariableTextCondition: Variable condition block to verify a text variable;
  • TypeScript typings (should work out-of-the-box);
  • Translations (located in the ./translations folder of the package).

🏃 Runner part​

The runner part of this headless block contains all the code to use the block in a runner (the thing that runs the form). This package contains:

  • Classes:
    • Variable: Base class for implementing the variable block in a runner;
    • VariableBooleanCondition: Runner part of the variable condition block for booleans;
    • VariableDateCondition: Runner part of the variable condition block for dates;
    • VariableNumericCondition: Runner part of the variable condition block for numerics;
    • VariableTextCondition: Runner part of the variable condition block for texts;
  • TypeScript typings (should work out-of-the-box).

👩‍💻 Usage​

✨ Installation​

npm install @tripetto/block-variable
Typescript support

This package contains type declarations and supports TypeScript out-of-the-box.

🏗️ Builder part​

ESM/ES5​

Importing the block is all you need to do to self-register the block to the builder (see the builder plain JS implementation for an example or the Block loading guide for more information about loading blocks).

import "@tripetto/block-variable";

// The code above imports the ES5 or ESM version based on your project configuration.
// If you want to use the ES5 version, you can do an explicit import:
import "@tripetto/block-variable/es5";

CDN​

You can also use the builder part directly in a browser using a CDN (see the builder HTML implementation for more information).

<html>
  <body>
    <script src="https://cdn.jsdelivr.net/npm/@tripetto/builder"></script>
    <script src="https://cdn.jsdelivr.net/npm/@tripetto/block-variable"></script>
    <script>
      Tripetto.Builder.open();
    </script>
  </body>
</html>

Translations​

The available translation for the block are located in the translations folder of the package.

tip

See the Loading a translation for a stock block guide to learn how to load the block translation into the builder.

🏃 Runner part​

Since this is a headless block, the runner part contains everything you need to use this block in a runner (the thing that runs the form). You only need to import the block somewhere in your runner project, and you are good to go:

import "@tripetto/block-variable/runner";

// The code above imports the ES5 or ESM version based on your project configuration.
// If you want to use the ES5 version, you can do an explicit import:
import "@tripetto/block-variable/runner/es5";

🎭 Stock runners​

This block is included in the following stock runners:

tip

If you are integrating the builder together with one of the stock runners, you can use the builder block bundle that is included in the stock runner packages to load the builder part of all the blocks with a single import. See the Import block bundles guide for more information.

🚢 Distribution ​

This block is distributed through npm:

▶️ https://www.npmjs.com/package/@tripetto/block-variable

📁 Source code ​

This block is open-source and the code is on GitLab:

▶️ https://gitlab.com/tripetto/blocks/variable