From 12ac67a3733f68b343d25cd16c51d257b86b9ef4 Mon Sep 17 00:00:00 2001 From: Rahul Barwal Date: Tue, 26 Dec 2023 14:49:08 +0530 Subject: [PATCH] fix: Icons not coming up in start with template flow. (#29857) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## 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 ## 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. --- app/client/src/pages/Templates/TemplateView.tsx | 5 ++++- app/client/src/utils/editor/EditorUtils.ts | 6 +++++- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/app/client/src/pages/Templates/TemplateView.tsx b/app/client/src/pages/Templates/TemplateView.tsx index 093896c81b..aed16c1f47 100644 --- a/app/client/src/pages/Templates/TemplateView.tsx +++ b/app/client/src/pages/Templates/TemplateView.tsx @@ -24,7 +24,7 @@ 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, @@ -148,6 +148,9 @@ export function TemplateView({ history.push(TEMPLATES_PATH); }; + useEffect(() => { + registerEditorWidgets(); + }, []); useEffect(() => { dispatch(getTemplateInformation(templateId)); dispatch(getSimilarTemplatesInit(templateId)); diff --git a/app/client/src/utils/editor/EditorUtils.ts b/app/client/src/utils/editor/EditorUtils.ts index b361fc318b..52ce8faa1a 100644 --- a/app/client/src/utils/editor/EditorUtils.ts +++ b/app/client/src/utils/editor/EditorUtils.ts @@ -5,8 +5,12 @@ import { registerWidgets } from "WidgetProvider/factory/registrationHelper"; import { registerLayoutComponents } from "layoutSystems/anvil/utils/layouts/layoutUtils"; import widgets from "widgets"; -export const editorInitializer = async () => { +export const registerEditorWidgets = () => { registerWidgets(widgets); +}; + +export const editorInitializer = async () => { + registerEditorWidgets(); PropertyControlRegistry.registerPropertyControlBuilders(); // TODO: do this only for anvil. registerLayoutComponents();