0.3.3 • Published 1 year ago
labcode-layer-test v0.3.3
LabcodeLayer Library Test
How to use LabcodeLayer
Install
$ npm install labcode-layer-test
JavaScript
import { LabcodeLayerInit, LabcodeLayer, RemoveLabcodeLayer } from "labcode-layer-test";
// When initiate LabcodeLayer
// This function should be executed in the first page or root component.
LabcodeLayerInit();
// When change props of LabcodeLayer
LabcodeLayer({opacity: 20, bgUrl: "(Labcode Layer Image Url)", redirectURI: "https://www.google.com"});
// When remove LabcodeLayer
RemoveLabcodeLayer();
React
import React, { useEffect } from "react";
import { useLocation } from "react-router-dom";
import { LabcodeLayerInit, LabcodeLayer, RemoveLabcodeLayer } from "labcode-layer-test";
const Component = () => {
const { pathname } = useLocation();
useEffect(() => {
// When initiate LabcodeLayer
// This function should be executed in the first page or root component.
LabcodeLayerInit();
if (pathname === '/layer-applied-page') {
// When change props of LabcodeLayer
LabcodeLayer({opacity: 5, id: 1, redirectURI: "back"});
} else {
// When remove LabcodeLayer
RemoveLabcodeLayer();
}
}, [pathname]);
return (
...
)
}
Props
props | value | type | remark |
---|---|---|---|
opacity | 20 | number | optional (default: 5) |
bgUrl | "https://labcode-bg-url.jpg" | string | optional |
id | 1 | number | optional (You can request Labcode Layer image by id. This method requires network to be available.) |
devToolsUse | true | boolean | optional (default: true) |
redirectURI | URI (i.e. "https://www.google.com") or "back" => history.back() | string | optional (default: "back") |
If you don't provide either bgUrl or id, it will return error.
Dependency
- devtools-detect
- typescript