diff --git a/package.json b/package.json index 837fb64..70c673a 100644 --- a/package.json +++ b/package.json @@ -13,7 +13,7 @@ "deploy:testnet": "npm run build; alem deploy --network testnet" }, "dependencies": { - "alem": "1.0.0-beta.30" + "alem": "1.0.0-beta.34" }, "devDependencies": { "@types/styled-components": "^5.1.26", diff --git a/src/components/Sidebar/index.tsx b/src/components/Sidebar/index.tsx index 15b930c..dd70d3a 100644 --- a/src/components/Sidebar/index.tsx +++ b/src/components/Sidebar/index.tsx @@ -2,7 +2,7 @@ import { useEffect, getLocation, useState, useRoutes, Storage } from "alem"; import { SidebarAboutLogo, Container } from "./styles"; import getLinksByCategory from "../../utils/getLinksByCategory"; import CollapseList from "../CollapseList"; -import { Categories, RoutesPath } from "@app/routes/routeProps"; +import { Categories, RoutesPath } from "@app/modules/routes/routeProps"; const Sidebar = () => { const { pathname } = getLocation(); @@ -15,6 +15,7 @@ const Sidebar = () => { const [gettingStartedItems, setGettingStartedItems] = useState<(JSX.Element | undefined)[]>([]); const [routerItems, setRouterItems] = useState<(JSX.Element | undefined)[]>([]); const [modulesItems, setModulesItems] = useState<(JSX.Element | undefined)[]>([]); + const [localModulesItems, setLocalModulesItems] = useState<(JSX.Element | undefined)[]>([]); const [contextItems, setContextItems] = useState<(JSX.Element | undefined)[]>([]); const [apisItems, setApisItems] = useState<(JSX.Element | undefined)[]>([]); const [bosItems, setBosItems] = useState<(JSX.Element | undefined)[]>([]); @@ -23,6 +24,7 @@ const Sidebar = () => { const _gettingStartedItems = getLinksByCategory("Getting Started"); const _routerItems = getLinksByCategory("Router"); const _modulesItems = getLinksByCategory("Modules"); + const _localModulesItems = getLinksByCategory("Local Modules"); const _contextItems = getLinksByCategory("Context"); const _apisItems = getLinksByCategory("APIs"); const _bosItems = getLinksByCategory("BOS"); @@ -30,6 +32,7 @@ const Sidebar = () => { setGettingStartedItems(_gettingStartedItems); setRouterItems(_routerItems); setModulesItems(_modulesItems); + setLocalModulesItems(_localModulesItems); setContextItems(_contextItems); setApisItems(_apisItems); setBosItems(_bosItems); @@ -85,7 +88,17 @@ const Sidebar = () => {
handleOpenRegister(isOpen, Categories.localModules)} + > + <>{localModulesItems} + +
+ +
+ handleOpenRegister(isOpen, Categories.modules)} > diff --git a/src/md/ConfigFile.tsx b/src/md/ConfigFile.tsx index fb10c99..8e5faa7 100644 --- a/src/md/ConfigFile.tsx +++ b/src/md/ConfigFile.tsx @@ -1,7 +1,7 @@ import { Markdown } from 'alem'; const ConfigFile = () => { - const mdContent = Buffer.from(`IyBDb25maWcgRmlsZQoKQ3JlYXRlIGEgYGFsZW0uY29uZmlnLmpzb25gIGZpbGUgYXQgdGhlIHJvb3Qgb2YgdGhlIHByb2plY3Qgd2l0aCB0aGUgZm9sbG93aW5nIGNvbnRlbnQ6CgpgYGBqc29uCnsKICAvLyBUaGlzIGlzIHRoZSByb290IHBhdGggb2YgdGhlIGFwcC4KICAvLyBpZiB0cnVlOiBhbGVtLWxpYi5uZWFyL3dpZGdldC9JbmRleAogIC8vIGlmIGZhbHNlOiBhbGVtLWxpYi5uZWFyL3dpZGdldC9hbGVtLWRvY3MgKGl0J3MgZ29pbmcgdG8gdXNlIHRoZSBzbHVnaWZpZWQgIm5hbWUiKQogICJpc0luZGV4IjogdHJ1ZSwKICAvLyBUaGUgbWFpbm5ldCBhY2NvdW50IElEIHVuZGVyIHdoaWNoIHRoZSBhcHAgd2lsbCBiZSBkZXBsb3llZC4KICAibWFpbm5ldEFjY291bnQiOiAiYWxlbS1saWIubmVhciIsCiAgLy8gVGhlIHRlc3RuZXQgYWNjb3VudCBJRCB1bmRlciB3aGljaCB0aGUgYXBwIHdpbGwgYmUgZGVwbG95ZWQuCiAgInRlc3RuZXRBY2NvdW50IjogImFsZW0tbGliLnRlc3RuZXQiLAogIC8vIEFwcCBuYW1lCiAgIm5hbWUiOiAiQWxlbSBEb2NzIiwKICAvLyBBcHAgRGVzY3JpcHRpb24KICAiZGVzY3JpcHRpb24iOiAiQ3JlYXRlIHdlYjMgYXBwbGljYXRpb25zIGZvciBORUFSIEJPUyB3aXRoIGEgZm9jdXMgb24gcGVyZm9ybWFuY2Ugd2hpbGUgdXNpbmcgY29uY2VwdHMgdGhhdCBhcmUgYmFzZWQgb24gUmVhY3RKUy4iLAogIC8vIFNvY2lhbCBsaW5rcy4gQ2hlY2sgb3V0IE5FQVIgU29jaWFsIEJvcyBkb2NzIHRvIGdldCB0byBrbm93IHRoZSBvcHRpb25zCiAgLy8gaHR0cHM6Ly9kb2NzLm5lYXIub3JnL3NvY2lhbC9jb250cmFjdAogICJsaW5rdHJlZSI6IHsKICAgICJ3ZWJzaXRlIjogImdpdGh1Yi5jb20vd3BkYXMvYWxlbSIKICB9LAogICJpbWFnZSI6IHsKICAgICJpcGZzX2NpZCI6ICJiYWZrcmVpY2pkZ2F0NXhzdzd2eGJvc295eWdlcm1hd2hrZmkyYnkzb3ZnN2M2dHVtcmF5bjRyaW10eSIKICB9LAogIC8vIFRhZ3Mgb2YgdGhpcyBwcm9qZWN0CiAgInRhZ3MiOiBbInRoZSIsICJwcm9qZWN0IiwgInRhZ3MiLCAiaGVyZSJdCn0KYGBgCgojIFBhdGggQWxpYXNlcwoKWW91IGNhbiBvcHRpb25hbGx5IGNvbmZpZ3VyZSB5b3VyIGFwcGxpY2F0aW9uJ3MgcGF0aCBhbGlhc2VzIHNvIHRoYXQgaXQgd29ya3MgdG9nZXRoZXIgd2l0aCB0c2NvbmZpZy5qc29uLCBmb3IgZXhhbXBsZS4gQXNzdW1pbmcgeW91ciBwcm9qZWN0J3MgYHRzY29uZmlnLmpzb25gIGZpbGUgaGFzIHRoZSBmb2xsb3dpbmcgY29uZmlndXJhdGlvbiBmb3IgcGF0aHM6CgpgYGBqc29uCnsKICAiY29tcGlsZXJPcHRpb25zIjogewogICAgLy8gLi4uCiAgICAiYmFzZVVybCI6ICIuIiwKICAgICJwYXRocyI6IHsKICAgICAgIkBhcHAvKiI6IFsic3JjLyoiXSwKICAgICAgIkBjb21wb25lbnRzLyoiOiBbInNyYy9jb21wb25lbnRzLyoiXQogICAgfQogIH0KfQpgYGAKCllvdSB3aWxsIHdhbnQgdG8gY29uZmlndXJlIHRoZSBzYW1lIGJlaGF2aW9yIHVzaW5nIHRoZSBgYWxlbS5jb25maWcuanNvbmAgZmlsZSBhcyBmb2xsb3dzOgoKYGBganNvbgp7CiAgLy8gLi4uCiAgImNvbXBpbGVyT3B0aW9ucyI6IHsKICAgICJiYXNlVXJsIjogIi4iLAogICAgInBhdGhzIjogewogICAgICAiQGFwcC8iOiAic3JjLyIsCiAgICAgICJAY29tcG9uZW50cy8iOiAic3JjL2NvbXBvbmVudHMvIgogICAgfQogIH0KfQpgYGAKCk5vdyBpbiBhbGwgb2YgeW91ciBzb3VyY2UgZmlsZXMsIHlvdSBjYW4gaW1wb3J0IGNvbXBvbmVudHMgbGlrZSB0aGlzOgoKYGBgdHN4Ci8vIFdpdGhvdXQgcGF0aCBhbGlhc2VzCmltcG9ydCBIZXJvIGZyb20gIi4uLy4uLy4uL2NvbXBvbmVudHMvSGVybyI7CmltcG9ydCBGb290ZXIgZnJvbSAiLi4vLi4vLi4vY29tcG9uZW50cy9Gb290ZXIiOwoKLy8gV2l0aCBwYXRoIGFsaWFzZXMKaW1wb3J0IEhlcm8gZnJvbSAiQGNvbXBvbmVudHMvSGVybyI7CmltcG9ydCBGb290ZXIgZnJvbSAiQGNvbXBvbmVudHMvRm9vdGVyIjsKYGBgCgojIE9wdGlvbnMKCkl0IGlzIHBvc3NpYmxlIHRvIGNvbmZpZ3VyZSBzb21lIGNvbXBpbGVyIGJlaGF2aW9ycyB1c2luZyB0aGUgb3B0aW9ucyBzZXNzaW9uLgoKIyMgQ3JlYXRlIExvYWRlciBXaWRnZXQKClRoaXMgZmVhdHVyZSBhbGxvd3MgeW91IHRvIGNyZWF0ZSBhbiBhZGRpdGlvbmFsIFdpZGdldCB0aGF0IHdpbGwgc2VydmUgYXMgYSBMb2FkZXIgZm9yIHRoZSBtYWluIFdpZGdldC4gWW91IGNhbiBvcHRpb25hbGx5IGRlZmluZSB3aGljaCBjb21wb25lbnQgd2lsbCBzZXJ2ZSBhcyB0aGUgTG9hZGluZyBkaXNwbGF5IHdoaWxlIHRoZSBtYWluIFdpZGdldCBjb250ZW50IGlzIGxvYWRlZC4gSWYgbm8gZmlsZSBpcyBwcm92aWRlZCwgdGhlIGRlZmF1bHQgTG9hZGluZyBjb21wb25lbnQgb2YgQWzDqW0gd2lsbCBiZSB1c2VkLgoKVGhlIGdlbmVyYXRlZCBmaWxlIG5hbWUgd2lsbCBiZSBhIG1peCBvZiB0aGUgbmFtZSBvZiB0aGUgbWFpbiBXaWRnZXQgKyAiTG9hZGVyIi4gRm9yIGV4YW1wbGU6IGBJbmRleExvYWRlcmAuIEl0IGlzIHVwIHRvIHlvdSB3aGljaCBmaWxlIHRvIHVzZSBhcyB0aGUgcHJpbWFyeSBtZWFucyBvZiBhY2Nlc3NpbmcgeW91ciBhcHBsaWNhdGlvbi4KCi0gKipgY3JlYXRlTG9hZGVyV2lkZ2V0YDogYm9vbGVhbioqIC0gU2hvdWxkIHRoZSBXaWRnZXQgTG9hZGVyIGJlIGNyZWF0ZWQ/Ci0gKipgbG9hZGluZ0NvbXBvbmVudEZpbGVgOiBzdHJpbmcgKG9wdGlvbmFsKSoqIC0gUGF0aCB0byB0aGUgY29tcG9uZW50IHRoYXQgd2lsbCBzZXJ2ZSBhcyBsb2FkaW5nIHdoaWxlIHRoZSBtYWluIFdpZGdldCBjb250ZW50IGlzIGxvYWRlZC4KLSAqKmBsb2FkaW5nQ29tcG9uZW50TmFtZWA6IHN0cmluZyAob3B0aW9uYWwpKiogLSBFeGFjdCBuYW1lIG9mIHRoZSBjb21wb25lbnQgYmVpbmcgbG9hZGVkIHZpYSBgbG9hZGluZ0NvbXBvbmVudEZpbGVgLiBGb3IgZXhhbXBsZSwgaWYgdGhlIGxvYWRpbmcgZmlsZSBoYXMgdGhpcyBzdHJ1Y3R1cmU6CgpgYGB0c3gKY29uc3QgU3VzcGVuc2VMb2FkaW5nID0gKCkgPT4gPHA+TG9hZGluZy4uLjwvcD47CmBgYAoKU28gdGhlIG5hbWUgbXVzdCBiZSAqKlN1c3BlbnNlTG9hZGluZyoqLgoKKipDb25maWcgRXhhbXBsZSoqCgpgYGBqc29uCiJvcHRpb25zIjogewogICAgImNyZWF0ZUxvYWRlcldpZGdldCI6IHRydWUsCiAgICAibG9hZGluZ0NvbXBvbmVudEZpbGUiOiAic3JjL2NvbXBvbmVudHMvU3VzcGVuc2VMb2FkaW5nLnRzeCIsCiAgICAibG9hZGluZ0NvbXBvbmVudE5hbWUiOiAiU3VzcGVuc2VMb2FkaW5nIgogIH0KYGBgCgojIyBLZWVwIFJvdXRlCgpga2VlcFJvdXRlYCBpcyBvbmx5IHZhbGlkIGR1cmluZyBkZXZlbG9wbWVudCwgYW5kIGlzIGF1dG9tYXRpY2FsbHkgZGlzYWJsZWQgaW4gcHJvZHVjdGlvbi4KClRoaXMgcHJvcGVydHkgZGVmaW5lcyB3aGV0aGVyIHRoZSByb3V0ZSBzaG91bGQgcmVtYWluIHRoZSBzYW1lIGR1cmluZyByZWZyZXNoZXMuIFRoaXMgaXMgb25seSB2YWxpZCBpZiB0aGUgYFJvdXRlcmAgdHlwZSBpcyBgIkNvbnRlbnRCYXNlZCJgLgoKRGVmYXVsdCB2YWx1ZSBpcyBgZmFsc2VgLgoKYGBganNvbgp7CiAgLy8gLi4uCiAgIm9wdGlvbnMiOiB7CiAgICAia2VlcFJvdXRlIjogdHJ1ZQogIH0KfQpgYGAKCiMjIEhpZGUgQWzDqW0gQmFyCgpZb3UgY2FuIHVzZSBgb3B0aW9ucy5oaWRlQWxlbUJhcmAgdG8gcHJldmVudCB0aGUgQWzDqW0gdG9wIGJhciBmcm9tIGJlaW5nIGRpc3BsYXllZC4gVGhpcyBzZXR0aW5nIGFwcGxpZXMgb25seSBpbiB0aGUgZGV2ZWxvcG1lbnQgZW52aXJvbm1lbnQuCgpgYGBqc29uCnsKICAvLyAuLi4KICAib3B0aW9ucyI6IHsKICAgICJoaWRlQWxlbUJhciI6IHRydWUKICB9Cn0KYGBgCg==`, "base64").toString("utf-8"); + const mdContent = Buffer.from(`IyBDb25maWcgRmlsZQoKQ3JlYXRlIGEgYGFsZW0uY29uZmlnLmpzb25gIGZpbGUgYXQgdGhlIHJvb3Qgb2YgdGhlIHByb2plY3Qgd2l0aCB0aGUgZm9sbG93aW5nIGNvbnRlbnQ6CgpgYGBqc29uCnsKICAvLyBUaGlzIGlzIHRoZSByb290IHBhdGggb2YgdGhlIGFwcC4KICAvLyBpZiB0cnVlOiBhbGVtLWxpYi5uZWFyL3dpZGdldC9JbmRleAogIC8vIGlmIGZhbHNlOiBhbGVtLWxpYi5uZWFyL3dpZGdldC9hbGVtLWRvY3MgKGl0J3MgZ29pbmcgdG8gdXNlIHRoZSBzbHVnaWZpZWQgIm5hbWUiKQogICJpc0luZGV4IjogdHJ1ZSwKICAvLyBUaGUgbWFpbm5ldCBhY2NvdW50IElEIHVuZGVyIHdoaWNoIHRoZSBhcHAgd2lsbCBiZSBkZXBsb3llZC4KICAibWFpbm5ldEFjY291bnQiOiAiYWxlbS1saWIubmVhciIsCiAgLy8gVGhlIHRlc3RuZXQgYWNjb3VudCBJRCB1bmRlciB3aGljaCB0aGUgYXBwIHdpbGwgYmUgZGVwbG95ZWQuCiAgInRlc3RuZXRBY2NvdW50IjogImFsZW0tbGliLnRlc3RuZXQiLAogIC8vIEFwcCBuYW1lCiAgIm5hbWUiOiAiQWxlbSBEb2NzIiwKICAvLyBBcHAgRGVzY3JpcHRpb24KICAiZGVzY3JpcHRpb24iOiAiQ3JlYXRlIHdlYjMgYXBwbGljYXRpb25zIGZvciBORUFSIEJPUyB3aXRoIGEgZm9jdXMgb24gcGVyZm9ybWFuY2Ugd2hpbGUgdXNpbmcgY29uY2VwdHMgdGhhdCBhcmUgYmFzZWQgb24gUmVhY3RKUy4iLAogIC8vIFNvY2lhbCBsaW5rcy4gQ2hlY2sgb3V0IE5FQVIgU29jaWFsIEJvcyBkb2NzIHRvIGdldCB0byBrbm93IHRoZSBvcHRpb25zCiAgLy8gaHR0cHM6Ly9kb2NzLm5lYXIub3JnL3NvY2lhbC9jb250cmFjdAogICJsaW5rdHJlZSI6IHsKICAgICJ3ZWJzaXRlIjogImdpdGh1Yi5jb20vd3BkYXMvYWxlbSIKICB9LAogICJpbWFnZSI6IHsKICAgICJpcGZzX2NpZCI6ICJiYWZrcmVpY2pkZ2F0NXhzdzd2eGJvc295eWdlcm1hd2hrZmkyYnkzb3ZnN2M2dHVtcmF5bjRyaW10eSIKICB9LAogIC8vIFRhZ3Mgb2YgdGhpcyBwcm9qZWN0CiAgInRhZ3MiOiBbInRoZSIsICJwcm9qZWN0IiwgInRhZ3MiLCAiaGVyZSJdCn0KYGBgCgojIFBhdGggQWxpYXNlcwoKWW91IGNhbiBvcHRpb25hbGx5IGNvbmZpZ3VyZSB5b3VyIGFwcGxpY2F0aW9uJ3MgcGF0aCBhbGlhc2VzIHNvIHRoYXQgaXQgd29ya3MgdG9nZXRoZXIgd2l0aCB0c2NvbmZpZy5qc29uLCBmb3IgZXhhbXBsZS4gQXNzdW1pbmcgeW91ciBwcm9qZWN0J3MgYHRzY29uZmlnLmpzb25gIGZpbGUgaGFzIHRoZSBmb2xsb3dpbmcgY29uZmlndXJhdGlvbiBmb3IgcGF0aHM6CgpgYGBqc29uCnsKICAiY29tcGlsZXJPcHRpb25zIjogewogICAgLy8gLi4uCiAgICAiYmFzZVVybCI6ICIuIiwKICAgICJwYXRocyI6IHsKICAgICAgIkBhcHAvKiI6IFsic3JjLyoiXSwKICAgICAgIkBjb21wb25lbnRzLyoiOiBbInNyYy9jb21wb25lbnRzLyoiXQogICAgfQogIH0KfQpgYGAKCllvdSB3aWxsIHdhbnQgdG8gY29uZmlndXJlIHRoZSBzYW1lIGJlaGF2aW9yIHVzaW5nIHRoZSBgYWxlbS5jb25maWcuanNvbmAgZmlsZSBhcyBmb2xsb3dzOgoKYGBganNvbgp7CiAgLy8gLi4uCiAgImNvbXBpbGVyT3B0aW9ucyI6IHsKICAgICJiYXNlVXJsIjogIi4iLAogICAgInBhdGhzIjogewogICAgICAiQGFwcC8iOiAic3JjLyIsCiAgICAgICJAY29tcG9uZW50cy8iOiAic3JjL2NvbXBvbmVudHMvIgogICAgfQogIH0KfQpgYGAKCk5vdyBpbiBhbGwgb2YgeW91ciBzb3VyY2UgZmlsZXMsIHlvdSBjYW4gaW1wb3J0IGNvbXBvbmVudHMgbGlrZSB0aGlzOgoKYGBgdHN4Ci8vIFdpdGhvdXQgcGF0aCBhbGlhc2VzCmltcG9ydCBIZXJvIGZyb20gIi4uLy4uLy4uL2NvbXBvbmVudHMvSGVybyI7CmltcG9ydCBGb290ZXIgZnJvbSAiLi4vLi4vLi4vY29tcG9uZW50cy9Gb290ZXIiOwoKLy8gV2l0aCBwYXRoIGFsaWFzZXMKaW1wb3J0IEhlcm8gZnJvbSAiQGNvbXBvbmVudHMvSGVybyI7CmltcG9ydCBGb290ZXIgZnJvbSAiQGNvbXBvbmVudHMvRm9vdGVyIjsKYGBgCgojIE9wdGlvbnMKCkl0IGlzIHBvc3NpYmxlIHRvIGNvbmZpZ3VyZSBzb21lIGNvbXBpbGVyIGJlaGF2aW9ycyB1c2luZyB0aGUgb3B0aW9ucyBzZXNzaW9uLgoKIyMgQ3JlYXRlIExvYWRlciBXaWRnZXQKClRoaXMgZmVhdHVyZSBhbGxvd3MgeW91IHRvIGNyZWF0ZSBhbiBhZGRpdGlvbmFsIFdpZGdldCB0aGF0IHdpbGwgc2VydmUgYXMgYSBMb2FkZXIgZm9yIHRoZSBtYWluIFdpZGdldC4gWW91IGNhbiBvcHRpb25hbGx5IGRlZmluZSB3aGljaCBjb21wb25lbnQgd2lsbCBzZXJ2ZSBhcyB0aGUgTG9hZGluZyBkaXNwbGF5IHdoaWxlIHRoZSBtYWluIFdpZGdldCBjb250ZW50IGlzIGxvYWRlZC4gSWYgbm8gZmlsZSBpcyBwcm92aWRlZCwgdGhlIGRlZmF1bHQgTG9hZGluZyBjb21wb25lbnQgb2YgQWzDqW0gd2lsbCBiZSB1c2VkLgoKVGhlIGdlbmVyYXRlZCBmaWxlIG5hbWUgd2lsbCBiZSBhIG1peCBvZiB0aGUgbmFtZSBvZiB0aGUgbWFpbiBXaWRnZXQgKyAiTG9hZGVyIi4gRm9yIGV4YW1wbGU6IGBJbmRleExvYWRlcmAuIEl0IGlzIHVwIHRvIHlvdSB3aGljaCBmaWxlIHRvIHVzZSBhcyB0aGUgcHJpbWFyeSBtZWFucyBvZiBhY2Nlc3NpbmcgeW91ciBhcHBsaWNhdGlvbi4KCi0gKipgY3JlYXRlTG9hZGVyV2lkZ2V0YDogYm9vbGVhbioqIC0gU2hvdWxkIHRoZSBXaWRnZXQgTG9hZGVyIGJlIGNyZWF0ZWQ/Ci0gKipgbG9hZGluZ0NvbXBvbmVudEZpbGVgOiBzdHJpbmcgKG9wdGlvbmFsKSoqIC0gUGF0aCB0byB0aGUgY29tcG9uZW50IHRoYXQgd2lsbCBzZXJ2ZSBhcyBsb2FkaW5nIHdoaWxlIHRoZSBtYWluIFdpZGdldCBjb250ZW50IGlzIGxvYWRlZC4KLSAqKmBsb2FkaW5nQ29tcG9uZW50TmFtZWA6IHN0cmluZyAob3B0aW9uYWwpKiogLSBFeGFjdCBuYW1lIG9mIHRoZSBjb21wb25lbnQgYmVpbmcgbG9hZGVkIHZpYSBgbG9hZGluZ0NvbXBvbmVudEZpbGVgLiBGb3IgZXhhbXBsZSwgaWYgdGhlIGxvYWRpbmcgZmlsZSBoYXMgdGhpcyBzdHJ1Y3R1cmU6CgpgYGB0c3gKY29uc3QgU3VzcGVuc2VMb2FkaW5nID0gKCkgPT4gPHA+TG9hZGluZy4uLjwvcD47CmBgYAoKU28gdGhlIG5hbWUgbXVzdCBiZSAqKlN1c3BlbnNlTG9hZGluZyoqLgoKKipDb25maWcgRXhhbXBsZSoqCgpgYGBqc29uCiJvcHRpb25zIjogewogICAgImNyZWF0ZUxvYWRlcldpZGdldCI6IHRydWUsCiAgICAibG9hZGluZ0NvbXBvbmVudEZpbGUiOiAic3JjL2NvbXBvbmVudHMvU3VzcGVuc2VMb2FkaW5nLnRzeCIsCiAgICAibG9hZGluZ0NvbXBvbmVudE5hbWUiOiAiU3VzcGVuc2VMb2FkaW5nIgogIH0KYGBgCgojIyBLZWVwIFJvdXRlCgpga2VlcFJvdXRlYCBpcyBvbmx5IHZhbGlkIGR1cmluZyBkZXZlbG9wbWVudCwgYW5kIGlzIGF1dG9tYXRpY2FsbHkgZGlzYWJsZWQgaW4gcHJvZHVjdGlvbi4KClRoaXMgcHJvcGVydHkgZGVmaW5lcyB3aGV0aGVyIHRoZSByb3V0ZSBzaG91bGQgcmVtYWluIHRoZSBzYW1lIGR1cmluZyByZWZyZXNoZXMuIFRoaXMgaXMgb25seSB2YWxpZCBpZiB0aGUgYFJvdXRlcmAgdHlwZSBpcyBgIkNvbnRlbnRCYXNlZCJgLgoKRGVmYXVsdCB2YWx1ZSBpcyBgZmFsc2VgLgoKYGBganNvbgp7CiAgLy8gLi4uCiAgIm9wdGlvbnMiOiB7CiAgICAia2VlcFJvdXRlIjogdHJ1ZQogIH0KfQpgYGAKCiMjIEhpZGUgQWzDqW0gQmFyCgpZb3UgY2FuIHVzZSBgb3B0aW9ucy5oaWRlQWxlbUJhcmAgdG8gcHJldmVudCB0aGUgQWzDqW0gdG9wIGJhciBmcm9tIGJlaW5nIGRpc3BsYXllZC4gVGhpcyBzZXR0aW5nIGFwcGxpZXMgb25seSBpbiB0aGUgZGV2ZWxvcG1lbnQgZW52aXJvbm1lbnQuCgpgYGBqc29uCnsKICAvLyAuLi4KICAib3B0aW9ucyI6IHsKICAgICJoaWRlQWxlbUJhciI6IHRydWUKICB9Cn0KYGBgCgojIExvY2FsIE1vZHVsZXMgT3B0aW9ucwoKQWxsIGZpbGVzIGluc2lkZSB0aGUgYHNyYy9tb2R1bGVzYCBmb2xkZXIgd2lsbCBiZSBjb21waWxlZCBhcyBsb2NhbCBtb2R1bGVzLiBUbyBmaWx0ZXIgYW55IGZpbGUgdGhhdCB5b3UgZG8gbm90IHdhbnQgdG8gYmUgaW50ZXJwcmV0ZWQgYXMgYSBjb21waWxlciBldmVuIHRob3VnaCBpdCBpcyBpbiB0aGUgYHNyYy9tb2R1bGVzYCBmb2xkZXIsIHlvdSBtdXN0IG1ha2UgdGhlIGZvbGxvd2luZyBjb25maWd1cmF0aW9uOgoKSW5zaWRlIHRoZSBgYWxlbS5jb25maWcuanNvbmAgZmlsZSBhZGQgdGhlIGxpc3Qgb2YgcGFydCBvZiBmaWxlIG5hbWVzIHlvdSB3YW50IHRvIGlnbm9yZS4KCmBgYGpzb24KIm1vZHVsZXMiOiB7CiAgImlnbm9yZUZpbGVJZkluY2x1ZGVzIjogWyJzdHlsZXMiXQp9CmBgYAoKSW4gdGhlIGV4YW1wbGUgYWJvdmUsIGFueSBmaWxlIHRoYXQgaGFzICJzdHlsZXMiIGFzIHBhcnQgb2YgaXRzIG5hbWUgd2lsbCBiZSBpZ25vcmVkIGFuZCB3aWxsIGJlIGNvbXBpbGVkIGFzIGEgbm9ybWFsIGZpbGUgKHNjcmlwdCBmaWxlLCBzdGF0ZWxlc3MgY29tcG9uZW50IG9yIHN0YXRlZnVsIGNvbXBvbmVudCkuCg==`, "base64").toString("utf-8"); return } diff --git a/src/md/Environment.tsx b/src/md/Environment.tsx index e2bef47..c95a466 100644 --- a/src/md/Environment.tsx +++ b/src/md/Environment.tsx @@ -1,7 +1,7 @@ import { Markdown } from 'alem'; const Environment = () => { - const mdContent = Buffer.from(`IyBFbnZpcm9ubWVudAoKQ3JlYXRlIGEgYC5lbnZgIGZpbGUgdG8gc2V0IHVwIHRoZSBwcm9qZWN0J3MgZW52aXJvbm1lbnQgYW5kIG90aGVyIHZhcnMuCgoqKmUuZzoqKiBpZiB5b3UgYWRkIGBOT0RFX0VOVj1kZXZlbG9wbWVudGAgdG8geW91ciBgLmVudmAgZmlsZS4gVGhpcyB3aWxsIHNldCB0aGUgcHJvamVjdCBlbnYgYXMgYGRldmVsb3BtZW50YC4KClRoZSBhYnNlbmNlIG9mIHRoZSBgLmVudmAgZmlsZSBtZWFucyB0aGF0IGBOT0RFX0VOVj1wcm9kdWN0aW9uYC4KCllvdSBjYW4gdXNlIGBnZXRBbGVtRW52aXJvbm1lbnQoKWAgcHJvdmlkZWQgYnkgQWzDqW0gdG8gYWNjZXNzIHRoZSBjdXJyZW50IGVudmlyb25tZW50IHZhbHVlLgo=`, "base64").toString("utf-8"); + const mdContent = Buffer.from(`IyBFbnZpcm9ubWVudAoKQ3JlYXRlIGEgYC5lbnZgIGZpbGUgdG8gc2V0IHVwIHRoZSBwcm9qZWN0J3MgZW52aXJvbm1lbnQgYW5kIG90aGVyIHZhcnMuCgoqKmUuZzoqKiBpZiB5b3UgYWRkIGBOT0RFX0VOVj1kZXZlbG9wbWVudGAgdG8geW91ciBgLmVudmAgZmlsZS4gVGhpcyB3aWxsIHNldCB0aGUgcHJvamVjdCBlbnYgYXMgYGRldmVsb3BtZW50YC4KClRoZSBhYnNlbmNlIG9mIHRoZSBgLmVudmAgZmlsZSBtZWFucyB0aGF0IGBOT0RFX0VOVj1wcm9kdWN0aW9uYC4KCllvdSBjYW4gdXNlIGBnZXRBbGVtRW52aXJvbm1lbnQoKWAgcHJvdmlkZWQgYnkgQWzDqW0gdG8gYWNjZXNzIHRoZSBjdXJyZW50IGVudmlyb25tZW50IHZhbHVlLgoKIyBBdmFpbGFibGUgQWzDqW0gRW52IFZhcnMKCmBgYHNoCiMgQWzDqW0gZW52aXJvbm1lbnQgKGRlZmF1bHQgaXMgcHJvZHVjdGlvbikKTk9ERV9FTlY9ZGV2ZWxvcG1lbnQKYGBgCgpgYGBzaAojIFNob3VsZCBmaW5hbCBmaWxlIGJlIG1pbmlmaWVkPyAoZGVmYXVsdCBpcyB0cnVlKQpNSU5JRlk9dHJ1ZQpgYGAKCmBgYHNoCiMgU2F2ZSBmaWxlIHNjaGVtYXM/IChkZWZhdWx0IGlzIGZhbHNlKS4gVGhpcyBpcyB1c2VmdWwgdG8gZXZhbHVhdGUgaG93IGZpbGVzIGFyZSBiZWluZyBoYW5kbGVkLgpTQVZFX1NDSEVNQVM9ZmFsc2UKYGBgCgpgYGBzaAojIFNob3cgaG93IGxvbmcgaXQncyB0YWtpbmcgdG8gY29tcGlsZSBmaWxlcy4gKGRlZmF1bHQgaXMgZmFsc2UpLiBUaGlzIGlzIHV0aWwgZHVyaW5nIEFsw6ltIGVuaGFuY2VtZW50cyAvIG5ldyBpbXBsZW1lbnRhdGlvbnMgb3IgYnVnIGZpeGVzClNIT1dfRVhFQ1VUSU9OX1RJTUU9ZmFsc2UKYGBgCg==`, "base64").toString("utf-8"); return } diff --git a/src/md/FeatureOverview.tsx b/src/md/FeatureOverview.tsx index 15556c0..f17dd61 100644 --- a/src/md/FeatureOverview.tsx +++ b/src/md/FeatureOverview.tsx @@ -1,7 +1,7 @@ import { Markdown } from 'alem'; const FeatureOverview = () => { - const mdContent = Buffer.from(`# Feature Overview

Alem is a web3 **JavaScript** / **TypeScript** library to create web3 apps for Near BOS. You can create your applications in a similar way to React. All components and other resources will be transformed into a file understandable by Near VM.

Alem makes it painless to create interactive UIs. Design simple views for each state in your application. Declarative views make your code more predictable, simpler to understand, and easier to debug.

Build encapsulated components that manage their own state, then compose them to make complex UIs. Since component logic is written in JavaScript, you can easily pass rich data through your app.

**Tip:** Use function as much as possible. Even if it is an object to be shared, use a function to return the object. E.g.:

```ts
export const utils = () => ({
  contractId: "contract-foo.near",
  getItems: () => Storage.get("items"),
  // ...
});
```

## Component

You can create any component file using **JavaScript** or **TypeScript**. The entrypoint must be an App component like so:

```tsx
const App = () => {
  return (
    <>
      <h1>Hello World</h1>
    </>
  );
};

export default App;
```

## Component Props

Passing properties to a component is very simple. Just use react's defaults:

```tsx
export const ComponentA = ({ name }: { name: string }) => {
  return <p>{name}</p>;
};

export const ComponentB = () => {
  return <ComponentA name="Wendz" />;
};

export const ComponentC = (componentProps: { name: string }) => {
  return <p>{componentProps.name}</p>;
};
```

# Good to Know

## Stateful & Stateless Components

Stateful components are interpreted as Widgets by Além, while Stateless components are seen as auxiliary resources injected into the Widgets that import them.

Using any of these features will cause a component to be considered Stateful:

```ts
const [foo, setFoo] = useState(bar);
useEffect(() => {}, []);
useMemo(() => {}, []);
State.init({});
```

Example of stateless and stateful components:

```tsx
// Stateless component
const Hero = ({ label }: { label: string }) => {
  return <p>Hero Bar - {label}</p>;
};
```

```tsx
// Stateful component
import { useState, useEffect } from "alem";

const Footer = () => {
  const [footerLabel] = useState("This is footer");

  return <p>{footerLabel}</p>;
};
```

Now, let's implement the component that is going to import both components above:

```tsx
// Stateful component
import { State, state } from "alem";
import Hero from "./Hero";
import Footer from "./Footer";

const MyStatefulComponent = () => {
  State.init({ version: 1 }); // Any random information

  return (
    <>
      <p>Version: {state.version}</p>
      <Hero label={state.version} />
      <Footer />
    </>
  );
};
```

## TSX & JSX

A .tsx/.jsx file can have only one stateful component. You can create other internal components within the component's function.

✅ **- Right**

```tsx
import { State, state } from "alem";

const MyStatefulComponent = () => {
  State.init({ name: "Wendz" });

  return <p>oi {state.name}</p>;
};

export default MyStatefulComponent;
```

❌ **- Wrong**

```tsx
import { State, state } from "alem";

const MyStatefulComponent = () => {
  State.init({ name: "Wendz" });

  return <p>oi {state.name}</p>;
};

export default MyStatefulComponent;

// Second stateful component at the same file. This is going to fail!
export const OtherStatefulComponent = () => {
  State.init({ age: 22 });

  return <p>Age: {state.age}</p>;
};
```

Stateless components can have as many components as you want in one file.

✅ **- Right**

```tsx
// Group of stateless components
export const ComponentA = (componentProps) => {
  // ...
  return <p>oi {componentProps.name}</p>;
};

export const ComponentB = (componentProps) => {
  // ...
  return <p>Hola {componentProps.name}</p>;
};

export const ComponentC = (componentProps) => {
  // ...
  return (
    <>
      <p>Hi {componentProps.name}</p>
      <ComponentB />
      <ComponentA />
    </>
  );
};
```

## Preparing the Resources

Prefer to create one file per resource, as importing a resource from a `.ts/.js` file will inject the entire contents of that file into the Widget. The same goes for stateless components.

## Comments

This may be obvious but use the correct form of comments during development for **CSS** and **styled-components**.

```css
/* css file */

.my-class {
  /* Correct */
  display: flex;
  // Incorrect
  position: relative;
}
```

```tsx
// tsx or jsx file using styled components
import styled from "styled-components";

export const AppContainer = styled.div`
  display: flex;
  /* Correct */
  flex-direction: row;
  // Incorrect
  font-family: "Wix Madefor Display", sans-serif;

  @media (max-width: 800px) {
    flex-wrap: wrap;
  }
`;
```

## Async / Await

The use of `async/await` is supported and experimental. It should be used only in the main scope of the component. It will make changes to the state of the main Widget. Do not use in hooks. Below is an example of usage:

```tsx
import { fetch, useEffect } from "alem";

const SomeComponent = () => {
  const fetchItems = async () => {
    const items = await fetch("https://api.com/items");
  };

  useEffect(() => {
    fetchItems();
  }, []);

  console.log(items);

  return <></>;
};
```

# Limitations

## Import \*

The use of the `import * foo from './foo'` signature is not supported. This is intentional, as the idea is to import only the necessary fragments into the Widget.

## Internal Duplicate Items

Além fixes duplicate item names being exported by the application automatically, but you should avoid importing a resource that has the same name as any variable within your component. E.g.:

✅ **- Right**

```ts
// aContract.ts
export const contractId = "contract-id-a.near";
// ...
```

```ts
// HomePage.tsx
import { contractId } from './contractId';

const HomePage = () => {
  const contractId_B = "contract-id-b.near"

  return (
    // ...
  )
}

export default HomePage;
```

❌ **- Wrong**

```ts
// aContract.ts
export const contractId = "contract-id-a.near";
export const contractId_C = "contract-id-c.near";
// ...
```

```ts
// HomePage.tsx
import { contractId_C } from './contractId';

const HomePage = () => {
  // ERROR: this will break the application because the "contractId" from aContract.ts is also going to be
  // injected to the final file after compilation.
  const contractId = "contract-id-b.near";

  return (
    // ...
  )
}

export default HomePage;
```

## Sub-Components & Components

At the moment, if you have a component with sub-components, and you also have another component being imported that uses the same name as the sub-component, a compilation failure may occur as currently the compiler automatically renames duplicate component names.

For example:

❌ **- Avoid it**

```tsx
// Exporting components
export const Content = () => <p>A</p>;
```

```tsx
// Importing components + Using Radix components
import { Content } from "./Foo";

const MyComponent = () => {
  return (
    <>
      {/* Radix Select component */}
      <Select.Content>
        <Content />
      </Select.Content>
    </>
  );
};
```

If by chance, in another file there is another component with the name `Content`, the `Content` being imported will have its name changed automatically and this will also affect `Select.Content`, thus generating an error.

To avoid this problem, if a sub-component is used in the same file, change the component name:

✅ **- Right**

```tsx
// Exporting components
export const ContentFoo = () => <p>A</p>;
```

```tsx
// Importing components + Using Radix components
import { ContentFoo } from "./Foo";

const MyComponent = () => {
  return (
    <>
      {/* Radix Select component */}
      <Select.Content>
        <ContentFoo />
      </Select.Content>
    </>
  );
};
```

This way, if `ContentFoo` has its name changed by the compiler, the sub-component (Select -> **Content**) `Select.Content` will not be changed.
`, "base64").toString("utf-8"); + const mdContent = Buffer.from(`# Feature Overview

Alem is a web3 **JavaScript** / **TypeScript** library to create web3 apps for Near BOS. You can create your applications in a similar way to React. All components and other resources will be transformed into a file understandable by Near VM.

Alem makes it painless to create interactive UIs. Design simple views for each state in your application. Declarative views make your code more predictable, simpler to understand, and easier to debug.

Build encapsulated components that manage their own state, then compose them to make complex UIs. Since component logic is written in JavaScript, you can easily pass rich data through your app.

**Tip:** Use function as much as possible. Even if it is an object to be shared, use a function to return the object. E.g.:

```ts
export const utils = () => ({
  contractId: "contract-foo.near",
  getItems: () => Storage.get("items"),
  // ...
});
```

## Component

You can create any component file using **JavaScript** or **TypeScript**. The entrypoint must be an App component like so:

```tsx
const App = () => {
  return (
    <>
      <h1>Hello World</h1>
    </>
  );
};

export default App;
```

## Component Props

Passing properties to a component is very simple. Just use react's defaults:

```tsx
export const ComponentA = ({ name }: { name: string }) => {
  return <p>{name}</p>;
};

export const ComponentB = () => {
  return <ComponentA name="Wendz" />;
};

export const ComponentC = (componentProps: { name: string }) => {
  return <p>{componentProps.name}</p>;
};
```

# Good to Know

## Stateful & Stateless Components

Stateful components are interpreted as Widgets by Além, while Stateless components are seen as auxiliary resources injected into the Widgets that import them.

Using any of these features will cause a component to be considered Stateful:

```ts
const [foo, setFoo] = useState(bar);
useEffect(() => {}, []);
useMemo(() => {}, []);
State.init({});
```

Example of stateless and stateful components:

```tsx
// Stateless component
const Hero = ({ label }: { label: string }) => {
  return <p>Hero Bar - {label}</p>;
};
```

```tsx
// Stateful component
import { useState, useEffect } from "alem";

const Footer = () => {
  const [footerLabel] = useState("This is footer");

  return <p>{footerLabel}</p>;
};
```

Now, let's implement the component that is going to import both components above:

```tsx
// Stateful component
import { State, state } from "alem";
import Hero from "./Hero";
import Footer from "./Footer";

const MyStatefulComponent = () => {
  State.init({ version: 1 }); // Any random information

  return (
    <>
      <p>Version: {state.version}</p>
      <Hero label={state.version} />
      <Footer />
    </>
  );
};
```

## TSX & JSX

A .tsx/.jsx file can have only one stateful component. You can create other internal components within the component's function.

✅ **- Right**

```tsx
import { State, state } from "alem";

const MyStatefulComponent = () => {
  State.init({ name: "Wendz" });

  return <p>oi {state.name}</p>;
};

export default MyStatefulComponent;
```

❌ **- Wrong**

```tsx
import { State, state } from "alem";

const MyStatefulComponent = () => {
  State.init({ name: "Wendz" });

  return <p>oi {state.name}</p>;
};

export default MyStatefulComponent;

// Second stateful component at the same file. This is going to fail!
export const OtherStatefulComponent = () => {
  State.init({ age: 22 });

  return <p>Age: {state.age}</p>;
};
```

Stateless components can have as many components as you want in one file.

✅ **- Right**

```tsx
// Group of stateless components
export const ComponentA = (componentProps) => {
  // ...
  return <p>oi {componentProps.name}</p>;
};

export const ComponentB = (componentProps) => {
  // ...
  return <p>Hola {componentProps.name}</p>;
};

export const ComponentC = (componentProps) => {
  // ...
  return (
    <>
      <p>Hi {componentProps.name}</p>
      <ComponentB />
      <ComponentA />
    </>
  );
};
```

## Preparing the Resources

Prefer to create one file per resource, as importing a resource from a `.ts/.js` file will inject the entire contents of that file into the Widget. The same goes for stateless components.

## Comments

This may be obvious but use the correct form of comments during development for **CSS** and **styled-components**.

```css
/* css file */

.my-class {
  /* Correct */
  display: flex;
  // Incorrect
  position: relative;
}
```

```tsx
// tsx or jsx file using styled components
import styled from "styled-components";

export const AppContainer = styled.div`
  display: flex;
  /* Correct */
  flex-direction: row;
  // Incorrect
  font-family: "Wix Madefor Display", sans-serif;

  @media (max-width: 800px) {
    flex-wrap: wrap;
  }
`;
```

# Limitations

## Import \*

The use of the `import * foo from './foo'` signature is not supported. This is intentional, as the idea is to import only the necessary fragments into the Widget.

## Internal Duplicate Items

Além fixes duplicate item names being exported by the application automatically, but you should avoid importing a resource that has the same name as any variable within your component. E.g.:

✅ **- Right**

```ts
// aContract.ts
export const contractId = "contract-id-a.near";
// ...
```

```ts
// HomePage.tsx
import { contractId } from './contractId';

const HomePage = () => {
  const contractId_B = "contract-id-b.near"

  return (
    // ...
  )
}

export default HomePage;
```

❌ **- Wrong**

```ts
// aContract.ts
export const contractId = "contract-id-a.near";
export const contractId_C = "contract-id-c.near";
// ...
```

```ts
// HomePage.tsx
import { contractId_C } from './contractId';

const HomePage = () => {
  // ERROR: this will break the application because the "contractId" from aContract.ts is also going to be
  // injected to the final file after compilation.
  const contractId = "contract-id-b.near";

  return (
    // ...
  )
}

export default HomePage;
```

## Sub-Components & Components

At the moment, if you have a component with sub-components, and you also have another component being imported that uses the same name as the sub-component, a compilation failure may occur as currently the compiler automatically renames duplicate component names.

For example:

❌ **- Avoid it**

```tsx
// Exporting components
export const Content = () => <p>A</p>;
```

```tsx
// Importing components + Using Radix components
import { Content } from "./Foo";

const MyComponent = () => {
  return (
    <>
      {/* Radix Select component */}
      <Select.Content>
        <Content />
      </Select.Content>
    </>
  );
};
```

If by chance, in another file there is another component with the name `Content`, the `Content` being imported will have its name changed automatically and this will also affect `Select.Content`, thus generating an error.

To avoid this problem, if a sub-component is used in the same file, change the component name:

✅ **- Right**

```tsx
// Exporting components
export const ContentFoo = () => <p>A</p>;
```

```tsx
// Importing components + Using Radix components
import { ContentFoo } from "./Foo";

const MyComponent = () => {
  return (
    <>
      {/* Radix Select component */}
      <Select.Content>
        <ContentFoo />
      </Select.Content>
    </>
  );
};
```

This way, if `ContentFoo` has its name changed by the compiler, the sub-component (Select -> **Content**) `Select.Content` will not be changed.
`, "base64").toString("utf-8"); return } diff --git a/src/md/config-file.md b/src/md/config-file.md index 84039fa..c1f943b 100644 --- a/src/md/config-file.md +++ b/src/md/config-file.md @@ -132,3 +132,17 @@ You can use `options.hideAlemBar` to prevent the Além top bar from being displa } } ``` + +# Local Modules Options + +All files inside the `src/modules` folder will be compiled as local modules. To filter any file that you do not want to be interpreted as a compiler even though it is in the `src/modules` folder, you must make the following configuration: + +Inside the `alem.config.json` file add the list of part of file names you want to ignore. + +```json +"modules": { + "ignoreFileIfIncludes": ["styles"] +} +``` + +In the example above, any file that has "styles" as part of its name will be ignored and will be compiled as a normal file (script file, stateless component or stateful component). diff --git a/src/md/environment.md b/src/md/environment.md index daf8164..b0891a4 100644 --- a/src/md/environment.md +++ b/src/md/environment.md @@ -7,3 +7,25 @@ Create a `.env` file to set up the project's environment and other vars. The absence of the `.env` file means that `NODE_ENV=production`. You can use `getAlemEnvironment()` provided by Além to access the current environment value. + +# Available Além Env Vars + +```sh +# Além environment (default is production) +NODE_ENV=development +``` + +```sh +# Should final file be minified? (default is true) +MINIFY=true +``` + +```sh +# Save file schemas? (default is false). This is useful to evaluate how files are being handled. +SAVE_SCHEMAS=false +``` + +```sh +# Show how long it's taking to compile files. (default is false). This is util during Além enhancements / new implementations or bug fixes +SHOW_EXECUTION_TIME=false +``` diff --git a/src/md/feature-overview.md b/src/md/feature-overview.md index 5dba581..1377e38 100644 --- a/src/md/feature-overview.md +++ b/src/md/feature-overview.md @@ -209,28 +209,6 @@ export const AppContainer = styled.div` `; ``` -## Async / Await - -The use of `async/await` is supported and experimental. It should be used only in the main scope of the component. It will make changes to the state of the main Widget. Do not use in hooks. Below is an example of usage: - -```tsx -import { fetch, useEffect } from "alem"; - -const SomeComponent = () => { - const fetchItems = async () => { - const items = await fetch("https://api.com/items"); - }; - - useEffect(() => { - fetchItems(); - }, []); - - console.log(items); - - return <>; -}; -``` - # Limitations ## Import \* diff --git a/src/md/local-modules/LocalModules.tsx b/src/md/local-modules/LocalModules.tsx new file mode 100644 index 0000000..7400b60 --- /dev/null +++ b/src/md/local-modules/LocalModules.tsx @@ -0,0 +1,8 @@ +import { Markdown } from 'alem'; + +const LocalModules = () => { + const mdContent = Buffer.from(`IyBMb2NhbCBNb2R1bGVzCgpUbyBjcmVhdGUgbG9jYWwgbW9kdWxlcywgeW91IG5lZWQgdG8gcHV0IHRoZSBmaWxlIGluc2lkZSB0aGUgYHNyYy9tb2R1bGVzYCBmb2xkZXIuIExvY2FsIE1vZHVsZXMgYXJlIGdvaW5nIHRvIGJlIGluamVjdGVkIG9ubHkgb25jZSBhbmQgdGhlaXIgcmVmZXJlbmNlcyB3aWxsIGJlIHVzZWQgdGhyb3VnaG91dCB0aGUgYXBwLCB0aHVzIHJlZHVjaW5nIHRoZSBmaW5hbCBzaXplIG9mIHRoZSBmaW5hbCBmaWxlLiBBcyBtZW50aW9uZWQgYmVmb3JlLCB0byBhZGQgYSBmaWxlIHRvIGJlIGNvbXBpbGVkIGFzIG1vZHVsZSwganVzdCBhZGQgaXQgdG8gdGhlIGBzcmMvbW9kdWxlc2AgZm9sZGVyLgoKKipXYXJuaW5nIFBvaW50cyoqOgoKLSBJZiB5b3Ugd2FudCB0byB1c2UgYHByb3BzYCBpbnNpZGUgdGhlIG1vZHVsZXMsIHlvdSBtdXN0IHBhc3MgaXQgYXMgYSBwYXJhbWV0ZXIuIE1vZHVsZXMgbGl2ZSBhdCB0aGUgdmVyeSB0b3AgbGF5ZXIgb2YgQWzDqW0gYW5kIGNhbid0IGF1dG9tYXRpY2FsbHkgYWNjZXNzIHRoZSBgcHJvcHNgIHdoZXJlIGl0J3MgYmVpbmcgdXNlZC4KLSBJdCdzIG5vdCByZWNvbW1lbmRlZCB0byBhZGQgc3RhdGVmdWwgY29tcG9uZW50cyB0byBgc3JjL21vZHVsZXNgOwotIEl0IHN1cHBvcnRzIHN0YXRlbGVzcyBjb21wb25lbnRzLgoKIyMgV2hlbiBzaG91bGQgSSBjcmVhdGUgYSBMb2NhbCBNb2R1bGU/CgpZb3Ugc2hvdWxkIGNyZWF0ZSBhIExvY2FsIE1vZHVsZSB3aGVuIHRoZSBmaWxlcyBhcmUgcmVwZWF0ZWRseSBpbXBvcnRlZCBpbnRvIHRoZSBwcm9qZWN0LiBSZW1lbWJlcmluZyBhZ2FpbiB0aGF0IHRoZXkgd2lsbCBub3QgaGF2ZSBhY2Nlc3MgdG8gdGhlIHByb3BlcnRpZXMgd2hlcmUgdGhleSBhcmUgYmVpbmcgdXNlZCBhdXRvbWF0aWNhbGx5LiBUaGVyZWZvcmUsIHlvdSBtdXN0IHBhc3MgdGhlIG5lY2Vzc2FyeSBwcm9wZXJ0aWVzIHBlciBwYXJhbWV0ZXIuCgpFeGFtcGxlOgoKKipNb2R1bGUgZmlsZXMqKgoKYGBgdHMKLy8gc3JjL21vZHVsZXMvcm91dGVzUHJvcHMudHMgTW9kdWxlCmV4cG9ydCBjb25zdCByb3V0ZXMgPSB7CiAgSE9NRTogImhvbWUiOwogIFBST0ZJTEU6ICJwcm9maWxlIjsKICBFRElUX1BST0ZJTEU6ICJwcm9maWxlL2VkaXQiCn0KCi8vICJwYXJlbnRQcm9wcyIgLSBwcm9wcyBwYXNzZWQgYnkgdGhlIGNhbGxlcgpleHBvcnQgY29uc3QgbG9nUGFyYW1zID0gKHBhcmVudFByb3BzOiBhbnkpID0+IHsKICBjb25zb2xlLmxvZyhwYXJlbnRQcm9wcyk7Cn0KYGBgCgpgYGB0cwovLyBzcmMvbW9kdWxlcy9CYW5uZXIudHN4IE1vZHVsZQppbXBvcnQgeyByb3V0ZXMgfSBmcm9tICIuL21vZHVsZXMvcGFyZW50UHJvcHMiOwoKY29uc3QgYmFubmVyVGV4dCA9ICJUaGlzIGlzIG15IGJhbm5lciEiOwoKdHlwZSBCYW5uZXJQcm9wcyA9IHsgbGFiZWw6IHN0cmluZyB9OwoKY29uc3QgQmFubmVyID0gKHsgbGFiZWwgfTogQmFubmVyUHJvcHMpID0+IHsKICBjb25zdCBhdmFpbGFibGVSb3V0ZXMgPSBPYmplY3Qua2V5cyhyb3V0ZXMpLmpvaW4oIiwgIik7CgogIHJldHVybiAoCiAgICA8PgogICAgICA8aDM+e2Jhbm5lclRleHR9PC9oMz4KICAgICAgPHA+e2xhYmVsfTwvcD4KICAgICAgPHA+QXZhaWxhYmxlIHJvdXRlczoge2F2YWlsYWJsZVJvdXRlc308L3A+CiAgICA8Lz4KICApOwp9OwpleHBvcnQgZGVmYXVsdCBCYW5uZXI7CmBgYAoKKipVc2luZyBtb2R1bGUqKgoKYGBgdHN4Ci8vIHNyYy9NeVN0YXRlZnVsQ29tcG9uZW50LnRzeAppbXBvcnQgeyB1c2VFZmZlY3QsIHByb3BzIH0gZnJvbSAiYWxlbSI7CmltcG9ydCB7IGxvZ1BhcmFtcyB9IGZyb20gIi4vbW9kdWxlcy9wYXJlbnRQcm9wcyI7CmltcG9ydCBCYW5uZXIgZnJvbSAiLi9tb2R1bGVzL0Jhbm5lciI7Cgpjb25zdCBNeVN0YXRlZnVsQ29tcG9uZW50ID0gKCkgPT4gewogIC8vLi4uCiAgdXNlRWZmZWN0KCgpID0+IHsKICAgIGxvZ1BhcmFtcyhwcm9wcyk7CiAgfSwgW10pOwoKICByZXR1cm4gKAogICAgPD4KICAgICAgPEJhbm5lciBsYWJlbD0ianVzdCBhIHNpbXBsZSBiYW5uZXIiIC8+CiAgICA8Lz4KICApOwp9OwpgYGAK`, "base64").toString("utf-8"); + return +} + +export default LocalModules; diff --git a/src/md/local-modules/local-modules.md b/src/md/local-modules/local-modules.md new file mode 100644 index 0000000..de6b738 --- /dev/null +++ b/src/md/local-modules/local-modules.md @@ -0,0 +1,75 @@ +# Local Modules + +To create local modules, you need to put the file inside the `src/modules` folder. Local Modules are going to be injected only once and their references will be used throughout the app, thus reducing the final size of the final file. As mentioned before, to add a file to be compiled as module, just add it to the `src/modules` folder. + +**Warning Points**: + +- If you want to use `props` inside the modules, you must pass it as a parameter. Modules live at the very top layer of Além and can't automatically access the `props` where it's being used. +- It's not recommended to add stateful components to `src/modules`; +- It supports stateless components. + +## When should I create a Local Module? + +You should create a Local Module when the files are repeatedly imported into the project. Remembering again that they will not have access to the properties where they are being used automatically. Therefore, you must pass the necessary properties per parameter. + +Example: + +**Module files** + +```ts +// src/modules/routesProps.ts Module +export const routes = { + HOME: "home"; + PROFILE: "profile"; + EDIT_PROFILE: "profile/edit" +} + +// "parentProps" - props passed by the caller +export const logParams = (parentProps: any) => { + console.log(parentProps); +} +``` + +```ts +// src/modules/Banner.tsx Module +import { routes } from "./modules/parentProps"; + +const bannerText = "This is my banner!"; + +type BannerProps = { label: string }; + +const Banner = ({ label }: BannerProps) => { + const availableRoutes = Object.keys(routes).join(", "); + + return ( + <> +

{bannerText}

+

{label}

+

Available routes: {availableRoutes}

+ + ); +}; +export default Banner; +``` + +**Using module** + +```tsx +// src/MyStatefulComponent.tsx +import { useEffect, props } from "alem"; +import { logParams } from "./modules/parentProps"; +import Banner from "./modules/Banner"; + +const MyStatefulComponent = () => { + //... + useEffect(() => { + logParams(props); + }, []); + + return ( + <> + + + ); +}; +``` diff --git a/src/md/modules/InstallingModules.tsx b/src/md/modules/InstallingModules.tsx index 6c8971c..d5872a4 100644 --- a/src/md/modules/InstallingModules.tsx +++ b/src/md/modules/InstallingModules.tsx @@ -1,7 +1,7 @@ import { Markdown } from 'alem'; const InstallingModules = () => { - const mdContent = Buffer.from(`IyBJbnN0YWxsaW5nIE1vZHVsZXMKClRoZSBBbMOpbSBDb21waWxlciBzdXBwb3J0cyB0aGUgdXNlIG9mIGV4dGVybmFsIE5QTSBtb2R1bGVzIHRocm91Z2ggdGhlIHVzZSBvZiBDRE4gc2VydmljZXMuIFRvIGxvYWQgYW55IGV4dGVybmFsIG1vZHVsZSwgY3JlYXRlIGEgZmlsZSBgYWxlbS5tb2R1bGVzLmpzb25gIGluIHRoZSBwcm9qZWN0IHJvb3QuIEV4YW1wbGU6CgpgYGBqc29uCnsKICAiamF2YXNjcmlwdC10aW1lLWFnbyI6ICJodHRwczovL3VucGtnLmNvbS9qYXZhc2NyaXB0LXRpbWUtYWdvQDIuNS45L2J1bmRsZS9qYXZhc2NyaXB0LXRpbWUtYWdvLmpzIiwKICAiZGF5anMiOiAiaHR0cHM6Ly9jZG5qcy5jbG91ZGZsYXJlLmNvbS9hamF4L2xpYnMvZGF5anMvMS4xMS4xMC9kYXlqcy5taW4uanMiCn0KYGBgCgpUaGUgYGtleWAgb2YgZWFjaCBtb2R1bGUgZGlyZWN0bHkgcmVjZWl2ZXMgaXRzIFVSTCB0byBpdHMgamF2YXNjcmlwdCBmaWxlLgoKQXMgdGhlcmUgYXJlIHRob3VzYW5kcyBvZiBtb2R1bGVzIGF2YWlsYWJsZSwgaXQgaXMgbm90IHBvc3NpYmxlIHRvIGd1YXJhbnRlZSB0aGF0IGFsbCBvZiB0aGVtIHdpbGwgd29yayBwcm9wZXJseS4gSWYgeW91IHdhbnQgdG8gZ2l2ZSBwb3NpdGl2ZSBvciBuZWdhdGl2ZSBmZWVkYmFjayByZWdhcmRpbmcgdGhlIG9wZXJhdGlvbiBvZiBhIG1vZHVsZSwgdXNlIG91ciBUZWxlZ3JhbSBjaGFubmVsLCB5b3UgY2FuIGhlbHAgb3RoZXIgcGVvcGxlLgoKIyBOUE0gTW9kdWxlIFNvdXJjZXMKCkhlcmUgYXJlIHNvbWUgc2l0ZXMgdGhhdCBzZXJ2ZSBtb2R1bGUgc291cmNlczoKCi0gKipDRE4gSnM6KiogaHR0cHM6Ly9jZG5qcy5jb20vbGlicmFyaWVzCi0gKipVTlBLRzoqKiBodHRwczovL3d3dy51bnBrZy5jb20vCg==`, "base64").toString("utf-8"); + const mdContent = Buffer.from(`IyBJbnN0YWxsaW5nIE5QTSBNb2R1bGVzCgpUaGUgQWzDqW0gQ29tcGlsZXIgc3VwcG9ydHMgdGhlIHVzZSBvZiBleHRlcm5hbCBOUE0gbW9kdWxlcyB0aHJvdWdoIHRoZSB1c2Ugb2YgQ0ROIHNlcnZpY2VzLiBUbyBsb2FkIGFueSBleHRlcm5hbCBtb2R1bGUsIGNyZWF0ZSBhIGZpbGUgYGFsZW0ubW9kdWxlcy5qc29uYCBpbiB0aGUgcHJvamVjdCByb290LiBFeGFtcGxlOgoKYGBganNvbgp7CiAgImphdmFzY3JpcHQtdGltZS1hZ28iOiAiaHR0cHM6Ly91bnBrZy5jb20vamF2YXNjcmlwdC10aW1lLWFnb0AyLjUuOS9idW5kbGUvamF2YXNjcmlwdC10aW1lLWFnby5qcyIsCiAgImRheWpzIjogImh0dHBzOi8vY2RuanMuY2xvdWRmbGFyZS5jb20vYWpheC9saWJzL2RheWpzLzEuMTEuMTAvZGF5anMubWluLmpzIgp9CmBgYAoKVGhlIGBrZXlgIG9mIGVhY2ggbW9kdWxlIGRpcmVjdGx5IHJlY2VpdmVzIGl0cyBVUkwgdG8gaXRzIGphdmFzY3JpcHQgZmlsZS4KCkFzIHRoZXJlIGFyZSB0aG91c2FuZHMgb2YgbW9kdWxlcyBhdmFpbGFibGUsIGl0IGlzIG5vdCBwb3NzaWJsZSB0byBndWFyYW50ZWUgdGhhdCBhbGwgb2YgdGhlbSB3aWxsIHdvcmsgcHJvcGVybHkuIElmIHlvdSB3YW50IHRvIGdpdmUgcG9zaXRpdmUgb3IgbmVnYXRpdmUgZmVlZGJhY2sgcmVnYXJkaW5nIHRoZSBvcGVyYXRpb24gb2YgYSBtb2R1bGUsIHVzZSBvdXIgVGVsZWdyYW0gY2hhbm5lbCwgeW91IGNhbiBoZWxwIG90aGVyIHBlb3BsZS4KCiMgTlBNIE1vZHVsZSBTb3VyY2VzCgpIZXJlIGFyZSBzb21lIHNpdGVzIHRoYXQgc2VydmUgbW9kdWxlIHNvdXJjZXM6CgotICoqQ0ROIEpzOioqIGh0dHBzOi8vY2RuanMuY29tL2xpYnJhcmllcwotICoqVU5QS0c6KiogaHR0cHM6Ly93d3cudW5wa2cuY29tLwo=`, "base64").toString("utf-8"); return } diff --git a/src/md/modules/installing-modules.md b/src/md/modules/installing-modules.md index 52fd4df..d5400fa 100644 --- a/src/md/modules/installing-modules.md +++ b/src/md/modules/installing-modules.md @@ -1,4 +1,4 @@ -# Installing Modules +# Installing NPM Modules The Além Compiler supports the use of external NPM modules through the use of CDN services. To load any external module, create a file `alem.modules.json` in the project root. Example: diff --git a/src/modules/readme.md b/src/modules/readme.md new file mode 100644 index 0000000..b7bef4e --- /dev/null +++ b/src/modules/readme.md @@ -0,0 +1,75 @@ +# Modules + +Thes files inside this folder are going to be injected only once and their references will be used throughout the app, thus reducing the final size of the final file. To add a file to be compiled as module, just add it to the `src/modules` folder. + +**Warning Points**: + +- If you want to use `props` inside the modules, you must pass it as a parameter. Modules live at the very top layer of Além and can't automatically access the `props` where it's being used. +- It's not recommended to add stateful components to `src/modules`; +- It supports stateless components. + +## When should I put files here? + +You should place files here when they are repeatedly imported into the project. Remembering again that they will not have access to the properties where they are being used automatically. Therefore, you must pass the necessary properties per parameter. + +Example: + +**Module files** + +```ts +// src/modules/routesProps.ts Module +export const routes = { + HOME: "home"; + PROFILE: "profile"; + EDIT_PROFILE: "profile/edit" +} + +// "parentProps" - props passed by the caller +export const logParams = (parentProps: any) => { + console.log(parentProps); +} +``` + +```ts +// src/modules/Banner.tsx Module +import { routes } from "./modules/parentProps"; + +const bannerText = "This is my banner!"; + +type BannerProps = { label: string }; + +const Banner = ({ label }: BannerProps) => { + const availableRoutes = Object.keys(routes).join(", "); + + return ( + <> +

