near-bos-webcomponent-updated
v0.0.6
Published
This is a Proof of Concept of embedding a NEAR BOS widget into any web application as a Web Component / Custom element.
Downloads
4
Readme
NEAR BOS Web Component ( custom element )
This is a Proof of Concept of embedding a NEAR BOS widget into any web application as a Web Component / Custom element.
Just load react production react bundles into your index.html as shown below, and use the near-social-viewer custom element to embed the BOS widget.
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Near social</title>
<script defer="defer" src="/runtime.REPLACE_WITH_BUNDLE_HASH.bundle.js"></script>
<script defer="defer" src="/main.REPLACE_WITH_BUNDLE_HASH.bundle.js"></script></head>
<body>
<h1>NEAR BOS embeddable custom element</h1>
<near-social-viewer></near-social-viewer>
</body>
</html>Setup & Development
Initialize repo:
yarnStart development version:
yarn startProduction build:
yarn prodServe the production build:
yarn serve prodUse redirectmap for development
The NEAR social VM supports a feature called redirectMap which allows you to load widgets from other sources than the on chain social db. An example redirect map can look like this:
{"devhub.near/widget/devhub.page.feed": {"code": "return 'hello';"}}The result of applying this redirect map is that the widget devhub.near/widget/devhub.page.feed will be replaced by a string that says hello.
The near-social-viewer web component supports loading a redirect map from the session storage, which is useful when using the viewer for local development or test pipelines.
By setting the session storage key nearSocialVMredirectMap to the JSON value of the redirect map, the web component will pass this to the VM Widget config.
You can also use the same mechanism as near-discovery where you can load components from a locally hosted bos-loader by adding the key flags to localStorage with the value {"bosLoaderUrl": "http://127.0.0.1:3030" }.
Configuring the default widget
The near-social-viewer web component supports three attributes:
src: the src of the widget to render (e.g.devs.near/widget/default)code: raw, valid, stringified widget code to render (e.g."return <p>hello world</p>")initialProps: initial properties to be passed to the rendered widget.
You can modify the default widget that is displayed via the configuration in ./bos.config.json.
Make changes to web4/index as shown below:
{
"account": "devs.near",
"web4": {
"index": {
"src": "devs.near/widget/default",
// "code": "return <p>Hello world!</p>"
"initialProps": {
"message": "hello world!"
}
}
}
}Then be sure to build yarn run prod to see the changes take effect.