Galleon Attributes ⚓

A simple yet powerful tool for Webflow Pirates to create dynamic content using data attributes.

🚧 Galleon Attributes is currently in beta. 🚧

Ahoy there! Welcome aboard! 🏴‍☠️

Galleon Attributes helps you create dynamic, data-driven websites without sailing into the treacherous waters of complex code. Made for Webflow, but works with any tool that supports data attributes.

The Treasure This Tool Provides 💎

Set Sail ⛵ (Quick Start)

Add the Galleon Script

Add the following to your Webflow project’s Site Settings > Custom Code > Head Code:

<script
  async
  src="https://cdn.jsdelivr.net/npm/@raae/galleon-attributes@1/dist/script.js"
></script>

Screenshot of adding the script into Site Settings > Custom Code > Head Code

Test Galleon Attributes

Start by using our test APIs to get the hang of it.

💡 [Tip] If you use Outseta, jump to the Test Galleon Attributes with Outseta section.

Test API: Queen Raae Info 👑

  1. Select a container element to hold the data

    ➕ Add attribute gl-get with value https://galleon.tools/v1/queen.
    ✨ It will fetch the data from the url and make it available to the element and its children.

    Screenshot of adding the attribute called "gl-get" with the value of the test API endpoint

  2. Select a multiline text child of the container element

    ➕ Add attribute gl-bind with value name.
    ✨ It will bind the text content of the element to the bio property of the response.

    Screenhsot of adding the attribute named "gl-bind" with the value "bio"

  3. Select an image child of the container element

    ➕ Add attribute gl-bind-src with value avatar.url.
    ✨ It will bind the src attribute of the element to the avatar.url property of the response.

    ➕ Add attribute gl-bind-alt with value avatar.alt.
    ✨ It will bind the alt attribute of the element to the avatar.alt property of the response.

    Screenhsot of adding the attributes named "gl-bind-src" and "gl-bind-alt"

  4. Select a link child of the container element

    ➕ Add attribute gl-iterate with value socials.
    ✨ It will iterate over the socials property of the response and create a copy of the element for each item.

    ➕ Add attribute gl-bind-href with value url.
    ✨ It will bind the href attribute of the element to the url property of the socials item response.

    ➕ Add attribute gl-bind with value label.
    ✨ It will bind set the text content of the element to the label property of the socials item response.

    Screenshot of adding the attributes named "gl-iterate", "gl-bind-href" and "gl-bind"

  5. Publish your changes and see the magic happen!

    Screenshot of the final result

Test Galleon Attributes with Outseta

Prerequisites

Test API: Outseta User Info 🔑

  1. Select a container element to hold the data

    ➕ Add attribute gl-get with value https://galleon.tools/v1/outseta/me.
    ➕ Add attribute gl-auth-token with value Outseta.getAccessToken(), query:access_token.
    ✨ It will fetch the data from the url and make it available to the element and its children.

    💡 The test API endpoint galleon.tools/v1/outseta/me verifies the access token and creates a personalized greeting and summary of the user’s data.

    Screenshot of adding the attributes named "gl-get" and "gl-auth-token"

  2. Select a text child of the container element

    ➕ Add attribute gl-bind with value greeting.
    ✨ It will bind the text content of the element to the personalized greeting property of the response.

    Screenshot of adding the attribute named "gl-bind" with the value "greeting"

  3. Select a multiline text child of the container element

    ➕ Add attribute gl-bind-html with value summary.
    ✨ It will bind the html content of the element to the personalized summary property of the response.

    Screenshot of adding the attribute named "gl-bind-html" with the value "summary"

  4. Publish your changes and see the magic happen!

    Screenshot of the final result

💡 [Tip] Not the most exciting user info, but you can use this approach to fetch data from any API that expects the Outseta access token, such as a custom API from your backend devs. Or use a similar approach to fetch data from any other API that requires authentication, see the Authorization section for more details.

Treasure Map (User Guide)

Coming…

The Attributes

AttributePurposeExample
gl-getFetches JSON data from an endpoint<div gl-get="/api/data.json">
gl-bindBinds element’s text content to a data property<h1 gl-bind="title">Title</h1>
gl-bind-[attr]Binds specific attributes to data properties<img gl-bind-src="image.url">
gl-bind-htmlBinds element’s inner html content to a data property<div gl-bind-html="content">
gl-iterateIterates through array items<li gl-iterate="items">
gl-auth-tokenAuthentication source and key<div gl-auth-token="local:userToken">

gl-bind, gl-bind-[attr] and gl-iterate

Authorization

You can authenticate API requests using the gl-auth-token attribute:

<div
  gl-get="https://example.com/api-with-auth/data"
  gl-auth-token="local:userToken"
></div>

The format is source:key where:

Examples:

Important: When gl-auth-token is specified but no valid value is found, the request will be skipped. This helps prevent failed API requests to protected endpoints.

Multiple Auth Token Sources

You can specify multiple auth token sources in a single gl-auth-token attribute using comma-separated values. The system will try each source in order and use the first one that has a valid value:

<div
  gl-get="https://example.com/api-with-auth/data"
  gl-auth-token="query:token, local:authToken, session:apiKey, ThirdParty.getToken()"
></div>

This will first check for a URL query parameter named “token”, then a value in localStorage under the key “authToken”, then a value in sessionStorage under the key “apiKey”, and finally a value from a global function named “getToken” from the “ThirdParty” SDK. The first source to return a truthy value will be used.

Global Scope

// Auth value in global scope
window.myAuthToken = "a-unique-token";

<div
  gl-get="https://example.com/api-with-auth/data"
  gl-auth-token="myAuthToken"
></div>;
// Auth function in global scope
window.getMyToken = function () {
  return "your-custom-token";
};

<div
  gl-get="https://example.com/api-with-auth/data"
  gl-auth-token="getMyToken()"
></div>;

For global scope, you can also use nested paths to access properties and methods on objects (or more usually SDKs).

// Nested object with a token property in global scope
window.Auth = {
  token: "your-custom-token",
};

<div
  gl-get="https://example.com/api-with-auth/data"
  gl-auth-token="Auth.token"
></div>;
// Nested object with auth method in global scope
window.Auth = {
  getToken: function () {
    return "your-custom-token";
  },
};

<div
  gl-get="https://example.com/api-with-auth/data"
  gl-auth-token="Auth.getToken()"
></div>;
// With Outseta script and configuration already in place

<div
  gl-get="https://example.com/api-with-auth/data"
  gl-auth-token="Outseta.getAccessToken()"
></div>

The Galleon Tools

Galleon Attributes will be a part a larger Galleon fleet, aiming to unlock user data for Webflow Pirates:

Join the Voyage

Captain’s Log (License)

MIT © Queen Raae