Skip to content

GetLinked Jab

SDK for rendering forms with custom components and validation in static websites

Functionalities

The GetLinked Jab offers 2 main functionalities:

  • Rendering responsive & dynamic forms complete with advanced form validation and custom components
  • Rendering markdown documents using the same mechanism that is used by the form rendering mechanism

Form Render Quick Start

For more information and examples, see the Using the GetLinked Jab Form

Step 1: Add the Stylesheet

Before the close of the HTML head tag (</head>), add the stylesheet:

html
<link rel="stylesheet" href="/path/to/glj.css" media=all>

For more information about style customization, please see the styling options documentation.

Step 2: Add the Async Initializer

Before the close of the HTML body tag (</body>), add the async initializer:

html
<script>
  window.addEventListener('GLJ:loaded', () => {
    window.GLJ.init({
      baseUrl: 'https://server.your-getlinked-backend-domain.example',
      selector: '[some-css-selector]',
      tosDocLocation: new URL('/tos.md', window.location.href).toString(),
    })
  })
</script>

For more information about the available configuration options, please see the configuration options documentation.

Step 3: Add the SDK

Before the close of the HTML body tag (</body>) but after the async initializer, add the SDK:

html
<script type="text/javascript" src="/path/to/glj.js" async defer></script>

Markdown Render Quick Start

Step 1: Add the Async Initializer

Before the close of the HTML body tag (</body>), add the async initializer:

html
<script>
  window.addEventListener('GLJ:loaded', () => {
    window.GLJ.renderRemoteMarkdownDoc({
      selector: '[some-css-selector]',
      url: new URL('/tos.md', window.location.href).toString(),
    })
  })
</script>

Options for renderRemoteMarkdownDoc

OptionDescription
selectorThe CSS Selector used to identify where the markdown document should be rendered.
urlThe URL to the remotely hosted markdown document.

Step 2: Add the SDK

Before the close of the HTML body tag (</body>) but after the async initializer, add the SDK:

html
<script type="text/javascript" src="/path/to/glj.js" async defer></script>