Replacement Tags

Utilize our Tag replacement system thoughout the application.

getAll()

Returns a snapshot of all Replacement Tags available on the page.

type

function getAll():Promise<ReplacementTag[]

example

window.addEventListener('lf-sdk-ready', async () => {
     
     const replacementTags = await window.sdk.replacementTags.getAll();

     console.log(replacementTags);
});

setTag()

Creates a replacement tag with a custom lookup key and value

type

function setTag(key: string, value: string):Promise<void>

example

window.addEventListener('lf-sdk-ready', async () => {
     
    await window.sdk.replacementTags.setTag('my_custom_tag', 'HelloWorld');

});

applyTag()

returns the string value of the Replacement Tag key provided.

type

function applyTag(value: string):Promise<void>

onChange()

type

function onChange(fn: (value: string | number) => void, name?: string): void

example

watching for an change on the value of timeleft, each second the callback is executed in this example.

window.addEventListener('lf-sdk-ready', async () => {
    window.sdk.replacementTags.onChange((changeValue) => {
        console.log(changeValue)
    }, 'timeleft')
});

onChangeOnce()

function onChangeOnce(fn: (value: string | number) => void, name?: string): void

example

watching for an change on the value of timeleft, but only executed the first time the values changes.

window.addEventListener('lf-sdk-ready', async () => {
    window.sdk.replacementTags.onChangeOnce((changeValue) => {
        console.log(changeValue)
    }, 'timeleft')

});

ReplacementTag

prop	type
name	string
value	string