{bannerText}

+

{label}

+

Available routes: {availableRoutes}

+ + ); +}; +export default Banner; +``` + +**Using module** + +```tsx +// src/MyStatefulComponent.tsx +import { useEffect, props } from "alem"; +import { logParams } from "./modules/parentProps"; +import Banner from "./modules/Banner"; + +const MyStatefulComponent = () => { + //... + useEffect(() => { + logParams(props); + }, []); + + return ( + <> + + + ); +}; +``` diff --git a/src/routes/getRouteTitleByPath.ts b/src/modules/routes/getRouteTitleByPath.ts similarity index 100% rename from src/routes/getRouteTitleByPath.ts rename to src/modules/routes/getRouteTitleByPath.ts diff --git a/src/routes/nextPrevRoutes.ts b/src/modules/routes/nextPrevRoutes.ts similarity index 93% rename from src/routes/nextPrevRoutes.ts rename to src/modules/routes/nextPrevRoutes.ts index a1cc33d..624aef0 100644 --- a/src/routes/nextPrevRoutes.ts +++ b/src/modules/routes/nextPrevRoutes.ts @@ -32,12 +32,18 @@ const nextPrevRoutes = () => ({ [RoutesPath.environment.path]: { prev: RoutesPath.deployingWithGithubActions.path, + next: RoutesPath.aboutLocalModules.path, + }, + + // Local Modules + [RoutesPath.aboutLocalModules.path]: { + prev: RoutesPath.environment.path, next: RoutesPath.installingModules.path, }, // Modules [RoutesPath.installingModules.path]: { - prev: RoutesPath.deployingWithGithubActions.path, + prev: RoutesPath.aboutLocalModules.path, next: RoutesPath.howToUseModules.path, }, diff --git a/src/routes/routeProps.ts b/src/modules/routes/routeProps.ts similarity index 92% rename from src/routes/routeProps.ts rename to src/modules/routes/routeProps.ts index 4a1bb56..bb81dee 100644 --- a/src/routes/routeProps.ts +++ b/src/modules/routes/routeProps.ts @@ -1,6 +1,7 @@ export const Categories = { gettingStarted: "Getting Started", router: "Router", + localModules: "Local Modules", modules: "Modules", context: "Context", apis: "APIs", @@ -54,10 +55,17 @@ export const RoutesPath = { category: Categories.gettingStarted, }, + // Local Modules + aboutLocalModules: { + path: "using-local-modules", + title: "Using Local Modules", + category: Categories.localModules, + }, + // Modules installingModules: { path: "installing-modules", - title: "Installing Modules", + title: "Installing NPM Modules", category: Categories.modules, }, howToUseModules: { diff --git a/src/pages/About/About.tsx b/src/pages/About/About.tsx index bb8a2d4..ffd9818 100644 --- a/src/pages/About/About.tsx +++ b/src/pages/About/About.tsx @@ -1,6 +1,6 @@ import { RouteLink } from "alem"; import { Row } from "../../components/UI"; -import { RoutesPath } from "../../routes/routeProps"; +import { RoutesPath } from "../../modules/routes/routeProps"; import { Container, Logo, diff --git a/src/routes/Routes.tsx b/src/routes/Routes.tsx index 7ebe5b6..83cc882 100644 --- a/src/routes/Routes.tsx +++ b/src/routes/Routes.tsx @@ -1,8 +1,8 @@ import { Router, createRoute, getLocation, useParams } from "alem"; import { AboutPage } from "../pages/About/About"; -import { RoutesPath } from "./routeProps"; -import nextPrevRoutes from "./nextPrevRoutes"; -import getRouteTitleByPath from "./getRouteTitleByPath"; +import { RoutesPath } from "../modules/routes/routeProps"; +import nextPrevRoutes from "../modules/routes/nextPrevRoutes"; +import getRouteTitleByPath from "../modules/routes/getRouteTitleByPath"; import { FooterNavContainer, NextPrevButton } from "./styles"; import FeatureOverview from "@md/FeatureOverview"; import Installation from "@md/Installation"; @@ -26,6 +26,7 @@ import InstallingModules from "@app/md/modules/InstallingModules"; import HowToUseModules from "@app/md/modules/HowToUseModules"; import Environment from "@app/md/Environment"; import GetAlemEnvironment from "@app/md/api/GetAlemEnvironment"; +import LocalModules from "@app/md/local-modules/LocalModules"; const Routes = () => { const urlParams = useParams(); @@ -73,6 +74,9 @@ const Routes = () => { // Modules createRoute(RoutesPath.installingModules.path, InstallingModules), createRoute(RoutesPath.howToUseModules.path, HowToUseModules), + + // Local Modules + createRoute(RoutesPath.aboutLocalModules.path, LocalModules), ]; return ( diff --git a/src/utils/getLinksByCategory.tsx b/src/utils/getLinksByCategory.tsx index 5fa24fe..e944b48 100644 --- a/src/utils/getLinksByCategory.tsx +++ b/src/utils/getLinksByCategory.tsx @@ -1,5 +1,5 @@ import { RouteLink, getLocation } from "alem"; -import { RoutesPath, RoutesPathProps } from "../routes/routeProps"; +import { RoutesPath, RoutesPathProps } from "../modules/routes/routeProps"; const getLinksByCategory = (category: string, onItemClick?: () => void) => { const { pathname } = getLocation();