Skip to content

Actions in JS Console #1832

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 5, 2025
Merged

Actions in JS Console #1832

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d6b0ef0
update folder structure and adds component actions to js console
kamalqureshi Jul 1, 2025
5f54598
Merge branch 'dev' into actions_js_console
kamalqureshi Jul 2, 2025
1583b5c
Update read me files
kamalqureshi Jul 2, 2025
01ed7dd
Updated structure and added support for nested components.
kamalqureshi Jul 2, 2025
4197d0b
Merge branch 'dev' into actions_js_console
kamalqureshi Jul 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
376 changes: 1 addition & 375 deletions client/packages/lowcoder/src/comps/comps/preLoadComp.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,375 +1 @@
import { EmptyContent } from "components/EmptyContent";
import { HelpText } from "components/HelpText";
import { Tabs } from "components/Tabs";
import {
clearMockWindow,
clearStyleEval,
ConstructorToComp,
evalFunc,
evalStyle,
RecordConstructorToComp,
} from "lowcoder-core";
import { CodeTextControl } from "comps/controls/codeTextControl";
import SimpleStringControl from "comps/controls/simpleStringControl";
import { MultiCompBuilder, withPropertyViewFn } from "comps/generators";
import { list } from "comps/generators/list";
import { BaseSection, CustomModal, PlusIcon, ScrollBar } from "lowcoder-design";
import React, { useContext, useEffect, useState } from "react";
import styled from "styled-components";
import { ExternalEditorContext } from "util/context/ExternalEditorContext";
import { runScriptInHost } from "util/commonUtils";
import { getGlobalSettings } from "comps/utils/globalSettings";
import { trans } from "i18n";
import log from "loglevel";
import { JSLibraryModal } from "components/JSLibraryModal";
import { JSLibraryTree } from "components/JSLibraryTree";
import { fetchJSLibrary } from "util/jsLibraryUtils";

export interface ExternalPreload {
css?: string;
libs?: string[];
script?: string;
runJavaScriptInHost?: boolean;
}

interface RunAndClearable<T> {
run(id: string, externalPreload?: T): Promise<any>;

clear(): Promise<any>;
}

class LibsCompBase extends list(SimpleStringControl) implements RunAndClearable<string[]> {
success: Record<string, boolean> = {};
globalVars: Record<string, string[]> = {};
externalLibs: string[] = [];
runInHost: boolean = false;

getAllLibs() {
return this.externalLibs.concat(this.getView().map((i) => i.getView()));
}

async loadScript(url: string) {
if (this.success[url]) {
return;
}
return fetchJSLibrary(url).then((code) => {
evalFunc(
code,
{},
{},
{
scope: "function",
disableLimit: this.runInHost,
onSetGlobalVars: (v: string) => {
this.globalVars[url] = this.globalVars[url] || [];
if (!this.globalVars[url].includes(v)) {
this.globalVars[url].push(v);
}
},
}
);
this.success[url] = true;
});
}

async loadAllLibs() {
const scriptRunners = this.getAllLibs().map((url) =>
this.loadScript(url).catch((e) => {
log.warn(e);
})
);

try {
await Promise.all(scriptRunners);
} catch (e) {
log.warn("load preload libs error:", e);
}
}

async run(id: string, externalLibs: string[] = [], runInHost: boolean = false) {
this.externalLibs = externalLibs;
this.runInHost = runInHost;
return this.loadAllLibs();
}

async clear(): Promise<any> {
clearMockWindow();
}
}

const LibsComp = withPropertyViewFn(LibsCompBase, (comp) => {
useEffect(() => {
comp.loadAllLibs();
}, [comp.getView().length]);
return (
<ScrollBar style={{ height: "295px" }}>
{comp.getAllLibs().length === 0 && (
<EmptyContent text={trans("preLoad.jsLibraryEmptyContent")} style={{ margin: "0 16px" }} />
)}
<JSLibraryTree
mode={"column"}
libs={comp
.getView()
.map((i) => ({
url: i.getView(),
deletable: true,
exportedAs: comp.globalVars[i.getView()]?.[0],
}))
.concat(
comp.externalLibs.map((l) => ({
url: l,
deletable: false,
exportedAs: comp.globalVars[l]?.[0],
}))
)}
onDelete={(idx) => {
comp.dispatch(comp.deleteAction(idx));
}}
/>
</ScrollBar>
);
});

function runScript(code: string, inHost?: boolean) {
if (inHost) {
runScriptInHost(code);
return;
}
try {
evalFunc(code, {}, {});
} catch (e) {
log.error(e);
}
}

class ScriptComp extends CodeTextControl implements RunAndClearable<string> {
runInHost: boolean = false;

runPreloadScript() {
const code = this.getView();
if (!code) {
return;
}
runScript(code, this.runInHost);
}

async run(id: string, externalScript: string = "", runInHost: boolean = false) {
this.runInHost = runInHost;
if (externalScript) {
runScript(externalScript, runInHost);
}
this.runPreloadScript();
}

async clear(): Promise<any> {
clearMockWindow();
}
}

class CSSComp extends CodeTextControl implements RunAndClearable<string> {
id = "";
externalCSS: string = "";

async applyAllCSS() {
const css = this.getView();
evalStyle(this.id, [this.externalCSS, css]);
}

async run(id: string, externalCSS: string = "") {
this.id = id;
this.externalCSS = externalCSS;
return this.applyAllCSS();
}

async clear() {
clearStyleEval(this.id);
}
}

