Setting Code

The LMEM setting code is a snippet of JavaScript that detects if the extension is installed on users’ browser and can push settings to the extension (subscriptions, onboarding, etc).

Getting Started

Domain Verification

For technical limitations and security concerns, contributors that want to use the setting code on their own Website, have to be explicitly granted.

Contributors can query verification by reaching us out {coming soon}. Contributor will be asked to prove they own the domain they want to use the setting code on. Each verification request will be manually reviewed.

Once verified, the extension is published with an upgraded manifest allowing the contributor’s domain to use the setting code.

Finally, the setting code may be directly added to the HTML of any page on the contributor’s website.

Installation

Inject dist/main.js somewhere in your page.

Usage

I want to know whether or not the extension is installed, so I can make up my page accordingly.

lmem.onInstall(() => {
  document.querySelector('body').textContent = 'Installation Completed!';
});

I want to push settings to the extension at will, so I can let the user trigger the settings for example.
```
const options = { subscriptions: [3] }; // Maarten SAMSON
lmem.pushSettings(options);
```

I want to know when settings have been set, so I can react and make up my page accordingly.

const options = { subscriptions: [3] }; // Maarten SAMSON
lmem.pushSettings(options, () => {
  document.querySelector('body').textContent = 'Setup Completed!';
});

Options

subscriptions: [] a list of contributors identifiers to subscribe to

Development

npm install
npm run start

Build

export EXTENSION_ID=xyz (required)
export REATTEMPT_TIMEOUT=1000 (required)
npm run build

Alternatively you can create a .env file in the root directory to configure the environment variables:
EXTENSION_ID=xyz
REATTEMPT_TIMEOUT=1000

Test

npm run test

dis-moi / setting-code-snippet

readme