PromucFlow_constructor/app/client/src/sagas/AppThemingSaga.tsx

277 lines
6.8 KiB
TypeScript
Raw Normal View History

feat: App Theming (#9714) * fix style bugs * fix select styles * test: fix font size issue for cypress tests * incorporate ashit feedback * test: addresed review comments for cypress tests * add analytics events * height issue in view mode * incorporate code review feedbacks * incorporate code review feedbacks * refactor: addressed review comments; removed border radius and box shadow for text widget; Updated migrations * feat: Makes shadow and radius controls keyboard accessible (#11547) * makes shadow and radius controls keyboard accessible * removes unused imports * moves options out of render method * fix: changed the misnomer background property name to the relevant property name * fix: border radius issue for the map widget * address qa bugs * address qa bugs * fix ux of theming pane when widget is selected * fix: * added backgroundColor to the video widget * restricted pop-over border radius to 0.375rem * added box shadow for the input group for select widget * fix: added delete icon in the delete theme modal * address qa bugs * change checkbox column size in config * add js convertible to button color * remove unused imports * test: fixed jest tests * fix primary color typo * fix: migrations for the theming * fix: * Removed background color from MultiTreeSelect and TreeSelect component. * grouped button's menu button pop over border radius restricting to 0.375rem. * test: updated Dsl migration UT * address qa bugs * address qa bugs * fix: address qa comments * address qa bugs * fix: * migration issue; * unit test cases; * fix rating widget scroll issue * fix youtube video border radius bug * fix select widget * fix select widgets styles * address qa bugs * merge conflicts * makes the reset button keyboard accessible (#12134) * -resolved merge conflicts * address qa bugs * fix: labelTextSize migration fixes * refactor: * made changes to the fontSizeUtils function * fixed the issue related to unit tests * fix button group widget * remove unused imports * fix: fixed the text size migration for the table widget * refactor: addressed review comments for the table widget theming migration * fix button group widget * add init calls for view mode * json form init theme changes * fix: added migration for boxShadow, borderRadius and textSizes for table widget * fix broken fields * test: fixed unit tests * wip * inconsistancy fixes and schemaItem update in updateHook/fieldConfiguration * feat: init json form migration theming * json form primaryColor -> accentColor * update table widget * update table widget * object field label styling * fix: migration related to the JSON form * fix: fixed labelTextSize migration for JSON form nested widgets * property control nested stylesheet lookup * JSONForm label styles form array items * show label for checkbox field array item * fix button group widget * wip * refactor: addressed table widget review comments * refactor: addressed ashit review comments; * added childStylesheet for widgets * feat: Keyboard navigable Color Picker control (#11797) * Makes ColorPicker keyboard accessible * seperate out keyboard and mouse interactions * fix issue with not focusing back to input * Adds test for Color picker * chore: added comment for the boxShadow property * fix: * added unit test cases for the widget and property utils * resolved warning messages * wip * theme config update * fix merge conflicts * refactor: moved theming migration inside the migrations folder * fix qa bugs * fix jest test * fix: unit test cases * fix table column creation logic * refactor: addressed review comments for migrations * fix: Overriding margin and padding for custom render in the dropdown component (#12875) * * fix for custom render padding and margin in ADS dropdown * * fix for removing padding from normal render options * refactor: moved the boxShadow condition to the variable * fix qa bugs * fix: migration QA callouts for audio recorder widget * refactor: added updated comments for boxShadow migration for table widget * fix theme binfings for JSONForm fields under Object * fix table widget theming bug * fix: addressed code review comments * fix: unit test cases * fix: qa migration callouts * fix table widget theming bug * fix JSONForm currency input dropdown not submit form * Added new tests - AppThemingSpec * fix qa bugs * fix unit test * fix JSONForm cellBorderWidth to have default value post migration * fix unit test * fix qa bugs * remove unused imports * fix qa bugs * fix JSONForm input height issue * fix qa bugs * Updating Theming spec * * dropdown color fixes (#13249) * fix caching issue ; * Fixed Theming tests * fix tests * fix tab widget tests * fix: json form children level migration issue * fix table widget tests * Updated test * updated tests * updated test * updated tests * updated tests * updated pageload * fix cypress tests * remove cypress created files * fix color picker issues * Failure fixes * Fixed some more tests * fix: cypress test failures * fix tests * remove consoles * fix table tests * fix qa bugs * updating snapshots for AppPageLayout_spec as per new UI * fix rating widget bug * fix qa bugs * fix: * cypress failing tests * Migration QA callouts * Removed unused imports * update constract check algo * fix color contrast issue * fix: cypress failure test cases * update font sizes labels * fix regression bugs * fix: * JSON form labelTextSize issue fix * Updated comment for the fontSizeUtility function * migrations issues related to table widget borderRadius and boxShadow * fix: default labelTextSize issue for the Input and Select families * fix regression bugs * fix regression bugs * PassingParams spec - added wait time * fix: font family default value issue on JS toggle * fix js toggle issue in text widget * fix tests * fix tests * fix tests * fix cypress tests * fix regression bugs * fix regression bugs * fix: * refactored table widget migration function as per review comments, * added default value to the widget * fix: failing unit test cases * fix theming spec * fix cypress tests * test: fixed failed cypress test * incorporate ashit feedback * fix cypress tests * fix: addressed review comments * comment out table cypress test * fix merge conflicts * comment out color picker tests Co-authored-by: Pawan Kumar <pawankumar@Pawans-MacBook-Pro.local> Co-authored-by: keyurparalkar <keyur@appsmith.com> Co-authored-by: Aswath K <aswath@appsmith.com> Co-authored-by: Nayan <nayan@appsmith.com> Co-authored-by: Ashit Rath <ashit@appsmith.com> Co-authored-by: balajisoundar <balaji@appsmith.com> Co-authored-by: albinAppsmith <87797149+albinAppsmith@users.noreply.github.com> Co-authored-by: Aishwarya UR <aishwarya@appsmith.com> Co-authored-by: apple <nandan@thinkify.io> Co-authored-by: Parthvi Goswami <parthvigoswami@Parthvis-MacBook-Pro.local>
2022-05-04 09:45:57 +00:00
import React from "react";
import {
ChangeSelectedAppThemeAction,
DeleteAppThemeAction,
FetchAppThemesAction,
FetchSelectedAppThemeAction,
SaveAppThemeAction,
updateisBetaCardShownAction,
UpdateSelectedAppThemeAction,
} from "actions/appThemingActions";
import {
ReduxAction,
ReduxActionErrorTypes,
ReduxActionTypes,
} from "@appsmith/constants/ReduxActionConstants";
import ThemingApi from "api/AppThemingApi";
import { all, takeLatest, put, select } from "redux-saga/effects";
import { Variant } from "components/ads/common";
import { Toaster } from "components/ads/Toast";
import {
CHANGE_APP_THEME,
createMessage,
DELETE_APP_THEME,
SAVE_APP_THEME,
} from "@appsmith/constants/messages";
import { ENTITY_TYPE } from "entities/AppsmithConsole";
import { undoAction, updateReplayEntity } from "actions/pageActions";
import { getCanvasWidgets } from "selectors/entitiesSelector";
import store from "store";
import { getAppMode } from "selectors/applicationSelectors";
import { APP_MODE } from "entities/App";
import { getCurrentUser } from "selectors/usersSelectors";
import { User } from "constants/userConstants";
import { getBetaFlag, setBetaFlag, STORAGE_KEYS } from "utils/storage";
/**
* init app theming
*/
export function* initAppTheming() {
try {
const user: User = yield select(getCurrentUser);
const { email } = user;
if (email) {
const appThemingBetaFlag: boolean = yield getBetaFlag(
email,
STORAGE_KEYS.APP_THEMING_BETA_SHOWN,
);
yield put(updateisBetaCardShownAction(appThemingBetaFlag));
}
} catch (error) {}
}
/**
* fetches all themes of the application
*
* @param action
*/
// eslint-disable-next-line
export function* fetchAppThemes(action: ReduxAction<FetchAppThemesAction>) {
try {
const { applicationId } = action.payload;
const response = yield ThemingApi.fetchThemes(applicationId);
yield put({
type: ReduxActionTypes.FETCH_APP_THEMES_SUCCESS,
payload: response.data,
});
} catch (error) {
yield put({
type: ReduxActionErrorTypes.FETCH_APP_THEMES_ERROR,
payload: { error },
});
}
}
/**
* fetches the selected theme of the application
*
* @param action
*/
export function* fetchAppSelectedTheme(
// eslint-disable-next-line
action: ReduxAction<FetchSelectedAppThemeAction>,
) {
const { applicationId } = action.payload;
const mode: APP_MODE = yield select(getAppMode);
try {
// eslint-disable-next-line
const response = yield ThemingApi.fetchSelected(applicationId, mode);
yield put({
type: ReduxActionTypes.FETCH_SELECTED_APP_THEME_SUCCESS,
payload: response.data,
});
} catch (error) {
yield put({
type: ReduxActionErrorTypes.FETCH_SELECTED_APP_THEME_ERROR,
payload: { error },
});
}
}
/**
* updates the selected theme of the application
*
* @param action
*/
export function* updateSelectedTheme(
action: ReduxAction<UpdateSelectedAppThemeAction>,
) {
// eslint-disable-next-line
const { shouldReplay = true, theme, applicationId } = action.payload;
const canvasWidgets = yield select(getCanvasWidgets);
try {
yield ThemingApi.updateTheme(applicationId, theme);
yield put({
type: ReduxActionTypes.UPDATE_SELECTED_APP_THEME_SUCCESS,
payload: theme,
});
if (shouldReplay) {
yield put(
updateReplayEntity(
"canvas",
{ widgets: canvasWidgets, theme },
ENTITY_TYPE.WIDGET,
),
);
}
} catch (error) {
yield put({
type: ReduxActionErrorTypes.UPDATE_SELECTED_APP_THEME_ERROR,
payload: { error },
});
}
}
/**
* changes eelcted theme
*
* @param action
*/
export function* changeSelectedTheme(
action: ReduxAction<ChangeSelectedAppThemeAction>,
) {
const { applicationId, shouldReplay = true, theme } = action.payload;
const canvasWidgets = yield select(getCanvasWidgets);
try {
yield ThemingApi.changeTheme(applicationId, theme);
yield put({
type: ReduxActionTypes.CHANGE_SELECTED_APP_THEME_SUCCESS,
payload: theme,
});
// shows toast
Toaster.show({
text: createMessage(CHANGE_APP_THEME, theme.name),
variant: Variant.success,
actionElement: (
<span onClick={() => store.dispatch(undoAction())}>Undo</span>
),
});
if (shouldReplay) {
yield put(
updateReplayEntity(
"canvas",
{ widgets: canvasWidgets, theme },
ENTITY_TYPE.WIDGET,
),
);
}
} catch (error) {
yield put({
type: ReduxActionErrorTypes.UPDATE_SELECTED_APP_THEME_ERROR,
payload: { error },
});
}
}
/**
* save and create new theme from selected theme
*
* @param action
*/
export function* saveSelectedTheme(action: ReduxAction<SaveAppThemeAction>) {
const { applicationId, name } = action.payload;
try {
const response = yield ThemingApi.saveTheme(applicationId, { name });
yield put({
type: ReduxActionTypes.SAVE_APP_THEME_SUCCESS,
payload: response.data,
});
// shows toast
Toaster.show({
text: createMessage(SAVE_APP_THEME, name),
variant: Variant.success,
});
} catch (error) {
yield put({
type: ReduxActionErrorTypes.SAVE_APP_THEME_ERROR,
payload: { error },
});
}
}
/**
* deletes custom saved theme
*
* @param action
*/
export function* deleteTheme(action: ReduxAction<DeleteAppThemeAction>) {
const { name, themeId } = action.payload;
try {
yield ThemingApi.deleteTheme(themeId);
yield put({
type: ReduxActionTypes.DELETE_APP_THEME_SUCCESS,
payload: { themeId },
});
// shows toast
Toaster.show({
text: createMessage(DELETE_APP_THEME, name),
variant: Variant.success,
});
} catch (error) {
yield put({
type: ReduxActionErrorTypes.DELETE_APP_THEME_ERROR,
payload: { error },
});
}
}
function* closeisBetaCardShown() {
try {
const user: User = yield select(getCurrentUser);
const { email } = user;
if (email) {
yield setBetaFlag(email, STORAGE_KEYS.APP_THEMING_BETA_SHOWN, true);
}
} catch (error) {}
}
export default function* appThemingSaga() {
yield all([takeLatest(ReduxActionTypes.INITIALIZE_EDITOR, initAppTheming)]);
yield all([
takeLatest(ReduxActionTypes.FETCH_APP_THEMES_INIT, fetchAppThemes),
takeLatest(
ReduxActionTypes.FETCH_SELECTED_APP_THEME_INIT,
fetchAppSelectedTheme,
),
takeLatest(
ReduxActionTypes.UPDATE_SELECTED_APP_THEME_INIT,
updateSelectedTheme,
),
takeLatest(
ReduxActionTypes.CHANGE_SELECTED_APP_THEME_INIT,
changeSelectedTheme,
),
takeLatest(ReduxActionTypes.SAVE_APP_THEME_INIT, saveSelectedTheme),
takeLatest(ReduxActionTypes.DELETE_APP_THEME_INIT, deleteTheme),
takeLatest(ReduxActionTypes.CLOSE_BETA_CARD_SHOWN, closeisBetaCardShown),
]);
}