Refactoring examples and changing the structure of the main page (#3)

* convert example from vanilla to typescript * fix * fix imports * fix test * add case template
mappable-world · Apr 4, 2024 · e64946d · e64946d
1 parent b391715
commit e64946d
Show file tree

Hide file tree

Showing 20 changed files with 565 additions and 138 deletions.
diff --git a/example/case-template/common.css b/example/case-template/common.css
diff --git a/example/case-template/common.ts b/example/case-template/common.ts
@@ -0,0 +1,8 @@
+import type {MMapLocationRequest, LngLatBounds} from '@mappable-world/mappable-types';
+
+const BOUNDS: LngLatBounds = [
+    [54.58311, 25.9985],
+    [56.30248, 24.47889]
+];
+
+export const LOCATION: MMapLocationRequest = {bounds: BOUNDS};
diff --git a/example/case-template/react/index.html b/example/case-template/react/index.html
@@ -0,0 +1,37 @@
+<!doctype html>
+<html>
+    <head>
+        <title>React example mappable-default-ui-theme</title>
+        <meta charset="UTF-8" />
+        <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
+        <script crossorigin src="https://unpkg.com/react@17/umd/react.production.min.js"></script>
+        <script crossorigin src="https://unpkg.com/react-dom@17/umd/react-dom.production.min.js"></script>
+        <script crossorigin src="https://unpkg.com/@babel/standalone@7/babel.min.js"></script>
+        <script src="https://js.api.mappable.world/3.0/?apikey=%APIKEY%&lang=en_US"></script>
+
+        <script
+            data-plugins="transform-modules-umd"
+            data-presets="react, typescript"
+            type="text/babel"
+            src="../../index.ts"
+        ></script>
+        <script
+            data-plugins="transform-modules-umd"
+            data-presets="react, typescript"
+            type="text/babel"
+            src="../common.ts"
+        ></script>
+        <script
+            data-plugins="transform-modules-umd"
+            data-presets="react, typescript"
+            type="text/babel"
+            src="./index.tsx"
+        ></script>
+
+        <link rel="stylesheet" href="../../index.css" />
+        <link rel="stylesheet" href="../common.css" />
+    </head>
+    <body>
+        <div id="app"></div>
+    </body>
+</html>
diff --git a/example/case-template/react/index.tsx b/example/case-template/react/index.tsx
@@ -0,0 +1,40 @@
+import {LOCATION} from '../common';
+
+window.map = null;
+
+main();
+async function main() {
+    const [mappableReact] = await Promise.all([mappable.import('@mappable-world/mappable-reactify'), mappable.ready]);
+    const reactify = mappableReact.reactify.bindTo(React, ReactDOM);
+
+    const {MMap, MMapDefaultSchemeLayer, MMapDefaultFeaturesLayer, MMapControls} = reactify.module(mappable);
+
+    const {useState, useCallback} = React;
+
+    const {MMapZoomControl} = reactify.module(await mappable.import('@mappable-world/[email protected]'));
+
+    const {MMapButtonExample} = reactify.module(await mappable.import('@mappable-world/mappable-default-ui-theme'));
+
+    ReactDOM.render(
+        <React.StrictMode>
+            <App />
+        </React.StrictMode>,
+        document.getElementById('app')
+    );
+
+    function App() {
+        const [location, setLocation] = useState(LOCATION);
+        const onClick = useCallback(() => alert('Click!'), []);
+
+        return (
+            <MMap location={location} ref={(x) => (map = x)}>
+                <MMapDefaultSchemeLayer />
+                <MMapDefaultFeaturesLayer />
+                <MMapControls position="right">
+                    <MMapZoomControl />
+                    <MMapButtonExample text={'My button'} onClick={onClick} />
+                </MMapControls>
+            </MMap>
+        );
+    }
+}
diff --git a/example/case-template/vanilla/index.html b/example/case-template/vanilla/index.html
@@ -0,0 +1,35 @@
+<!doctype html>
+<html>
+    <head>
+        <title>Vanilla example mappable-default-ui-theme</title>
+        <meta charset="UTF-8" />
+        <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
+        <script crossorigin src="https://unpkg.com/@babel/standalone@7/babel.min.js"></script>
+        <script src="https://js.api.mappable.world/3.0/?apikey=%APIKEY%&lang=en_US"></script>
+
+        <script
+            data-plugins="transform-modules-umd"
+            data-presets="react, typescript"
+            type="text/babel"
+            src="../../index.ts"
+        ></script>
+        <script
+            data-plugins="transform-modules-umd"
+            data-presets="typescript"
+            type="text/babel"
+            src="../common.ts"
+        ></script>
+        <script
+            data-plugins="transform-modules-umd"
+            data-presets="typescript"
+            type="text/babel"
+            src="./index.ts"
+        ></script>
+
+        <link rel="stylesheet" href="../../index.css" />
+        <link rel="stylesheet" href="../common.css" />
+    </head>
+    <body>
+        <div id="app"></div>
+    </body>
+</html>
diff --git a/example/case-template/vanilla/index.ts b/example/case-template/vanilla/index.ts
@@ -0,0 +1,22 @@
+import {LOCATION} from '../common';
+window.map = null;
+
+main();
+async function main() {
+    await mappable.ready;
+    const {MMap, MMapDefaultSchemeLayer, MMapDefaultFeaturesLayer, MMapControls} = mappable;
+
+    const {MMapZoomControl} = await mappable.import('@mappable-world/[email protected]');
+    const {MMapButtonExample} = await mappable.import('@mappable-world/mappable-default-ui-theme');
+
+    map = new MMap(document.getElementById('app'), {location: LOCATION});
+
+    map.addChild(new MMapDefaultSchemeLayer({}));
+    map.addChild(new MMapDefaultFeaturesLayer({}));
+
+    map.addChild(
+        new MMapControls({position: 'right'})
+            .addChild(new MMapZoomControl({}))
+            .addChild(new MMapButtonExample({text: 'My button', onClick: () => alert('Click!')}))
+    );
+}
diff --git a/example/case-template/vue/index.html b/example/case-template/vue/index.html
@@ -0,0 +1,36 @@
+<!doctype html>
+<html>
+    <head>
+        <title>Vue example mappable-default-ui-theme</title>
+        <meta charset="UTF-8" />
+        <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
+        <script crossorigin src="https://unpkg.com/vue@3/dist/vue.global.js"></script>
+        <script crossorigin src="https://unpkg.com/@babel/standalone@7/babel.min.js"></script>
+        <script src="https://js.api.mappable.world/3.0/?apikey=%APIKEY%&lang=en_US"></script>
+
+        <script
+            data-plugins="transform-modules-umd"
+            data-presets="react, typescript"
+            type="text/babel"
+            src="../../index.ts"
+        ></script>
+        <script
+            data-plugins="transform-modules-umd"
+            data-presets="typescript"
+            type="text/babel"
+            src="../common.ts"
+        ></script>
+        <script
+            data-plugins="transform-modules-umd"
+            data-presets="typescript"
+            type="text/babel"
+            src="./index.ts"
+        ></script>
+
+        <link rel="stylesheet" href="../../index.css" />
+        <link rel="stylesheet" href="../common.css" />
+    </head>
+    <body>
+        <div id="app"></div>
+    </body>
+</html>
diff --git a/example/case-template/vue/index.ts b/example/case-template/vue/index.ts
@@ -0,0 +1,43 @@
+import {LOCATION} from '../common';
+
+window.map = null;
+
+main();
+async function main() {
+    const [mappableVue] = await Promise.all([mappable.import('@mappable-world/mappable-vuefy'), mappable.ready]);
+    const vuefy = mappableVue.vuefy.bindTo(Vue);
+
+    const {MMap, MMapDefaultSchemeLayer, MMapDefaultFeaturesLayer, MMapControls} = vuefy.module(mappable);
+
+    const {MMapZoomControl} = vuefy.module(await mappable.import('@mappable-world/[email protected]'));
+
+    const {MMapButtonExample} = vuefy.module(await mappable.import('@mappable-world/mappable-default-ui-theme'));
+
+    const app = Vue.createApp({
+        components: {
+            MMap,
+            MMapDefaultSchemeLayer,
+            MMapDefaultFeaturesLayer,
+            MMapControls,
+            MMapZoomControl,
+            MMapButtonExample
+        },
+        setup() {
+            const refMap = (ref) => {
+                window.map = ref?.entity;
+            };
+            const onClick = () => alert('Click!');
+            return {LOCATION, refMap, onClick};
+        },
+        template: `
+            <MMap :location="LOCATION" :ref="refMap">
+                <MMapDefaultSchemeLayer />
+                <MMapDefaultFeaturesLayer />
+                <MMapControls position="right">
+                    <MMapZoomControl />
+                    <MMapButtonExample text="My button" :onClick="onClick" />
+                </MMapControls>
+            </MMap>`
+    });
+    app.mount('#app');
+}
diff --git a/example/common.css → example/index.css b/example/common.css → example/index.css
diff --git a/example/index.html b/example/index.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
     <head>
         <title>Example @mappable-world/mappable-default-ui-theme</title>
@@ -8,10 +8,10 @@
             content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"
         />
         <meta http-equiv="X-UA-Compatible" content="ie=edge" />
-        <link rel="stylesheet" href="./common.css" />
+        <link rel="stylesheet" href="./index.css" />
     </head>
     <body>
-        <iframe width="100%" height="500px" src="./vanilla.html" frameborder="0"></iframe>
+        <!-- <iframe width="100%" height="500px" src="./vanilla/index.html" frameborder="0"></iframe> -->
         <div class="content">
             <div class="version">%VERSION%</div>
             %README%

diff --git a/example/common.js → example/index.ts b/example/common.js → example/index.ts
@@ -8,15 +8,6 @@ mappable.import.loaders.unshift(async (pkg) => {
     } else {
         await mappable.import.script(`https://unpkg.com/${pkg}/dist/index.js`);
     }
-
+    // @ts-ignore
     return window['@mappable-world/mappable-default-ui-theme'];
-})
-
-
-const BOUNDS = [
-    [54.58311, 25.99850],
-    [56.30248, 24.47889]
-];
-
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-const LOCATION = {bounds: BOUNDS};
+});
diff --git a/example/react.html b/example/react.html
diff --git a/example/tsconfig.json b/example/tsconfig.json
@@ -0,0 +1,9 @@
+{
+    "extends": "../tsconfig.json",
+    "compilerOptions": {
+        "strict": false,
+        "rootDirs": ["./", "../"],
+        "types": ["./types.d.ts", "../types/index.d.ts"]
+    },
+    "include": ["./**/*.ts", "./**/*.tsx"]
+}
diff --git a/example/types.d.ts b/example/types.d.ts
@@ -0,0 +1,14 @@
+import {MMap} from '@mappable-world/mappable-types';
+
+declare global {
+    const React: typeof import('react');
+    const ReactDOM: typeof import('react-dom');
+    const Vue: typeof import('@vue/runtime-dom');
+    let map: MMap;
+
+    interface Window {
+        map: MMap;
+    }
+}
+
+export {};
diff --git a/example/vanilla.html b/example/vanilla.html