Skip to content

Commit d5aec39

Browse files
author
FalkWolsky
committed
Adding Module Documentation
1 parent 9d9a137 commit d5aec39

File tree

3 files changed

+56
-47
lines changed

3 files changed

+56
-47
lines changed

client/packages/lowcoder/src/comps/comps/moduleContainerComp/moduleEventListComp.tsx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ import { trans } from "i18n";
1111
import { ModuleEventListItemComp } from "./moduleEventListItemComp";
1212
import { ConfigViewSection } from "./styled";
1313
import { messageInstance } from "lowcoder-design";
14+
import { DocLink } from "lowcoder-design";
15+
import { markdownCompCss, TacoMarkDown } from "lowcoder-design";
1416

1517
const ModuleEventListComp = list(ModuleEventListItemComp);
1618

@@ -73,6 +75,9 @@ export class ModuleEventComp extends simpleMultiComp({
7375
onDelete={(i) => this.handleDelete(i)}
7476
items={children}
7577
/>
78+
<><br/><TacoMarkDown>{trans("module.documentationText")}</TacoMarkDown><br/><DocLink style={{ marginTop: 8 }} href={trans("docUrls.module")} title={trans("module.documentationText")}>
79+
{trans("module.docLink")}
80+
</DocLink></>
7681
</ConfigViewSection>
7782
);
7883
}

