From 21d63be4b4ecd0094d1578548a785a5857eec71f Mon Sep 17 00:00:00 2001 From: Igor Carvalho Date: Tue, 18 Jul 2023 15:29:58 -0300 Subject: [PATCH] Add inline code documentation --- .../GenericNode/components/parameterComponent/index.tsx | 1 + src/frontend/src/components/floatComponent/index.tsx | 1 + src/frontend/src/components/headerComponent/index.tsx | 1 + src/frontend/src/components/inputComponent/index.tsx | 1 + src/frontend/src/components/inputFileComponent/index.tsx | 2 ++ src/frontend/src/components/intComponent/index.tsx | 1 + src/frontend/src/components/textAreaComponent/index.tsx | 1 + src/frontend/src/components/toggleComponent/index.tsx | 2 ++ src/frontend/src/modals/codeAreaModal/index.tsx | 1 + src/frontend/src/pages/CommunityPage/index.tsx | 1 + 10 files changed, 12 insertions(+) diff --git a/src/frontend/src/CustomNodes/GenericNode/components/parameterComponent/index.tsx b/src/frontend/src/CustomNodes/GenericNode/components/parameterComponent/index.tsx index 2d93ca1ac..bd9ea03ab 100644 --- a/src/frontend/src/CustomNodes/GenericNode/components/parameterComponent/index.tsx +++ b/src/frontend/src/CustomNodes/GenericNode/components/parameterComponent/index.tsx @@ -54,6 +54,7 @@ export default function ParameterComponent({ const { closePopUp } = useContext(PopUpContext); const { setTabsState, tabId, save } = useContext(TabsContext); + // Update component position useEffect(() => { if (ref.current && ref.current.offsetTop && ref.current.clientHeight) { setPosition(ref.current.offsetTop + ref.current.clientHeight / 2); diff --git a/src/frontend/src/components/floatComponent/index.tsx b/src/frontend/src/components/floatComponent/index.tsx index 548d608a3..66b97db1a 100644 --- a/src/frontend/src/components/floatComponent/index.tsx +++ b/src/frontend/src/components/floatComponent/index.tsx @@ -18,6 +18,7 @@ export default function FloatComponent({ const min = 0; const max = 1; + // Clear component state useEffect(() => { if (disabled) { setMyValue(""); diff --git a/src/frontend/src/components/headerComponent/index.tsx b/src/frontend/src/components/headerComponent/index.tsx index 0a8b39f89..b0205ce3c 100644 --- a/src/frontend/src/components/headerComponent/index.tsx +++ b/src/frontend/src/components/headerComponent/index.tsx @@ -27,6 +27,7 @@ export default function Header() { const [stars, setStars] = useState(null); + // Get and set numbers of stars on header useEffect(() => { async function fetchStars() { const starsCount = await getRepoStars("logspace-ai", "langflow"); diff --git a/src/frontend/src/components/inputComponent/index.tsx b/src/frontend/src/components/inputComponent/index.tsx index 8d564bdcd..1e6ca32ef 100644 --- a/src/frontend/src/components/inputComponent/index.tsx +++ b/src/frontend/src/components/inputComponent/index.tsx @@ -17,6 +17,7 @@ export default function InputComponent({ const { setDisableCopyPaste } = useContext(TabsContext); const { closePopUp } = useContext(PopUpContext); + // Clear component state useEffect(() => { if (disabled) { setMyValue(""); diff --git a/src/frontend/src/components/inputFileComponent/index.tsx b/src/frontend/src/components/inputFileComponent/index.tsx index 3d4b8000f..3f77734f3 100644 --- a/src/frontend/src/components/inputFileComponent/index.tsx +++ b/src/frontend/src/components/inputFileComponent/index.tsx @@ -18,6 +18,8 @@ export default function InputFileComponent({ const [loading, setLoading] = useState(false); const { setErrorData } = useContext(alertContext); const { tabId } = useContext(TabsContext); + + // Clear component state useEffect(() => { if (disabled) { setMyValue(""); diff --git a/src/frontend/src/components/intComponent/index.tsx b/src/frontend/src/components/intComponent/index.tsx index 09c342712..ae47d856a 100644 --- a/src/frontend/src/components/intComponent/index.tsx +++ b/src/frontend/src/components/intComponent/index.tsx @@ -15,6 +15,7 @@ export default function IntComponent({ const min = 0; const { closePopUp } = useContext(PopUpContext); + // Clear component state useEffect(() => { if (disabled) { setMyValue(""); diff --git a/src/frontend/src/components/textAreaComponent/index.tsx b/src/frontend/src/components/textAreaComponent/index.tsx index 511694bf8..e9f540e41 100644 --- a/src/frontend/src/components/textAreaComponent/index.tsx +++ b/src/frontend/src/components/textAreaComponent/index.tsx @@ -16,6 +16,7 @@ export default function TextAreaComponent({ const { openPopUp, closePopUp } = useContext(PopUpContext); const { setDisableCopyPaste } = useContext(TabsContext); + // Clear text area useEffect(() => { if (disabled) { setMyValue(""); diff --git a/src/frontend/src/components/toggleComponent/index.tsx b/src/frontend/src/components/toggleComponent/index.tsx index 107e65b20..ec0c8aab3 100644 --- a/src/frontend/src/components/toggleComponent/index.tsx +++ b/src/frontend/src/components/toggleComponent/index.tsx @@ -8,6 +8,8 @@ export default function ToggleComponent({ setEnabled, disabled, }: ToggleComponentType) { + + // set component state as disabled useEffect(() => { if (disabled) { setEnabled(false); diff --git a/src/frontend/src/modals/codeAreaModal/index.tsx b/src/frontend/src/modals/codeAreaModal/index.tsx index 8c82e7477..a94c65d02 100644 --- a/src/frontend/src/modals/codeAreaModal/index.tsx +++ b/src/frontend/src/modals/codeAreaModal/index.tsx @@ -39,6 +39,7 @@ export default function CodeAreaModal({ } } + // Check for custom code errors function handleClick() { postValidateCode(code) .then((apiReturn) => { diff --git a/src/frontend/src/pages/CommunityPage/index.tsx b/src/frontend/src/pages/CommunityPage/index.tsx index e5b8b800f..c3d028314 100644 --- a/src/frontend/src/pages/CommunityPage/index.tsx +++ b/src/frontend/src/pages/CommunityPage/index.tsx @@ -37,6 +37,7 @@ export default function CommunityPage() { } const navigate = useNavigate(); + // Show community examples on page start useEffect(() => { handleExamples(); }, []);