Skip to content

Commit

Permalink
docs updated for version 1.0.0-beta.15
Browse files Browse the repository at this point in the history
  • Loading branch information
wpdas committed Apr 10, 2024
1 parent d0fb8e1 commit aab5a66
Show file tree
Hide file tree
Showing 11 changed files with 15 additions and 47 deletions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"deploy:testnet": "npm run build; alem deploy --network testnet"
},
"dependencies": {
"alem": "1.0.0-beta.13"
"alem": "1.0.0-beta.15"
},
"devDependencies": {
"@types/styled-components": "^5.1.26",
Expand Down
7 changes: 4 additions & 3 deletions src/Main.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { RouterContext, asyncFetch, useEffect, useState } from "alem";
import { RouterContext, Storage, asyncFetch, useEffect, useState } from "alem";
import Modals from "./components/Modals/Modals";
import {
AppBackground,
Expand All @@ -13,11 +13,12 @@ import ContentView from "./components/ContentView";
import Footer from "@app/components/Footer/Footer";

const Main = () => {
const [libVersion, setLibVersion] = useState("");
const [libVersion, setLibVersion] = useState(Storage.get("version"));

useEffect(() => {
asyncFetch("https://api.github.com/repos/wpdas/alem/tags").then((data) => {
setLibVersion(data.body[0].name.replace("v", ""));
Storage.set("version", data.body[0].name.replace("v", ""));
});
}, []);

Expand All @@ -27,7 +28,7 @@ const Main = () => {
<div style={{ marginTop: "calc(-1 * var(--body-top-padding, 0))" }}>
<Modals />
<Banner>
Alem is currently on version <span>{libVersion}</span>.
Alem is currently on version <span>{libVersion}</span>
</Banner>
<MobileNavBarSwitcher>
<MobileNavBar />
Expand Down
2 changes: 1 addition & 1 deletion src/md/router/GetLocation.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { Markdown } from 'alem';

const GetLocation = () => {
const mdContent = Buffer.from(`IyBHZXQgTG9jYXRpb24KClRoaXMgaG9vayByZXR1cm5zIHRoZSBjdXJyZW50IGxvY2F0aW9uIG9iamVjdC4gSXQgY2FuIGJlIHVzZWZ1bCBpZiB5b3UnZCBsaWtlIHRvIHBlcmZvcm0gc29tZSBzaWRlIGVmZmVjdCB3aGVuZXZlciB0aGUgY3VycmVudCBsb2NhdGlvbiBjaGFuZ2VzLgoKVXNlIGBnZXRMb2NhdGlvbigpLmlzUm91dGVzUmVhZHlgIHRvIGdldCB0byBrbm93IHdoZW4gdGhlIHJvdXRlcyBhcmUgcmVhZHkgdG8gYmUgYWNjZXNzZWQuCgpJdCBzaG91bGQgYmUgdXNlZCB3aXRoIGBSb3V0ZXJgLgoKYGBgdHMKLy8gaHR0cDovLzEyNy4wLjAuMTo4MDgwL2FsZW0tbGliLm5lYXIvd2lkZ2V0L0luZGV4P3BhdGg9cHJvZmlsZQppbXBvcnQgeyBnZXRMb2NhdGlvbiB9IGZyb20gImFsZW0iOwoKZXhwb3J0IGNvbnN0IFNvbWVDb21wb25lbnQgPSAoKSA9PiB7CiAgY29uc3QgbG9jYXRpb24gPSBnZXRMb2NhdGlvbigpOwogIGNvbnNvbGUubG9nKGxvY2F0aW9uKTsKICAvLyB7IGlzUm91dGVzUmVhZHk6IHRydWUsIHBhdGhuYW1lOiAicHJvZmlsZSIsIHJvdXRlczogWyJob21lIiwgInByb2ZpbGUiXSB9CgogIHJldHVybiAiIjsKfTsKYGBgCg==`, "base64").toString("utf-8");
const mdContent = Buffer.from(`IyBHZXQgTG9jYXRpb24KClRoaXMgaG9vayByZXR1cm5zIHRoZSBjdXJyZW50IGxvY2F0aW9uIG9iamVjdC4gSXQgY2FuIGJlIHVzZWZ1bCBpZiB5b3UnZCBsaWtlIHRvIHBlcmZvcm0gc29tZSBzaWRlIGVmZmVjdCB3aGVuZXZlciB0aGUgY3VycmVudCBsb2NhdGlvbiBjaGFuZ2VzLgoKVXNlIGBnZXRMb2NhdGlvbigpLmlzUm91dGVzUmVhZHlgIHRvIGdldCB0byBrbm93IHdoZW4gdGhlIHJvdXRlcyBhcmUgcmVhZHkgdG8gYmUgYWNjZXNzZWQuCgpgYGB0cwovLyBodHRwOi8vMTI3LjAuMC4xOjgwODAvYWxlbS1saWIubmVhci93aWRnZXQvSW5kZXg/cGF0aD1wcm9maWxlCmltcG9ydCB7IGdldExvY2F0aW9uIH0gZnJvbSAiYWxlbSI7CgpleHBvcnQgY29uc3QgU29tZUNvbXBvbmVudCA9ICgpID0+IHsKICBjb25zdCBsb2NhdGlvbiA9IGdldExvY2F0aW9uKCk7CiAgY29uc29sZS5sb2cobG9jYXRpb24pOwogIC8vIHsgaXNSb3V0ZXNSZWFkeTogdHJ1ZSwgcGF0aG5hbWU6ICJwcm9maWxlIiwgcm91dGVzOiBbImhvbWUiLCAicHJvZmlsZSJdIH0KCiAgcmV0dXJuICIiOwp9OwpgYGAK`, "base64").toString("utf-8");
return <Markdown text={mdContent} />
}

Expand Down
2 changes: 1 addition & 1 deletion src/md/router/Navigate.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { Markdown } from 'alem';

const Navigate = () => {
const mdContent = Buffer.from(`IyBOYXZpZ2F0ZQoKVGhpcyBmZWF0dXJlIG1ha2VzIGl0IHBvc3NpYmxlIHRvIHByb2dyYW1tYXRpY2FsbHkgbmF2aWdhdGUgdG8gYXZhaWxhYmxlIHJvdXRlcy4gVGhlIFVSTCB3aWxsIG5vdCBiZSBhZmZlY3RlZCEKCkl0IHNob3VsZCBiZSB1c2VkIHdpdGggYFJvdXRlcmAuCgojIyBOYXZpZ2F0ZSBUbwoKVXNlIGBuYXZpZ2F0ZS50b2AgdG8gbmF2aWdhdGUgdGhyb3VnaCB0aGUgcm91dGVzLgoKYGBgdHN4CmltcG9ydCB7IG5hdmlnYXRlIH0gZnJvbSAiYWxlbSI7CgpleHBvcnQgY29uc3QgU29tZUNvbXBvbmVudCA9ICgpID0+IHsKICBjb25zdCBvbkNsaWNrSGFuZGxlciA9ICgpID0+IHsKICAgIG5hdmlnYXRlLnRvKCJwcm9maWxlIik7CiAgfTsKCiAgcmV0dXJuIDxidXR0b24gb25DbGljaz17b25DbGlja0hhbmRsZXJ9PkdvIHRvIFByb2ZpbGU8L2J1dHRvbj47Cn07CmBgYAoKWW91IGNhbiBhbHNvIHNlbmQgcGFyYW1zIHRvIHRoZSByb3V0ZToKCmBgYHRzeAppbXBvcnQgeyBuYXZpZ2F0ZSB9IGZyb20gImFsZW0iOwoKZXhwb3J0IGNvbnN0IFNvbWVDb21wb25lbnQgPSAoKSA9PiB7CiAgY29uc3Qgb25DbGlja0hhbmRsZXIgPSAoKSA9PiB7CiAgICBuYXZpZ2F0ZS50bygicHJvZmlsZSIsIHsKICAgICAgbmFtZTogIldlbmR6IiwKICAgICAgYWdlOiAzMywKICAgICAgcHJvZmlsZVBpY3R1cmU6ICJodHRwczovL3VybC5jb20vdG8vaW1hZ2UuanBnIiwKICAgIH0pOwogIH07CgogIHJldHVybiA8YnV0dG9uIG9uQ2xpY2s9e29uQ2xpY2tIYW5kbGVyfT5HbyB0byBQcm9maWxlPC9idXR0b24+Owp9OwpgYGAKClRoZW4geW91IGNhbiB1c2UgYHVzZVJvdXRlcygpLnJvdXRlUGFyYW1zYCB0byBnZXQgdGhlIHJvdXRlIHBhcmFtcyBpbnNpZGUgdGhlIHBhZ2U6CgpgYGB0c3gKaW1wb3J0IHsgdXNlUm91dGVzIH0gZnJvbSAiYWxlbSI7CgpleHBvcnQgY29uc3QgUHJvZmlsZVBhZ2UgPSAoKSA9PiB7CiAgY29uc29sZS5sb2codXNlUm91dGVzKCkucm91dGVQYXJhbXMpOwogIC8vIHsgbmFtZTogIldlbmR6IiwgYWdlOiAzMywgcHJvZmlsZVBpY3R1cmU6ICJodHRwczovL3VybC5jb20vdG8vaW1hZ2UuanBnIiB9CgogIC8vLi4uCn07CmBgYAoKIyMgTmF2aWdhdGUgQmFjawoKVXNlIGBuYXZpZ2F0ZS5iYWNrYCB0byBnbyB0byB0aGUgcHJldmlvdXMgcm91dGUuCgpgYGB0c3gKaW1wb3J0IHsgbmF2aWdhdGUgfSBmcm9tICJhbGVtIjsKCmV4cG9ydCBjb25zdCBTb21lQ29tcG9uZW50ID0gKCkgPT4gewogIGNvbnN0IG9uQ2xpY2tIYW5kbGVyID0gKCkgPT4gewogICAgbmF2aWdhdGUuYmFjaygpOwogIH07CgogIHJldHVybiA8YnV0dG9uIG9uQ2xpY2s9e29uQ2xpY2tIYW5kbGVyfT5HbyBCYWNrPC9idXR0b24+Owp9OwpgYGAK`, "base64").toString("utf-8");
const mdContent = Buffer.from(`IyBOYXZpZ2F0ZQoKVGhpcyBmZWF0dXJlIG1ha2VzIGl0IHBvc3NpYmxlIHRvIHByb2dyYW1tYXRpY2FsbHkgbmF2aWdhdGUgdG8gYXZhaWxhYmxlIHJvdXRlcy4gVGhlIFVSTCB3aWxsIG5vdCBiZSBhZmZlY3RlZCEKClRoaXMgZmVhdHVyZSBpcyBkZXNpZ25lZCB0byB3b3JrIG9ubHkgd2l0aCB0aGUgYENvbnRlbnRCYXNlZGAgcm91dGUgdHlwZS4gSXQgYWxzbyB3b3JrcyB3aXRoIHRoZSBgVVJMQmFzZWRgIHR5cGUsIGJ1dCByb3V0ZXMgZGVmaW5lZCBieSBgbmF2aWdhdGVgIHdpbGwgbm90IGhhdmUgcHJpb3JpdHkgb3ZlciByb3V0ZXMgZGVmaW5lZCBpbiB0aGUgYnJvd3NlciBVUkwuCgojIyBOYXZpZ2F0ZSBUbwoKVXNlIGBuYXZpZ2F0ZS50b2AgdG8gbmF2aWdhdGUgdGhyb3VnaCB0aGUgcm91dGVzLgoKYGBgdHN4CmltcG9ydCB7IG5hdmlnYXRlIH0gZnJvbSAiYWxlbSI7CgpleHBvcnQgY29uc3QgU29tZUNvbXBvbmVudCA9ICgpID0+IHsKICBjb25zdCBvbkNsaWNrSGFuZGxlciA9ICgpID0+IHsKICAgIG5hdmlnYXRlLnRvKCJwcm9maWxlIik7CiAgfTsKCiAgcmV0dXJuIDxidXR0b24gb25DbGljaz17b25DbGlja0hhbmRsZXJ9PkdvIHRvIFByb2ZpbGU8L2J1dHRvbj47Cn07CmBgYAoKWW91IGNhbiBhbHNvIHNlbmQgcGFyYW1zIHRvIHRoZSByb3V0ZToKCmBgYHRzeAppbXBvcnQgeyBuYXZpZ2F0ZSB9IGZyb20gImFsZW0iOwoKZXhwb3J0IGNvbnN0IFNvbWVDb21wb25lbnQgPSAoKSA9PiB7CiAgY29uc3Qgb25DbGlja0hhbmRsZXIgPSAoKSA9PiB7CiAgICBuYXZpZ2F0ZS50bygicHJvZmlsZSIsIHsKICAgICAgbmFtZTogIldlbmR6IiwKICAgICAgYWdlOiAzMywKICAgICAgcHJvZmlsZVBpY3R1cmU6ICJodHRwczovL3VybC5jb20vdG8vaW1hZ2UuanBnIiwKICAgIH0pOwogIH07CgogIHJldHVybiA8YnV0dG9uIG9uQ2xpY2s9e29uQ2xpY2tIYW5kbGVyfT5HbyB0byBQcm9maWxlPC9idXR0b24+Owp9OwpgYGAKClRoZW4geW91IGNhbiB1c2UgYHVzZVJvdXRlcygpLnJvdXRlUGFyYW1zYCB0byBnZXQgdGhlIHJvdXRlIHBhcmFtcyBpbnNpZGUgdGhlIHBhZ2U6CgpgYGB0c3gKaW1wb3J0IHsgdXNlUm91dGVzIH0gZnJvbSAiYWxlbSI7CgpleHBvcnQgY29uc3QgUHJvZmlsZVBhZ2UgPSAoKSA9PiB7CiAgY29uc29sZS5sb2codXNlUm91dGVzKCkucm91dGVQYXJhbXMpOwogIC8vIHsgbmFtZTogIldlbmR6IiwgYWdlOiAzMywgcHJvZmlsZVBpY3R1cmU6ICJodHRwczovL3VybC5jb20vdG8vaW1hZ2UuanBnIiB9CgogIC8vLi4uCn07CmBgYAoKIyMgTmF2aWdhdGUgQmFjawoKVXNlIGBuYXZpZ2F0ZS5iYWNrYCB0byBnbyB0byB0aGUgcHJldmlvdXMgcm91dGUuCgpgYGB0c3gKaW1wb3J0IHsgbmF2aWdhdGUgfSBmcm9tICJhbGVtIjsKCmV4cG9ydCBjb25zdCBTb21lQ29tcG9uZW50ID0gKCkgPT4gewogIGNvbnN0IG9uQ2xpY2tIYW5kbGVyID0gKCkgPT4gewogICAgbmF2aWdhdGUuYmFjaygpOwogIH07CgogIHJldHVybiA8YnV0dG9uIG9uQ2xpY2s9e29uQ2xpY2tIYW5kbGVyfT5HbyBCYWNrPC9idXR0b24+Owp9OwpgYGAK`, "base64").toString("utf-8");
return <Markdown text={mdContent} />
}

Expand Down
2 changes: 1 addition & 1 deletion src/md/router/RouteLinkDocs.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { Markdown } from 'alem';

const RouteLinkDocs = () => {
const mdContent = Buffer.from(`IyBSb3V0ZSBMaW5rCgpUaGlzIGNvbXBvbmVudCBjcmVhdGVzIGEgYDxhIC8+YCBlbGVtZW50IGFuZCBpcyB1c2VkIHRvIGFsbG93IHVzZXJzIHRvIG5hdmlnYXRlIGJldHdlZW4gcm91dGVzLiBZb3UgbXVzdCBpbmZvcm0gdGhlIGRlc3RpbmF0aW9uIHBhdGggdXNpbmcgdGhlIGB0b2AgcHJvcGVydHkuIEl0IGFsc28gc3VwcG9ydCBgY2xhc3NOYW1lYCwgYHN0eWxlYCBhbmQgYG9uQ2xpY2tgIHByb3BlcnRpZXMuCgpgUm91dGVMaW5rYCBhY3RzIGRpZmZlcmVudGx5IGRlcGVuZGluZyBvbiB0aGUgYFJvdXRlcmAgY29uZmlndXJhdGlvbi4gSWYgdGhlIFJvdXRlciB0eXBlIGlzIGAiVVJMQmFzZWQiYCwgaXQgd2lsbCBzaW1wbHkgdXNlIHRoZSBuYXRpdmUgYW5jaG9yIGZ1bmN0aW9uIHRvIGdvIHRvIHRoZSBuZXcgVVJMLiBJZiB0aGUgdHlwZSBpcyBgIkNvbnRlbnRCYXNlZCJgIGl0IHdpbGwgY2FsbCB0aGUgUm91dGVyJ3MgYG5hdmlnYXRlYCBmdW5jdGlvbiBhbmQgd2lsbCBkaXNwbGF5IHRoZSBuZXcgcGFnZSB3aXRob3V0IGNhdXNpbmcgYSByZWZyZXNoLCBob3dldmVyLCB0aGUgVVJMIGlzIG5vdCBjaGFuZ2VkLgoKSXQgc2hvdWxkIGJlIHVzZWQgd2l0aCBgUm91dGVyYC4KCmBgYHRzeAppbXBvcnQgeyBSb3V0ZUxpbmsgfSBmcm9tICJhbGVtIjsKCmV4cG9ydCBjb25zdCBTb21lQ29tcG9uZW50ID0gKCkgPT4gewogIHJldHVybiAoCiAgICA8Um91dGVMaW5rIHRvPSJwcm9maWxlIj4KICAgICAgPHA+R28gdG8gUHJvZmlsZTwvcD4KICAgIDwvUm91dGVMaW5rPgogICk7Cn07CmBgYAoKWW91IGNhbiBhbHNvIHNlbmQgcGFyYW1zIHRvIHRoZSByb3V0ZToKCmBgYHRzeAppbXBvcnQgeyBSb3V0ZUxpbmsgfSBmcm9tICJhbGVtIjsKCmV4cG9ydCBjb25zdCBTb21lQ29tcG9uZW50ID0gKCkgPT4gewogIHJldHVybiAoCiAgICA8Um91dGVMaW5rCiAgICAgIHRvPSJwcm9maWxlIgogICAgICBwYXJhbXM9e3sgbmFtZTogIldlbmR6IiwgYWdlOiAzMywgcHJvZmlsZVBpY3R1cmU6ICJodHRwczovL3VybC5jb20vdG8vaW1hZ2UuanBnIiB9fQogICAgPgogICAgICA8cD5HbyB0byBQcm9maWxlPC9wPgogICAgPC9Sb3V0ZUxpbms+CiAgKTsKfTsKYGBgCgpUaGVuLCBpZiB5b3UncmUgdXNpbmcgYCJDb250ZW50QmFzZWQiYCBSb3V0ZXIsIHlvdSBjYW4gdXNlIGB1c2VSb3V0ZXMoKS5yb3V0ZVBhcmFtc2AgdG8gZ2V0IHRoZSByb3V0ZSBwYXJhbXMgaW5zaWRlIHRoZSBwYWdlIG9yIHVzZSBgdXNlUGFyYW1zKClgIGlmIHlvdSdyZSB1c2luZyBgIlVSTEJhc2VkImAgUm91dGVyOgoKYGBgdHN4CmltcG9ydCB7IHVzZVJvdXRlcywgdXNlUGFyYW1zIH0gZnJvbSAiYWxlbSI7CgpleHBvcnQgY29uc3QgUHJvZmlsZVBhZ2UgPSAoKSA9PiB7CiAgLy8gSWYgdXNpbmcgIkNvbnRlbnRCYXNlZCIgUm91dGVyCiAgY29uc29sZS5sb2codXNlUm91dGVzKCkucm91dGVQYXJhbXMpOwogIC8vIHsgbmFtZTogIldlbmR6IiwgYWdlOiAzMywgcHJvZmlsZVBpY3R1cmU6ICJodHRwczovL3VybC5jb20vdG8vaW1hZ2UuanBnIiB9CgogIC8vIElmIHVzaW5nICJVUkxCYXNlZCIgUm91dGVyCiAgY29uc29sZS5sb2codXNlUGFyYW1zKCkpOwogIC8vIHsgbmFtZTogIldlbmR6IiwgYWdlOiAiMzMiLCBwcm9maWxlUGljdHVyZTogImh0dHBzOi8vdXJsLmNvbS90by9pbWFnZS5qcGciIH0KCiAgLy8uLi4KfTsKYGBgCg==`, "base64").toString("utf-8");
const mdContent = Buffer.from(`IyBSb3V0ZSBMaW5rCgpUaGlzIGNvbXBvbmVudCBjcmVhdGVzIGEgYDxhIC8+YCBlbGVtZW50IGFuZCBpcyB1c2VkIHRvIGFsbG93IHVzZXJzIHRvIG5hdmlnYXRlIGJldHdlZW4gcm91dGVzLiBZb3UgbXVzdCBpbmZvcm0gdGhlIGRlc3RpbmF0aW9uIHBhdGggdXNpbmcgdGhlIGB0b2AgcHJvcGVydHkuIEl0IGFsc28gc3VwcG9ydHMgYGNsYXNzTmFtZWAsIGBzdHlsZWAsIGBvbkNsaWNrYCBhbmQgb3RoZXIgcHJvcGVydGllcy4KCmBSb3V0ZUxpbmtgIGFjdHMgZGlmZmVyZW50bHkgZGVwZW5kaW5nIG9uIHRoZSBgUm91dGVyYCBjb25maWd1cmF0aW9uLiBJZiB0aGUgUm91dGVyIHR5cGUgaXMgYCJVUkxCYXNlZCJgLCBpdCB3aWxsIHNpbXBseSB1c2UgdGhlIG5hdGl2ZSBhbmNob3IgZnVuY3Rpb24gdG8gZ28gdG8gdGhlIG5ldyBVUkwuIElmIHRoZSB0eXBlIGlzIGAiQ29udGVudEJhc2VkImAgaXQgd2lsbCBjYWxsIHRoZSBSb3V0ZXIncyBgbmF2aWdhdGVgIGZ1bmN0aW9uIGFuZCB3aWxsIGRpc3BsYXkgdGhlIG5ldyBwYWdlIHdpdGhvdXQgY2F1c2luZyBhIHJlZnJlc2gsIGhvd2V2ZXIsIHRoZSBVUkwgaXMgbm90IGNoYW5nZWQuCgpgYGB0c3gKaW1wb3J0IHsgUm91dGVMaW5rIH0gZnJvbSAiYWxlbSI7CgpleHBvcnQgY29uc3QgU29tZUNvbXBvbmVudCA9ICgpID0+IHsKICByZXR1cm4gKAogICAgPFJvdXRlTGluayB0bz0icHJvZmlsZSI+CiAgICAgIDxwPkdvIHRvIFByb2ZpbGU8L3A+CiAgICA8L1JvdXRlTGluaz4KICApOwp9OwpgYGAKCllvdSBjYW4gYWxzbyBzZW5kIHBhcmFtcyB0byB0aGUgcm91dGU6CgpgYGB0c3gKaW1wb3J0IHsgUm91dGVMaW5rIH0gZnJvbSAiYWxlbSI7CgpleHBvcnQgY29uc3QgU29tZUNvbXBvbmVudCA9ICgpID0+IHsKICByZXR1cm4gKAogICAgPFJvdXRlTGluawogICAgICB0bz0icHJvZmlsZSIKICAgICAgcGFyYW1zPXt7IG5hbWU6ICJXZW5keiIsIGFnZTogMzMsIHByb2ZpbGVQaWN0dXJlOiAiaHR0cHM6Ly91cmwuY29tL3RvL2ltYWdlLmpwZyIgfX0KICAgID4KICAgICAgPHA+R28gdG8gUHJvZmlsZTwvcD4KICAgIDwvUm91dGVMaW5rPgogICk7Cn07CmBgYAoKVGhlbiwgaWYgeW91J3JlIHVzaW5nIGAiQ29udGVudEJhc2VkImAgUm91dGVyLCB5b3UgY2FuIHVzZSBgdXNlUm91dGVzKCkucm91dGVQYXJhbXNgIHRvIGdldCB0aGUgcm91dGUgcGFyYW1zIGluc2lkZSB0aGUgcGFnZSBvciB1c2UgYHVzZVBhcmFtcygpYCBpZiB5b3UncmUgdXNpbmcgYCJVUkxCYXNlZCJgIFJvdXRlcjoKCmBgYHRzeAppbXBvcnQgeyB1c2VSb3V0ZXMsIHVzZVBhcmFtcyB9IGZyb20gImFsZW0iOwoKZXhwb3J0IGNvbnN0IFByb2ZpbGVQYWdlID0gKCkgPT4gewogIC8vIElmIHVzaW5nICJDb250ZW50QmFzZWQiIFJvdXRlcgogIGNvbnNvbGUubG9nKHVzZVJvdXRlcygpLnJvdXRlUGFyYW1zKTsKICAvLyB7IG5hbWU6ICJXZW5keiIsIGFnZTogMzMsIHByb2ZpbGVQaWN0dXJlOiAiaHR0cHM6Ly91cmwuY29tL3RvL2ltYWdlLmpwZyIgfQoKICAvLyBJZiB1c2luZyAiVVJMQmFzZWQiIFJvdXRlcgogIGNvbnNvbGUubG9nKHVzZVBhcmFtcygpKTsKICAvLyB7IG5hbWU6ICJXZW5keiIsIGFnZTogIjMzIiwgcHJvZmlsZVBpY3R1cmU6ICJodHRwczovL3VybC5jb20vdG8vaW1hZ2UuanBnIiB9CgogIC8vLi4uCn07CmBgYAo=`, "base64").toString("utf-8");
return <Markdown text={mdContent} />
}

Expand Down
2 changes: 1 addition & 1 deletion src/md/router/RoutesDocs.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { Markdown } from 'alem';

const RoutesDocs = () => {
const mdContent = Buffer.from(`IyBSb3V0ZXMKClRoZXJlIGFyZSB0d28gdHlwZXMgb2Ygcm91dGUgbWFuYWdlcnMgcHJvdmlkZWQgYnkgQWzDqW06IGBSb3V0ZXJgIGFuZCBgU2ltcGxlUm91dGVyYC4KCiMgUm91dGVyCgpUaGlzIGNvbXBvbmVudCBpcyByZXNwb25zaWJsZSBmb3IgbWFuYWdpbmcgdGhlIGNvbnRlbnQgdG8gYmUgZGlzcGxheWVkIG9uIHRoZSBzY3JlZW4gYWNjb3JkaW5nIHRvIHRoZSBhY3RpdmUgcm91dGUuIFlvdSBjYW4gdXNlIHRoZSBgY3JlYXRlUm91dGVgIHJlc291cmNlIHRvIGNyZWF0ZSBhcHBsaWNhdGlvbiByb3V0ZXMgYW5kIHBhc3MgdGhlbSB0byB0aGUgUm91dGVyLgoKYGBgdHN4CmltcG9ydCB7IFJvdXRlckNvbnRleHQsIFJvdXRlciwgY3JlYXRlUm91dGUgfSBmcm9tICJhbGVtIjsKCmltcG9ydCBIb21lUGFnZSBmcm9tICIuL0hvbWVQYWdlIjsKaW1wb3J0IFByb2ZpbGVQYWdlIGZyb20gIi4vUHJvZmlsZVBhZ2UiOwoKY29uc3QgQXBwUm91dGVzID0gKCkgPT4gewoKICAvLyBJdCBtdXN0IGJlIHBsYWNlZCBhYm92ZSBhbGwgcmVzb3VyY2VzIHRoYXQgd2lsbCB1c2UgdGhlIFJvdXRlciB0b29scy4KICBSb3V0ZXJDb250ZXh0KCk7CgogIC8vIENyZWF0aW5nIHJvdXRlcwogIGNvbnN0IEhvbWVQYWdlUm91dGUgPSBjcmVhdGVSb3V0ZSgiaG9tZSIsICgpID0+IDxIb21lUGFnZSAvPik7CiAgY29uc3QgUHJvZmlsZVBhZ2VSb3V0ZSA9IGNyZWF0ZVJvdXRlKCJwcm9maWxlIiwgKCkgPT4gPFByb2ZpbGVQYWdlIC8+KTsKCiAgY29uc3Qgcm91dGVzID0gWwogICAgSG9tZVBhZ2VSb3V0ZSwKICAgIFByb2ZpbGVQYWdlUm91dGUsCiAgXQoKICAvLyBJbml0aWFsaXppbmcgUm91dGVzCiAgcmV0dXJuICgKICAgIDxSb3V0ZXIKICAgICAgcGFyYW1ldGVyTmFtZT0idGFiIiB7LyogT3B0aW9uYWw6IGRlZmF1bHQgaXMgInBhdGgiICovfQogICAgICB0eXBlPSJDb250ZW50QmFzZWQiIHsvKiBPcHRpb25hbDogZGVmYXVsdCBpcyAiVVJMQmFzZWQiICovfQogICAgICByb3V0ZXM9e3JvdXRlc30KICAgIC8+CiAgKTsKfTsKCmV4cG9ydCBkZWZhdWx0IEFwcFJvdXRlczsKYGBgCgoqKlR5cGVzIG9mIEJlaGF2aW9yKioKCmBSb3V0ZXJgIGNhbiBoYW5kbGUgbGlua3MgaW4gdHdvIHdheXM6CgotICoqVVJMQmFzZWQ6KiogVGhpcyBpcyB0aGUgZGVmYXVsdCBiZWhhdmlvci4gRXZlcnkgbGluayB3aWxsIHJlbG9hZCB0aGUgcGFnZSBieSBjaGFuZ2luZyB0aGUgVVJMIHN0cnVjdHVyZSBpbiB0aGUgYnJvd3NlcjsKLSAqKkNvbnRlbnRCYXNlZDoqKiBUaGlzIGJlaGF2aW9yIGRvZXMgbm90IGNoYW5nZSB0aGUgVVJMIGluIHRoZSBicm93c2VyIGFuZCBkb2VzIG5vdCByZWxvYWQgdGhlIHBhZ2UuIFRoZXJlZm9yZSwgaXQgaXMgZmFzdGVyIHRvIGRpc3BsYXkgY29udGVudCBvbiB0aGUgc2NyZWVuLgoKWW91IGNhbiBwYXNzIHRoZSB0eXBlIG9mIGJlaGF2aW9yIHVzaW5nIHRoZSBgdHlwZWAgcHJvcGVydHkgb2YgUm91dGVzLgoKYGBgdHN4Ci8qIFVSTCBCYXNlZCAqLwo8Um91dGVyCiAgcm91dGVzPXtbRmVhdHVyZU92ZXJ2aWV3Um91dGUsIFN0YXRlTWFuYWdlbWVudFJvdXRlXX0KICB0eXBlPSJVUkxCYXNlZCIKLz4KCi8qIENvbnRlbnQgQmFzZWQgKi8KPFJvdXRlcgogIHJvdXRlcz17W0ZlYXR1cmVPdmVydmlld1JvdXRlLCBTdGF0ZU1hbmFnZW1lbnRSb3V0ZV19CiAgdHlwZT0iQ29udGVudEJhc2VkIgovPgpgYGAKCiMgU2ltcGxlUm91dGVyCgpUaGlzIHJvdXRlciB1c2VzIHRoZSBVUkwgdG8gZGV0ZXJtaW5lIHdoaWNoIGNvbnRlbnQgdG8gZGlzcGxheSBvbiB0aGUgc2NyZWVuLiBJdCB3b3JrcyBzaW1pbGFybHkgdG8gdGhlIGBVUkxCYXNlZGAgYXBwcm9hY2ggb2YgdGhlIGBSb3V0ZXJgLgoKYGBgdHN4CmltcG9ydCB7IFNpbXBsZVJvdXRlciwgY3JlYXRlUm91dGUgfSBmcm9tICJhbGVtIjsKCmltcG9ydCBIb21lUGFnZSBmcm9tICIuL0hvbWVQYWdlIjsKaW1wb3J0IFByb2ZpbGVQYWdlIGZyb20gIi4vUHJvZmlsZVBhZ2UiOwoKY29uc3QgQXBwUm91dGVzID0gKCkgPT4gewogIC8vIENyZWF0aW5nIHJvdXRlcwogIGNvbnN0IEhvbWVQYWdlUm91dGUgPSBjcmVhdGVSb3V0ZSgiaG9tZSIsICgpID0+IDxIb21lUGFnZSAvPik7CiAgY29uc3QgUHJvZmlsZVBhZ2VSb3V0ZSA9IGNyZWF0ZVJvdXRlKCJwcm9maWxlIiwgKCkgPT4gPFByb2ZpbGVQYWdlIC8+KTsKICBjb25zdCByb3V0ZXMgPSBbSG9tZVBhZ2VSb3V0ZSwgUHJvZmlsZVBhZ2VSb3V0ZV07CgogIC8vIHBhcmFtZXRlck5hbWUgPT4gT3B0aW9uYWw6IGRlZmF1bHQgaXMgInBhdGgiCiAgcmV0dXJuIDxTaW1wbGVSb3V0ZXIgcm91dGVzPXtyb3V0ZXN9IHBhcmFtZXRlck5hbWU9InRhYiIgLz47Cn07CgpleHBvcnQgZGVmYXVsdCBBcHBSb3V0ZXM7CmBgYAoKVXNpbmcgYFNpbXBsZVJvdXRlcmAsIHlvdSBjYW4gdXNlIGFueSBhbmNob3IgZWxlbWVudCBgPGE+PC9hPmAgdG8gbmF2aWdhdGUgdG8gYW5vdGhlciBwYWdlLCBmb3IgZXhhbXBsZToKCmBgYHRzeAo8YSBocmVmPSJ0YWI9cHJvZmlsZSI+R28gVG8gUHJvZmlsZTwvcD4KYGBgCg==`, "base64").toString("utf-8");
const mdContent = Buffer.from(`IyBSb3V0ZXMKCkZlYXR1cmUgdG8gbWFuYWdlIHRoZSBhcHBsaWNhdGlvbiByb3V0ZXMuCgojIFJvdXRlcgoKVGhpcyBjb21wb25lbnQgaXMgcmVzcG9uc2libGUgZm9yIG1hbmFnaW5nIHRoZSBjb250ZW50IHRvIGJlIGRpc3BsYXllZCBvbiB0aGUgc2NyZWVuIGFjY29yZGluZyB0byB0aGUgYWN0aXZlIHJvdXRlLiBZb3UgY2FuIHVzZSB0aGUgYGNyZWF0ZVJvdXRlYCByZXNvdXJjZSB0byBjcmVhdGUgYXBwbGljYXRpb24gcm91dGVzIGFuZCBwYXNzIHRoZW0gdG8gdGhlIFJvdXRlci4KCmBgYHRzeAppbXBvcnQgeyBSb3V0ZXJDb250ZXh0LCBSb3V0ZXIsIGNyZWF0ZVJvdXRlIH0gZnJvbSAiYWxlbSI7CgppbXBvcnQgSG9tZVBhZ2UgZnJvbSAiLi9Ib21lUGFnZSI7CmltcG9ydCBQcm9maWxlUGFnZSBmcm9tICIuL1Byb2ZpbGVQYWdlIjsKCmNvbnN0IEFwcFJvdXRlcyA9ICgpID0+IHsKCiAgLy8gSXQgbXVzdCBiZSBwbGFjZWQgYWJvdmUgYWxsIHJlc291cmNlcyB0aGF0IHdpbGwgdXNlIHRoZSBSb3V0ZXIgdG9vbHMuCiAgUm91dGVyQ29udGV4dCgpOwoKICAvLyBDcmVhdGluZyByb3V0ZXMKICBjb25zdCBIb21lUGFnZVJvdXRlID0gY3JlYXRlUm91dGUoImhvbWUiLCAoKSA9PiA8SG9tZVBhZ2UgLz4pOwogIGNvbnN0IFByb2ZpbGVQYWdlUm91dGUgPSBjcmVhdGVSb3V0ZSgicHJvZmlsZSIsICgpID0+IDxQcm9maWxlUGFnZSAvPik7CgogIGNvbnN0IHJvdXRlcyA9IFsKICAgIEhvbWVQYWdlUm91dGUsCiAgICBQcm9maWxlUGFnZVJvdXRlLAogIF0KCiAgLy8gSW5pdGlhbGl6aW5nIFJvdXRlcwogIHJldHVybiAoCiAgICA8Um91dGVyCiAgICAgIHBhcmFtZXRlck5hbWU9InRhYiIgey8qIE9wdGlvbmFsOiBkZWZhdWx0IGlzICJwYXRoIiAqL30KICAgICAgdHlwZT0iQ29udGVudEJhc2VkIiB7LyogT3B0aW9uYWw6IGRlZmF1bHQgaXMgIlVSTEJhc2VkIiAqL30KICAgICAgcm91dGVzPXtyb3V0ZXN9CiAgICAvPgogICk7Cn07CgpleHBvcnQgZGVmYXVsdCBBcHBSb3V0ZXM7CmBgYAoKKipUeXBlcyBvZiBCZWhhdmlvcioqCgpgUm91dGVyYCBjYW4gaGFuZGxlIGxpbmtzIGluIHR3byB3YXlzOgoKLSAqKlVSTEJhc2VkOioqIFRoaXMgaXMgdGhlIGRlZmF1bHQgYmVoYXZpb3IuIEV2ZXJ5IGxpbmsgd2lsbCBjaGFuZ2UgdGhlIFVSTCBzdHJ1Y3R1cmUgaW4gdGhlIGJyb3dzZXI7Ci0gKipDb250ZW50QmFzZWQ6KiogVGhpcyBiZWhhdmlvciBkb2VzIG5vdCBjaGFuZ2UgdGhlIFVSTCBpbiB0aGUgYnJvd3Nlci4gVGhlcmVmb3JlLCBpdCBpcyBmYXN0ZXIgdG8gZGlzcGxheSBjb250ZW50IG9uIHRoZSBzY3JlZW4uCgpZb3UgY2FuIHBhc3MgdGhlIHR5cGUgb2YgYmVoYXZpb3IgdXNpbmcgdGhlIGB0eXBlYCBwcm9wZXJ0eSBvZiBSb3V0ZXMuCgpgYGB0c3gKLyogVVJMIEJhc2VkICovCjxSb3V0ZXIKICByb3V0ZXM9e1tGZWF0dXJlT3ZlcnZpZXdSb3V0ZSwgU3RhdGVNYW5hZ2VtZW50Um91dGVdfQogIHR5cGU9IlVSTEJhc2VkIgovPgoKLyogQ29udGVudCBCYXNlZCAqLwo8Um91dGVyCiAgcm91dGVzPXtbRmVhdHVyZU92ZXJ2aWV3Um91dGUsIFN0YXRlTWFuYWdlbWVudFJvdXRlXX0KICB0eXBlPSJDb250ZW50QmFzZWQiCi8+CmBgYAo=`, "base64").toString("utf-8");
return <Markdown text={mdContent} />
}

Expand Down
2 changes: 0 additions & 2 deletions src/md/router/get-location.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ This hook returns the current location object. It can be useful if you'd like to

Use `getLocation().isRoutesReady` to get to know when the routes are ready to be accessed.

It should be used with `Router`.

```ts
// http://127.0.0.1:8080/alem-lib.near/widget/Index?path=profile
import { getLocation } from "alem";
Expand Down
2 changes: 1 addition & 1 deletion src/md/router/navigate.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This feature makes it possible to programmatically navigate to available routes. The URL will not be affected!

It should be used with `Router`.
This feature is designed to work only with the `ContentBased` route type. It also works with the `URLBased` type, but routes defined by `navigate` will not have priority over routes defined in the browser URL.

## Navigate To

Expand Down
4 changes: 1 addition & 3 deletions src/md/router/route-link-docs.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
# Route Link

This component creates a `<a />` element and is used to allow users to navigate between routes. You must inform the destination path using the `to` property. It also support `className`, `style` and `onClick` properties.
This component creates a `<a />` element and is used to allow users to navigate between routes. You must inform the destination path using the `to` property. It also supports `className`, `style`, `onClick` and other properties.

`RouteLink` acts differently depending on the `Router` configuration. If the Router type is `"URLBased"`, it will simply use the native anchor function to go to the new URL. If the type is `"ContentBased"` it will call the Router's `navigate` function and will display the new page without causing a refresh, however, the URL is not changed.

It should be used with `Router`.

```tsx
import { RouteLink } from "alem";

Expand Down
Loading

0 comments on commit aab5a66

Please sign in to comment.