Skip to content

Doc/existing components #1403

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 4 commits into from
Dec 20, 2024
Merged

Doc/existing components #1403

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
503296e
Components changes
adnanqaops Nov 20, 2024
b0a63f7
Changes on Existing Components
adnanqaops Dec 4, 2024
7b92927
added component docs for multiple components
adnanqaops Dec 20, 2024
14a3a4a
Merge branch 'dev' into doc/existing_components
adnanqaops Dec 20, 2024
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
Prev Previous commit
Next Next commit
Changes on Existing Components
  • Loading branch information
@adnanqaops
adnanqaops committed Dec 4, 2024
commit b0a63f721e01daa80459fd80a69068184ca09b3c
43 changes: 43 additions & 0 deletions client/packages/lowcoder/src/pages/ComponentDoc/examples/ButtonComp/FloatButton.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
import { FloatButtonComp } from "comps/comps/buttonComp/floatButtonComp"
import { trans } from "i18n";
import Example from "../../common/Example";
import ExampleGroup from "../../common/ExampleGroup";

export default function FloatButtonExample() {
return (
<>
<ExampleGroup
title={trans("componentDoc.basicUsage")}
description={trans("componentDoc.basicDemoDescription")}
>
<Example
title={trans("componentDoc.default")}
width={120}
config={{
text: trans("componentDoc.submit")
}}
compFactory={FloatButtonComp}
/>
<Example
title={trans("componentDoc.loading")}
width={120}
config={{
text: trans("componentDoc.submit"),
loading: true
}}
compFactory={FloatButtonComp}
/>
<Example
title={trans("componentDoc.disabled")}
width={120}
config={{
text: trans("componentDoc.submit"),
disabled: true
}}
compFactory={FloatButtonComp}
/>
</ExampleGroup>

</>
);
}
68 changes: 68 additions & 0 deletions client/packages/lowcoder/src/pages/ComponentDoc/examples/ButtonComp/IconButton.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
import { IconComp } from "comps/comps/iconComp";
import { trans } from "i18n";
import Example from "../../common/Example";
import ExampleGroup from "../../common/ExampleGroup";

export default function IconButtonExample() {
return (
<>
<ExampleGroup
title={trans("componentDoc.basicUsage")}
description={trans("componentDoc.basicDemoDescription")}
>
<Example
title={trans("componentDoc.default")}
width={20}
config={{
form: "",
type: "",
prefixIcon: "/icon:solid/align-justify",
iconSize: "30px",
aspectRatio: "1 / 1",
autoHeight: "fixed",
}}
compFactory={IconComp}
/>
<Example
title={trans("componentDoc.loading")}
width={120}
config={{ type: "default", text: trans("componentDoc.submit"), loading: true }}
compFactory={IconComp}
/>
<Example
title={trans("componentDoc.disabled")}
width={120}
config={{ type: "default", text: trans("componentDoc.submit"), disabled: true }}
compFactory={IconComp}
/>
</ExampleGroup>

<ExampleGroup title={trans("componentDoc.style")}>
<Example
title={trans("componentDoc.danger")}
width={120}
config={{
style: { backgroundColor: "#CD574C", borderColor: "#AC3A32", color: "#E0ECF6" },
}}
compFactory={IconComp}
/>
<Example
title={trans("componentDoc.warning")}
width={120}
config={{
style: { backgroundColor: "#F4A125", borderColor: "#DA7D16", color: "#000000" },
}}
compFactory={IconComp}
/>
<Example
title={trans("componentDoc.success")}
width={120}
config={{
style: { backgroundColor: "#5E8D6E", borderColor: "#40694E", color: "#E0ECF6" },
}}
compFactory={IconComp}
/>
</ExampleGroup>
</>
);
}
110 changes: 110 additions & 0 deletions client/packages/lowcoder/src/pages/ComponentDoc/examples/ButtonComp/ToggleButton.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
import { ToggleButtonComp } from "comps/comps/buttonComp/toggleButtonComp"
import { trans } from "i18n";
import Example from "../../common/Example";
import ExampleGroup from "../../common/ExampleGroup";

