PromucFlow_constructor/app/client/src/pages/Templates/TemplateView.tsx
Rahul Barwal 12ac67a373
fix: Icons not coming up in start with template flow. (#29857)
## Description
This PR registers the editor widgets in the TemplateView component by
calling the `registeEditorWidgets` function from `EditorUtils`. This
ensures that the necessary widgets(&icons) are available for use in the
start with template flow.

#### PR fixes following issue(s)
Fixes # (issue number)
> if no issue exists, please create an issue and ask the maintainers
about this first
>
>
#### Media
> A video or a GIF is preferred. when using Loom, don’t embed because it
looks like it’s a GIF. instead, just link to the video
>
>
#### Type of change
> Please delete options that are not relevant.
- Bug fix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)
- Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- Chore (housekeeping or task changes that don't impact user perception)
- This change requires a documentation update
>
>
>
## Testing
>
#### How Has This Been Tested?
> Please describe the tests that you ran to verify your changes. Also
list any relevant details for your test configuration.
> Delete anything that is not relevant
- [ ] Manual
- [ ] JUnit
- [ ] Jest
- [ ] Cypress
>
>
#### Test Plan
> Add Testsmith test cases links that relate to this PR
>
>
#### Issues raised during DP testing
> Link issues raised during DP testing for better visiblity and tracking
(copy link from comments dropped on this PR)
>
>
>
## Checklist:
#### Dev activity
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] PR is being merged under a feature flag