class GlobalCSSComp extends CodeTextControl implements RunAndClearable<string> {
id = "";
externalCSS: string = "";

async applyAllCSS() {
const css = this.getView();
evalStyle(this.id, [this.externalCSS, css], true);
}

async run(id: string, externalCSS: string = "") {
this.id = id;
this.externalCSS = externalCSS;
return this.applyAllCSS();
}

async clear() {
clearStyleEval(this.id);
}
}

const childrenMap = {
libs: LibsComp,
script: ScriptComp,
css: CSSComp,
globalCSS: GlobalCSSComp,
};

type ChildrenInstance = RecordConstructorToComp<typeof childrenMap>;

function JavaScriptTabPane(props: { comp: ConstructorToComp<typeof ScriptComp> }) {
useEffect(() => {
props.comp.runPreloadScript();
}, [props.comp]);

const codePlaceholder = `window.name = 'Tom';\nwindow.greet = () => "hello world";`;

return (
<>
<HelpText style={{ marginBottom: 20 }}>{trans("preLoad.jsHelpText")}</HelpText>
{props.comp.propertyView({
expandable: false,
styleName: "window",
codeType: "Function",
language: "javascript",
placeholder: codePlaceholder,
})}
</>
);
}

function CSSTabPane(props: { comp: CSSComp, isGlobal?: boolean }) {
useEffect(() => {
props.comp.applyAllCSS();
}, [props.comp]);

const codePlaceholder = `.top-header {\n background-color: red; \n}`;

return (
<>
<HelpText style={{ marginBottom: 20 }}>{trans("preLoad.cssHelpText")}</HelpText>
{props.comp.propertyView({
expandable: false,
placeholder: codePlaceholder,
styleName: "window",
language: "css",
})}
</>
);
}

enum TabKey {
JavaScript = "js",
CSS = "css",
GLOBAL_CSS = "global_css",
}

function PreloadConfigModal(props: ChildrenInstance) {
const [activeKey, setActiveKey] = useState(TabKey.JavaScript);
const { showScriptsAndStyleModal, changeExternalState } = useContext(ExternalEditorContext);

const tabItems = [
{
key: TabKey.JavaScript,
label: 'JavaScript',
children: <JavaScriptTabPane comp={props.script} />
},
{
key: TabKey.CSS,
label: 'CSS',
children: <CSSTabPane comp={props.css} />
},
{
key: TabKey.GLOBAL_CSS,
label: 'Global CSS',
children: <CSSTabPane comp={props.globalCSS} isGlobal />
},
]
return (
<CustomModal
draggable
mask={activeKey !== TabKey.CSS}
open={showScriptsAndStyleModal}
title={trans("preLoad.scriptsAndStyles")}
destroyOnHidden
onCancel={() => changeExternalState?.({ showScriptsAndStyleModal: false })}
showOkButton={false}
showCancelButton={false}
width="600px"
>
<Tabs
onChange={(k) => setActiveKey(k as TabKey)}
style={{ marginBottom: 8, marginTop: 4 }}
activeKey={activeKey}
items={ tabItems }
>
</Tabs>
</CustomModal>
);
}

const PreloadCompBase = new MultiCompBuilder(childrenMap, () => {})
.setPropertyViewFn((children) => <PreloadConfigModal {...children} />)
.build();

const AddJSLibraryButton = styled.div`
cursor: pointer;
margin-right: 16px;

g g {
stroke: #8b8fa3;
}

&:hover {
g g {
stroke: #222222;
}
}
`;

const JSLibraryWrapper = styled.div`
position: relative;
`;

export class PreloadComp extends PreloadCompBase {
async clear() {
return Promise.allSettled(Object.values(this.children).map((i) => i.clear()));
}

async run(id: string) {
const { orgCommonSettings = {} } = getGlobalSettings();
const { preloadCSS,preloadGlobalCSS, preloadJavaScript, preloadLibs, runJavaScriptInHost } = orgCommonSettings;
await this.children.css.run(id, preloadCSS || "");
await this.children.globalCSS.run('body', preloadGlobalCSS || "");
await this.children.libs.run(id, preloadLibs || [], !!runJavaScriptInHost);
await this.children.script.run(id, preloadJavaScript || "", !!runJavaScriptInHost);
}

getJSLibraryPropertyView() {
const libs = this.children.libs;
return (
<JSLibraryWrapper>
<BaseSection
name={trans("preLoad.jsLibrary")}
width={288}
noMargin
style={{
borderTop: "1px solid #e1e3eb",
backgroundColor: "#fff",
}}
additionalButton={
<AddJSLibraryButton>
<JSLibraryModal
runInHost={libs.runInHost}
trigger={<PlusIcon height={"46px"} />}
onCheck={(url) => !libs.getAllLibs().includes(url)}
onLoad={(url) => libs.loadScript(url)}
onSuccess={(url) => libs.dispatch(libs.pushAction(url))}
/>
</AddJSLibraryButton>
}
>
{this.children.libs.getPropertyView()}
</BaseSection>
</JSLibraryWrapper>
);
}
}
export { PreloadComp } from "./preLoadComp/preLoadComp";
Loading
Loading