client/packages/lowcoder/src/comps/comps/treeComp/treeSelectComp.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import { StringControl } from "comps/controls/codeControl";
2525
import { SelectEventHandlerControl } from "comps/controls/eventHandlerControl";
2626
import { selectInputValidate } from "../selectInputComp/selectInputConstants";
2727
import { BoolControl } from "comps/controls/boolControl";
28-
import { stateComp } from "comps/generators/simpleGenerators";
28+
import { stateComp, withDefault } from "comps/generators/simpleGenerators";
2929
import { trans } from "i18n";
3030
import {
3131
allowClearPropertyView,
@@ -59,7 +59,7 @@ const childrenMap = {
5959
selectType: dropdownControl(selectTypeOptions, "single"),
6060
checkedStrategy: dropdownControl(checkedStrategyOptions, "parent"),
6161
label: LabelControl,
62-
placeholder: StringControl,
62+
placeholder: withDefault(StringControl, trans("tree.placeholder")),
6363
// TODO: more event
6464
onEvent: SelectEventHandlerControl,
6565
allowClear: BoolControl,

client/packages/lowcoder/src/i18n/locales/en.ts

Lines changed: 49 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -974,6 +974,7 @@ export const en = {
974974
"code": "Code of your Custom Component",
975975
},
976976
"tree": {
977+
"placeholder": "Please Select",
977978
"selectType": "Select Type",
978979
"noSelect": "No Select",
979980
"singleSelect": "Single Select",
@@ -1893,6 +1894,8 @@ export const en = {
18931894
},
18941895
"module": {
18951896
"emptyText": "No Data",
1897+
"docLink": "Read More About Modules...",
1898+
"documentationText" : "Lowcoder Modules are complete Applications, that can get included and repeated in other Lowcoder Applications. You can insert a module into an app or other modules (referred to as external apps in the rest of this document) and it functions just like a single component. As modules can get embedded, they need to be able to interact with your outside apps or websites. This four settings help to support communication with a Module.",
18961899
"circularReference": "Circular Reference, Current Module/Application Cannot Be Used!",
18971900
"emptyTestInput": "The Current Module Has No Input to Test",
18981901
"emptyTestMethod": "The Current Module Has No Method to Test",
@@ -2294,49 +2297,6 @@ export const en = {
22942297
"alignment": "Alignment",
22952298
"showBorder": "Show Border"
22962299
},
2297-
docUrls: {
2298-
docHome: "https://docs.lowcoder.cloud/",
2299-
components: "https://app.lowcoder.cloud/components/{compType}",
2300-
module: "https://docs.lowcoder.cloud/lowcoder-documentation/build-applications/create-a-new-app/modules",
2301-
optionList: "",
2302-
terms: "https://lowcoder.cloud/terms",
2303-
privacy: "https://lowcoder.cloud/privacy",
2304-
aboutUs: "https://lowcoder.cloud/about",
2305-
changeLog: "https://github.com/lowcoder-org/lowcoder/releases",
2306-
introVideo: "",
2307-
devNpmPlugin: "https://docs.lowcoder.cloud/lowcoder-extension/develop-data-source-plugins",
2308-
devNpmPluginText: "How to develop npm plugin",
2309-
useHost: "https://docs.lowcoder.cloud/setup-and-run/self-hosting/access-local-database-or-api",
2310-
eventHandlerSlowdown: "https://docs.lowcoder.cloud/build-applications/app-interaction/event-handlers",
2311-
thirdLib: "https://docs.lowcoder.cloud/lowcoder-extension/use-third-party-libraries-in-apps",
2312-
thirdLibUrlText: "Use third-party libraries",
2313-
},
2314-
datasourceTutorial: {
2315-
mysql: "",
2316-
mongodb: "",
2317-
postgres: "",
2318-
redis: "",
2319-
es: "",
2320-
smtp: "",
2321-
clickHouse: "",
2322-
},
2323-
queryTutorial: {
2324-
js: "",
2325-
transformer: "https://docs.lowcoder.cloud/business-logic-in-apps/write-javascript/transformers",
2326-
tempState: "https://docs.lowcoder.cloud/business-logic-in-apps/write-javascript/temporary-state",
2327-
dataResponder: "https://docs.lowcoder.cloud/lowcoder-documentation/business-logic-in-apps/write-javascript/data-responder",
2328-
},
2329-
customComponent: {
2330-
entryUrl: "https://sdk.lowcoder.cloud/custom_component.html",
2331-
},
2332-
template: {
2333-
cloneUrl: "/apps/template-import/",
2334-
},
2335-
lowcoderUrl: {
2336-
createIssue: "https://github.com/lowcoder-org/lowcoder/issues",
2337-
discord: "https://discord.com/invite/qMG9uTmAx2",
2338-
},
2339-
23402300

23412301
// twenty-first part
23422302

@@ -2560,7 +2520,7 @@ export const en = {
25602520
"playground": {
25612521
"url": "https://app.lowcoder.cloud/playground/{compType}/1",
25622522
"data": "Current Data State",
2563-
"preview": "Preview",
2523+
"preview": "Preview (please mind, that your Editor-Layout/Logic Mode is active here too. You can set it to 'Both' in the App Editor to see all properties here too)",
25642524
"property": "Properties",
25652525
"console": "Visual Script Console",
25662526
"executeMethods": "Execute Methods",
@@ -2740,7 +2700,51 @@ export const en = {
27402700
"widthTooltip": "Pixel or Percentage, e.g. 520, 60%",
27412701
"navStyle": "Menu Style",
27422702
"navItemStyle": "Menu Item Style"
2743-
}
2703+
},
2704+
2705+
docUrls: {
2706+
docHome: "https://docs.lowcoder.cloud/",
2707+
components: "https://app.lowcoder.cloud/components/{compType}",
2708+
module: "https://docs.lowcoder.cloud/lowcoder-documentation/build-applications/create-a-new-app/modules",
2709+
optionList: "",
2710+
terms: "https://lowcoder.cloud/terms",
2711+
privacy: "https://lowcoder.cloud/privacy",
2712+
aboutUs: "https://lowcoder.cloud/about",
2713+
changeLog: "https://github.com/lowcoder-org/lowcoder/releases",
2714+
introVideo: "",
2715+
devNpmPlugin: "https://docs.lowcoder.cloud/lowcoder-extension/develop-data-source-plugins",
2716+
devNpmPluginText: "How to develop npm plugin",
2717+
useHost: "https://docs.lowcoder.cloud/setup-and-run/self-hosting/access-local-database-or-api",
2718+
eventHandlerSlowdown: "https://docs.lowcoder.cloud/build-applications/app-interaction/event-handlers",
2719+
thirdLib: "https://docs.lowcoder.cloud/lowcoder-extension/use-third-party-libraries-in-apps",
2720+
thirdLibUrlText: "Use third-party libraries",
2721+
},
2722+
datasourceTutorial: {
2723+
mysql: "",
2724+
mongodb: "",
2725+
postgres: "",
2726+
redis: "",
2727+
es: "",
2728+
smtp: "",
2729+
clickHouse: "",
2730+
},
2731+
queryTutorial: {
2732+
js: "",
2733+
transformer: "https://docs.lowcoder.cloud/business-logic-in-apps/write-javascript/transformers",
2734+
tempState: "https://docs.lowcoder.cloud/business-logic-in-apps/write-javascript/temporary-state",
2735+
dataResponder: "https://docs.lowcoder.cloud/lowcoder-documentation/business-logic-in-apps/write-javascript/data-responder",
2736+
},
2737+
customComponent: {
2738+
entryUrl: "https://sdk.lowcoder.cloud/custom_component.html",
2739+
},
2740+
template: {
2741+
cloneUrl: "/apps/template-import/",
2742+
},
2743+
lowcoderUrl: {
2744+
createIssue: "https://github.com/lowcoder-org/lowcoder/issues",
2745+
discord: "https://discord.com/invite/qMG9uTmAx2",
2746+
},
2747+
27442748
};
27452749

27462750
// const jsonString = JSON.stringify(en, null, 2);

0 commit comments

Comments
 (0)