export default function ToggleButtonExample() {
return (
<>
<ExampleGroup
title={trans("componentDoc.basicUsage")}
description={trans("componentDoc.basicDemoDescription")}
>
<Example
title={trans("componentDoc.default")}
width={120}
config={{
text: trans("componentDoc.submit")
}}
compFactory={ToggleButtonComp}
/>
<Example
title={trans("componentDoc.loading")}
width={120}
config={{
text: trans("componentDoc.submit"),
loading: true
}}
compFactory={ToggleButtonComp}
/>
<Example
title={trans("componentDoc.disabled")}
width={120}
config={{
text: trans("componentDoc.submit"),
disabled: true
}}
compFactory={ToggleButtonComp}
/>
</ExampleGroup>

<ExampleGroup title="Advanced">
<Example
title="Hide Text"
width={120}
config={{
text: trans("componentDoc.submit"),
showText: false,
}}
compFactory={ToggleButtonComp}
/>
<Example
title="Text for True & False"
width={120}
config={{
text: trans("componentDoc.submit"),
showText: true,
trueText: "True",
falseText: "False",
}}
compFactory={ToggleButtonComp}
/>
<Example
title="Icon Position"
width={120}
config={{
text: trans("componentDoc.submit"),
iconPosition: "left",
}}
compFactory={ToggleButtonComp}
/>
<Example
title="Content Alignment - Left"
width={180}
config={{
text: trans("componentDoc.submit"),
alignment: "left",
}}
compFactory={ToggleButtonComp}
/>
<Example
title="Content Alignment - Right"
width={180}
config={{
text: trans("componentDoc.submit"),
alignment: "right",
}}
compFactory={ToggleButtonComp}
/>
<Example
title="Content Alignment - Center"
width={180}
config={{
text: trans("componentDoc.submit"),
alignment: "center",
}}
compFactory={ToggleButtonComp}
/>
<Example
title="Content Alignment - Justified"
width={180}
config={{
text: trans("componentDoc.submit"),
alignment: "stretch",
}}
compFactory={ToggleButtonComp}
/>
</ExampleGroup>
</>
);
}
4 changes: 4 additions & 0 deletions client/packages/lowcoder/src/pages/ComponentDoc/examples/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import { UICompType } from "comps/uiCompRegistry";
import ButtonExample from "./ButtonComp/Button";
import IconButtonExample from "./ButtonComp/IconButton";
import ToggleButtonExample from "./ButtonComp/ToggleButton";
import InputExample from "./textInputComp/Input";
import PasswordExample from "./textInputComp/Password";
import TextAreaExample from "./textInputComp/TextArea";
Expand Down Expand Up @@ -36,6 +38,8 @@ import IFrameExample from "./IFrame";

const examples: { [key in UICompType]?: React.FunctionComponent } = {
button: ButtonExample,
controlButton: IconButtonExample,
toggleButton: ToggleButtonExample,
input: InputExample,
textArea: TextAreaExample,
password: PasswordExample,
Expand Down
23 changes: 23 additions & 0 deletions client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/chart.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ export default function ChartExample() {
compFactory={ChartCompWithDefault}
/>
</ExampleGroup>

<ExampleGroup title={trans("componentDoc.line")}>
<Example
title={trans("componentDoc.basicLine")}
Expand Down Expand Up @@ -221,6 +222,7 @@ export default function ChartExample() {
compFactory={ChartCompWithDefault}
/>
</ExampleGroup>

<ExampleGroup title={trans("componentDoc.scatter")}>
<Example
title={trans("componentDoc.circle")}
Expand Down Expand Up @@ -316,6 +318,7 @@ export default function ChartExample() {
compFactory={ChartCompWithDefault}
/>
</ExampleGroup>

<ExampleGroup title={trans("componentDoc.pie")}>
<Example
title={trans("componentDoc.basicPie")}
Expand Down Expand Up @@ -363,6 +366,26 @@ export default function ChartExample() {
compFactory={ChartCompWithDefault}
/>
</ExampleGroup>

<ExampleGroup title={trans("componentDoc.pie")}>
<Example
title={trans("componentDoc.basicPie")}
width={500}
height={300}
nameMap={{ "chartConfig.comp.type": trans("componentDoc.pieChatType") }}
blackListConfig={blackListConfig}
config={{
mode: "map",
data: data,
series: series,
chartConfig: {
compType: "bar",
comp: { type: "basicBar" },
},
}}
compFactory={ChartCompWithDefault}
/>
</ExampleGroup>
</>
);
}