Local Content (New)

The Local Content SDK displays scores and points of interest for a given location. It can be added to any property listing in Canada and the United States.

Getting started

Installation

First, install the entry script with npm, yarn, or pnpm:

npm i --save @local-logic/sdks-js

yarn add @local-logic/sdks-js

pnpm add @local-logic/sdks-js

The script is also available in umd and es format from the Local Logic CDN: https://sdk.locallogic.co/sdks-js/<VERSION>/index.<FORMAT>.js

<VERSION> is the latest script version number (which you can find on npm), and <FORMAT> is either umd or es.

<script
  async
  src="https://sdk.locallogic.co/sdks-js/1.7.1/index.umd.js"
  onload="myInitLocalContentFunc()"
></script>

Usage

Step 1: Instantiate an LLSDKsJS instance

Import LLSDKsJS and create a new localLogicSDK instance. If you installed LLSDKsJS using a script tag, you must access it from the window object.

import LLSDKsJS from "@local-logic/sdks-js";
const localLogicSDK = LLSDKsJS(
  // Your API key or token
    <API_KEY>
);

Step 2: Instantiate a Local Content instance

Next, create an instance of Local Content. You must define a container element for it to render into.

// Define a container element
const container = document.createElement("div");
container.style.cssText = `
  height: 550px;
  width: 100vw;
  display: flex;
`;
const mySiteLocation = {
  lat: 37.8,
  lng: -122.4
}
document.body.appendChild(container);
localLogicSDK.create("local-content", container, {
    ...mySiteLocation,
  marker: mySiteLocation,
});

React applications

The SDKs are designed to work with React and other declarative frameworks.

Example

import { useRef, useEffect } from "react";
import LLSDKsJS from "@local-logic/sdks-js";
const localLogicSDK = LLSDKsJS(<API_KEY>);
function MyLocalContentComponent() {
  const containerRef = useRef(null);
  useEffect(() => {
    if (!containerRef.current) {
      return;
    }
    
    const myLocation = {
      lat: 45.5282164,
      lng: -73.5978527,
    };
    const localContent = localLogicSDK.create(
      "local-content",
      containerRef.current, {
        ...myLocation,
        marker: myLocation,
      }
    );
    // It is important to destroy the Local Content instance when the component is unmounted.
    return () => {
      localContent.destroy();
    }
  }, []);
  return (
    <div
      ref={containerRef}
      style={{
        height: "100vh",
        width: "100vw",
      }}
    />
  );
}
export default MyLocalContentComponent;

Appearance

Local Logic SDKs support visual customization using the Appearance API, which allows you to match the look of the SDK to your brand.

Themes

The SDKs currently offer two themes out of the box: day and night. The default mode is day, but you may wish to use the night theme if your application supports a dark mode.

const localLogicSDK = LLSDKsJS(
    <API_KEY>,
  {
    appearance: { theme: "night" }
  }
);

Variables

The entire theme can be further customized using the variables option.

The following example changes the primary color, font, and gives the UI a more rounded appearance.

const localLogicSDK = LLSDKsJS(
    <API_KEY>,
  {
    appearance: {
      variables: {
        "--ll-color-primary": "#fd3958",
        "--ll-color-primary-variant1": "#d5405b",
        "--ll-border-radius-small": "8px",
        "--ll-border-radius-medium": "16px",
        "--ll-font-family": "Avenir, sans-serif",
      }
    }
  }
);

Commonly used variables

Migrating from Local Content (Legacy)

The new Local Content SDK has been rebuilt from the ground up. To make the application more scalable, the SDK API has changed, and is not backwards compatible with the legacy Local Content. Clients migrating from the old version will thus need to remove old code, and re-integrate using the instructions above.

Step 1: Remove Local Logic script tag

Find the line in your codebase where you are loading the Local Logic SDK script. It will likely be next to the closing </body> tag. You can also search for https://cdn.locallogic.co/sdk/ in your codebase.

Before you delete the code make a note of the function name assigned to callback=. If you followed our documentation it is probably called initLocallogic.

Step 2: Delete initLocallogic

Find and delete the function in your codebase you identified in Step 1.

Step 3: Get your new API Key

API keys used in the legacy Local Content are not compatible with the new Local Content. To get a new key please reach out to Local Logic support.

Step 4: Install new SDKs

You can now follow the documentation for the new SDKs outlined above.

Browser support

The SDKs are configured with to support these browsers.

Versioning

The SDKs are designed to receive most new changes (non-breaking features and bug fixes) without the need for a developer to manually update the script.

TypeScript

Local Logic SDKs JS comes packaged with TypeScript declarations.

API

A full list of configuration options for Local Content is available here.

FAQ

Q: How do I change the language of the SDK?

A: You can change the language by specifying locale in the LLSDKsJS options. The supported options are "en" and "fr".

const localContent = localLogicSDK.create(
  "local-content",
  containerRef.current, {
    ..., // Other config options here
  }
);

Q: How do I prevent accidental map zooming on mobile devices?

A: A common problem in mobile maps is when a user inadvertently zooms into a map when scrolls down the page. We recommend solving this by passing the cooperativeGestures option to the Local Content SDK. This option will prevent 1 finger map zooming in favour of pinch to zoom.

const localContent = localLogicSDK.create(
  "local-content",
  containerRef.current, {
    ..., // Other config options here
    cooperativeGestures: true
  }
);

Q: How do I disable lazy load?

A: Lazy loading is enabled by default. In some situations, you may want to disable lazy loading or control lazy loading with your own scripts.

To disable lazy load, pass lazy: false to the renderOptions parameter.

const localContent = localLogicSDK.create(
  "local-content",
  container,
  { ... },
  // renderOptions
  {
    lazy: false
  }
);