#### QA activity:
- [ ] [Speedbreak
features](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#speedbreakers-)
have been covered
- [ ] Test plan covers all impacted features and [areas of
interest](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#areas-of-interest-)
- [ ] Test plan has been peer reviewed by project stakeholders and other
QA members
- [ ] Manually tested functionality on DP
- [ ] We had an implementation alignment call with stakeholders post QA
Round 2
- [ ] Cypress test cases have been added and approved by SDET/manual QA
- [ ] Added `Test Plan Approved` label after Cypress tests were reviewed
- [ ] Added `Test Plan Approved` label after JUnit tests were reviewed


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Refactor**
- Improved the initialization process of the editor for enhanced
performance and reliability.

- **New Features**
- Integrated new widgets into the editor to expand functionality for
users.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2023-12-26 14:49:08 +05:30

222 lines
5.9 KiB
TypeScript

import React, { useEffect, useRef } from "react";
import styled from "styled-components";
import { Classes } from "@blueprintjs/core";
import { useParams } from "react-router";
import { useDispatch, useSelector } from "react-redux";
import EntityNotFoundPane from "pages/Editor/EntityNotFoundPane";
import type { Template as TemplateInterface } from "api/TemplatesApi";
import {
getActiveTemplateSelector,
getForkableWorkspaces,
isFetchingTemplateSelector,
} from "selectors/templatesSelectors";
import {
getSimilarTemplatesInit,
getTemplateInformation,
} from "actions/templateActions";
import type { AppState } from "@appsmith/reducers";
import history from "utils/history";
import { TEMPLATES_PATH } from "constants/routes";
import { Colors } from "constants/Colors";
import AnalyticsUtil from "utils/AnalyticsUtil";
import ReconnectDatasourceModal from "pages/Editor/gitSync/ReconnectDatasourceModal";
import TemplateDescription from "./Template/TemplateDescription";
import SimilarTemplates from "./Template/SimilarTemplates";
import { templateIdUrl } from "@appsmith/RouteBuilder";
import TemplateViewHeader from "./TemplateViewHeader";
import { registerEditorWidgets } from "utils/editor/EditorUtils";
const breakpointColumnsObject = {
default: 4,
3000: 3,
1500: 3,
1024: 2,
800: 1,
};
const Wrapper = styled.div`
overflow: auto;
position: relative;
`;
const TemplateViewWrapper = styled.div`
padding-right: 132px;
padding-left: 132px;
padding-top: var(--ads-v2-spaces-7);
padding-bottom: 80px;
background-color: var(--ads-v2-color-bg);
`;
export const IframeWrapper = styled.div`
border-radius: 16px;
margin-top: ${(props) => props.theme.spaces[12]}px;
iframe {
border-radius: 0px 0px 16px 16px;
box-shadow:
0px 20px 24px -4px rgba(16, 24, 40, 0.1),
0px 8px 8px -4px rgba(16, 24, 40, 0.04);
width: 100%;
height: 734px;
}
`;
export const IframeTopBar = styled.div`
width: 100%;
background-color: var(--ads-v2-color-bg-muted);
border-radius: 8px 8px 0px 0px;
display: flex;
gap: ${(props) => props.theme.spaces[3]}px;
height: 41px;
align-items: center;
padding-left: ${(props) => props.theme.spaces[5]}px;
.round {
height: 12px;
width: 12px;
border-radius: var(--ads-v2-border-radius-circle);
}
.red {
background-color: ${Colors.PERSIMMON};
}
.yellow {
background-color: ${Colors.SUNGLOW_2};
}
.green {
background-color: ${Colors.MOUNTAIN_MEADOW};
}
`;
const PageWrapper = styled.div`
display: flex;
margin-top: ${(props) => props.theme.homePage.header}px;
height: calc(100vh - ${(props) => props.theme.homePage.header}px);
`;
const LoadingWrapper = styled.div`
width: calc(100vw);
.title-placeholder {
margin-top: ${(props) => props.theme.spaces[11]}px;
height: 28px;
width: 100%;
}
.iframe-placeholder {
margin-top: ${(props) => props.theme.spaces[12]}px;
height: 500px;
width: 100%;
}
`;
function TemplateViewLoader() {
return (
<LoadingWrapper>
<TemplateViewWrapper>
<div className={`title-placeholder ${Classes.SKELETON}`} />
<div className={`iframe-placeholder ${Classes.SKELETON}`} />
</TemplateViewWrapper>
</LoadingWrapper>
);
}
function TemplateNotFound() {
return <EntityNotFoundPane />;
}
interface TemplateViewProps {
onClickUseTemplate?: (id: string) => void;
showBack?: boolean;
showSimilarTemplate?: boolean;
templateId: string;
}
export function TemplateView({
onClickUseTemplate,
showBack = true,
showSimilarTemplate = true,
templateId,
}: TemplateViewProps) {
const dispatch = useDispatch();
const similarTemplates = useSelector(
(state: AppState) => state.ui.templates.similarTemplates,
);
const isFetchingTemplate = useSelector(isFetchingTemplateSelector);
const workspaceList = useSelector(getForkableWorkspaces);
const currentTemplate = useSelector(getActiveTemplateSelector);
const containerRef = useRef<HTMLDivElement>(null);
const goToTemplateListView = () => {
history.push(TEMPLATES_PATH);
};
useEffect(() => {
registerEditorWidgets();
}, []);
useEffect(() => {
dispatch(getTemplateInformation(templateId));
dispatch(getSimilarTemplatesInit(templateId));
if (containerRef.current) {
containerRef.current.scrollTo({ top: 0 });
}
}, [templateId]);
const onSimilarTemplateClick = (template: TemplateInterface) => {
AnalyticsUtil.logEvent("SIMILAR_TEMPLATE_CLICK", {
from: {
id: currentTemplate?.id,
name: currentTemplate?.title,
},
to: {
id: template.id,
name: template.title,
},
});
history.push(templateIdUrl({ id: template.id }));
};
return isFetchingTemplate ? (
<TemplateViewLoader />
) : !currentTemplate ? (
<TemplateNotFound />
) : (
<Wrapper ref={containerRef}>
<ReconnectDatasourceModal />
<TemplateViewWrapper>
<TemplateViewHeader
onClickUseTemplate={onClickUseTemplate}
showBack={showBack}
templateId={templateId}
/>
<IframeWrapper>
<IframeTopBar>
<div className="round red" />
<div className="round yellow" />
<div className="round green" />
</IframeTopBar>
<iframe src={currentTemplate.appUrl} width={"100%"} />
</IframeWrapper>
<TemplateDescription template={currentTemplate} />
</TemplateViewWrapper>
{showSimilarTemplate && (
<SimilarTemplates
breakpointCols={breakpointColumnsObject}
isForkingEnabled={!!workspaceList.length}
onBackPress={goToTemplateListView}
onClick={onSimilarTemplateClick}
similarTemplates={similarTemplates}
/>
)}
</Wrapper>
);
}
function TemplateViewContainer() {
const params = useParams<{ templateId: string }>();
return (
<PageWrapper>
<TemplateView templateId={params.templateId} />
</PageWrapper>
);
}
export default TemplateViewContainer;