Configuration Blocks

Configuration Blocks have many purposes;

  • Attribute library configuration

  • Callback handlers

  • Special functionality, like Trigger or Action definitions

Usage Notes

All SA configuration blocks are HTML <script>elements with a specific structure.

Here's an example;

<script type="application/sa+json" handler="handler-name" name="my-name">
{
  "@context": "https://attr.sygnal.com",
  "@version": "0.1",
  ...
}
</script>

In the SA5 documentation, configuration blocks will be presented for you to easily copy, paste, and edit in your Webflow project.

Explore the full details of Sygnal's configuration block specification.

Configuration Script Attributes

The script tag supports has 3 defined attributes;

Attribute
Required?
Value
Notes

type

Required

application/sa+json

handler

Required

The handler's name

See the module documention for details.

name

Varies, depending on the handler

The specific name of the configuration block, which is library-dependent.

Configuration Block Metadata

Currently, SA configuration blocks are always JSON, as identified in the MIME type. In the future, we'll be expanding to support other formats.

Key
Value

@context

https://attr.sygnal.com

@version

0.1

Indicates the version of the configuration block being used. Specific modules may increment this.

Configuration Block Contents

The JSON content used depends on the handler type.

See the module documentation for details.

Last updated

Was this helpful?