# Dynamic URLs 🧪

{% hint style="info" %}
**CONCEPTUAL** \
Feature under consideration. 
{% endhint %}

## Goals 

Conceptually SA5's Dynamic URLs would work similiarly to [Dynamic Attributes](/sa5-html/sa5-dynamic-attributes.md). However rather than overwriting an attribute's value completely, it would be contextually aware of urls and support the modification of the primary URL on an element by using custom attributes. 

* Add or replace a querystring param on URL-supporting elements
* Add or replate a hash value 

Future goals ( possible ); 

* Remove a querystring param 
* Transform a querystring param 
* Prepend/append static or CMS content to a param 
  * Compose a param from multiple pieces, both static and CMS sourced 
* Support certain path mods ( must distinguish absolute v. relative v. rooted URLs )   
  * Hostname
  * Protocol
  * etc. 

### Use Cases

* Navigate from a Collection List item or Collection List page to another page, carrying key CMS content for;
  * Context 
  * Form filling in hidden fields 
  * Finsweet filter initialization, from querystring 
* Customize IFRAME urls so that the hosted content is CMS-item-specific 
* Component-driven URL and IFRAME customizations  

### Supported Elements & Attributes 

[Certain elements](/sa5-html/dynamic-urls/future.md) have a primary attribute which specifies a URL. The name of that attribute varies depending on the element, so to manage this we'll detect and support specific element types. 

Initially, these are the ones we're focused on; 

* A href  
* IFRAME src  

{% hint style="info" %}
[Other element types](/sa5-html/dynamic-urls/future.md) may be supported in the future. 
{% endhint %}

### Related Concepts

* Externally trackable links. GTM, Posthog, etc. 
* Internally trackable links
  * Capture link click
  * Store in sessionStorage   
  * Feed into forms  

## Usage Notes

Here's the conceptual attribute protocol, mirrored from `x:` as used in Dynamic Attributes. 

### Query string changes

Query string changes  

|               |   |        |
| ------------- | - | ------ |
| `uq:*`        |   |        |
| `uq:*:pre`    |   |        |
| `uq:*:post`   |   |        |
| `uq:*:remove` |   | Future |

### Hash changes 

| Attribute    | Description                   | Notes  |
| ------------ | ----------------------------- | ------ |
| `uh:*`       | Set the `#hash` of the URL    |        |
| `uh::remove` | Remove the `#hash` of the URL | Future |

### URL changes 

URL attribute changes can be applied directly using existing Dynamic Attributes functionality. 

| Attribute    | Description          | Notes |
| ------------ | -------------------- | ----- |
| `x:src`      | Set the URL path     |       |
| `x:src:pre`  | Prefix the URL path  |       |
| `x:src:post` | Postfix the URL path |       |

Webflow's custom attributes feature has a powerful data-binding capability that supports binding to CMS fields and component properties- but there are several key limitations; 

1. **Reserved attributes.** many important attribute names are reserved to protect novice web designers. See the notes section below for a list.  
2. **ECommerce.**  Collection pages and collection lists that are bound to ECommerce Product and Categories do not support attribute data binding. 

**SA5's Dynamic Attributes** feature overcomes this by allowing you to create proxy attributes that are then applied to the page once the page has loaded. 

## Use Cases

This is a more technical feature, but it has an incredible range of uses. Here are a few;

* Forms
  * Initialize form field values on INPUTs, TEXTAREAs, SELECTs, CHECKBOXes and other elements with data from a CMS collection item or component property.  
    * e.g. Use `x:value` = ( your value ) to initialize an INPUT, TEXTBOX, or SELECT element from a CMS collection item.     
    * e.g. Use `x:checked` = ( boolean value ) to initialize a checkbox element. 
  * Special field configuration 
    * e.g. Use `x:type` = `date` on an INPUT element to change it to a date type 
  * Set hidden form fields to capture data silently, such as the Collection page you're on when the form is submitted.  
* Element behavior
  * Such as onclick 
* Supporting other SA5 libraries, such as CMS Lightbox Captions and Groups 
  * And making these work with ECommerce content     

{% hint style="warning" %}
As of 2024-Jun-03, Webflow does not yet support attribute binding to switch ( boolean ) field types or to select ( option ) field types. In a pinch you could use CMS text fields instead. 
{% endhint %}

## How it Works <a href="#usage-notes" id="usage-notes"></a>

SA5 Dynamic Attributes can be applied in two ways.

1. **Custom Attributes.** Any attribute created with an `x:` prefix on the name is specially recognized as an SA5 Dynamic Attribute.  It will be processed, and the un-prefixed attribute will then be set to that value. \
   e.g. A custom attribute named `x:value` would override the `value` attribute.&#x20;
2. **Custom Embeds.** Webflow's embed element can be used to contain a special `<script>` element, which will be processed and then apply the attribute value to the specified element. As an embed, this is more compatible with ECommerce data-binding.&#x20;

## Getting Started <a href="#getting-started-nocode" id="getting-started-nocode"></a>

### STEP 1 - Add the Library <a href="#step-1---add-the-library" id="step-1---add-the-library"></a>

First, **add the library** as detailed in [Quick Start](/sa5-html/quick-start.md).&#x20;

### STEP 2 - Apply `x:` prefixed custom attributes to any elements <a href="#step-2---apply-wfu-sort-and-configuration-attributes-to-the-elements-you-want-to-filter" id="step-2---apply-wfu-sort-and-configuration-attributes-to-the-elements-you-want-to-filter"></a>

These will overwrite existing attributes on that element.\
e.g. `x:onclick` will be applied as `onclick` on that same element.&#x20;

Data-bind the value where to CMS fields or component properties where it makes sense.  &#x20;

{% hint style="warning" %}
In previous versions, SA5 also supported dynamic attribute prefixes of `x-` however we've moved away from that to avoid conflict with Alpine.js which also uses the `x-` prefix on attributes. Currently this is still supported but considered obsolete.&#x20;
{% endhint %}

### STEP 3 - Create Embeds where custom attributes cannot work&#x20;

SA5 Dynamic Attributes use a special embed `<script>` structure containing a JSON chunk that specifies the target element ( relative to the Embed ), the name of the attribute to set, and the value of that element.&#x20;

In this example, the `style` attribute would be created on the parent element containing the Embed, and would be set to a value of `font-weight: bold;`. &#x20;

```html
<script type="application/sa5+json" handler="DynamicAttribute">
{
  "@context": "https://attr.sygnal.com",
  "@type": "DynamicAttribute",
  "@version": "0.1",
  "name": "style", 
  "target": "parent", 
  "value": "font-weight: bold;"    
}
</script>
```

See the usage notes for specific details and advanced use.

## Usage Notes <a href="#usage-notes" id="usage-notes"></a>

### `x:*` attributes <a href="#wfu-sort-attribute" id="wfu-sort-attribute"></a>

Create a custom attribute beginning with `x:` on any element in your page.  Set the value you want, and bind it to a CMS field or component property if you want.&#x20;

### `x:*:pre` attributes <a href="#wfu-sort-attribute" id="wfu-sort-attribute"></a>

Attributes that are also suffixed with `:pre` are prepended to the attribute value.&#x20;

### `x:*:post` attributes <a href="#wfu-sort-attribute" id="wfu-sort-attribute"></a>

Attributes that are also suffixed with `:post` are appended to the attribute value. &#x20;

### Embeds&#x20;

SA5's embed feature has the same capabilities, defined in a JSON chunk.&#x20;

It must be placed in an Embed, and positioned relative to the element you want the attribute to be applied to, either as a child or as an adjacent sibling.&#x20;

Here's an example;&#x20;

```html
<script type="application/sa5+json" handler="DynamicUrl">
{
  "@context": "https://attr.sygnal.com",
  "@type": "DynamicUrl",
  "@version": "0.1",
  "name": "style", 
  "target": "parent", 
  "value": "", 
  "pre": "",
  "post": ""  
}
</script>
```

Notes;&#x20;

* Both the script `type` and `handler` are essential&#x20;
* `target` can be `parent`, `prev`, or `next`, and identifies the element that the attribute will be applied to&#x20;
* `name` indicates the name of the attribute to create or replace&#x20;
* `value` ( opional ) indicates the value to set&#x20;
* `pre` ( opional ) prefixes the existing or replaced value&#x20;
* `post` ( opional ) suffixes the existing or replaced value &#x20;

<https://discourse.webflow.com/t/how-to-make-html-embed-cover-full-button/193848/3>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://attr.sygnal.com/sa5-html/dynamic-urls.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.