Skip to content
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

fix: query tab scrollbar padding gap fix #38317

Merged
merged 4 commits into from
Dec 25, 2024
Merged

fix: query tab scrollbar padding gap fix #38317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fdf874a
fix: co-locate request tabs within editor form & refactor overflow
alex-golovanov Dec 23, 2024
4d47a03
chore: flip tooltip orientation to prevent clipping
alex-golovanov Dec 23, 2024
a8c4b4c
chore: organize import paths
alex-golovanov Dec 25, 2024
85399db
fix: prevent sticky header from scrolling
alex-golovanov Dec 25, 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
2 changes: 1 addition & 1 deletion app/client/src/PluginActionEditor/components/PluginActionForm/PluginActionForm.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ const PluginActionForm = () => {
const { plugin } = usePluginActionContext();

return (
<Flex flex="1" overflow="hidden" p="spaces-4" w="100%">
<Flex flex="1" overflow="auto" p="spaces-4" w="100%">
{plugin.uiComponent === UIComponentTypes.ApiEditorForm && (
<APIEditorForm />
)}
Expand Down
138 changes: 101 additions & 37 deletions ...ActionEditor/components/PluginActionForm/components/CommonEditorForm/CommonEditorForm.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,19 @@
import React from "react";
import { Tab, TabsList } from "@appsmith/ads";
import { type Action } from "entities/Action";
import { EditorTheme } from "components/editorComponents/CodeEditor/EditorConfig";
import { InfoFields } from "./InfoFields";
import { RequestTabs } from "./RequestTabs";
import { HintMessages } from "./HintMessages";
import { Flex } from "@appsmith/ads";
import { API_EDITOR_TABS } from "PluginActionEditor/constants/CommonApiConstants";
import { API_EDITOR_TAB_TITLES, createMessage } from "ee/constants/messages";

import useGetFormActionValues from "./hooks/useGetFormActionValues";
import { DatasourceConfig } from "./components/DatasourceConfig";
import { HintMessages } from "./HintMessages";
import { InfoFields } from "./InfoFields";
import KeyValueFieldArray from "components/editorComponents/form/fields/KeyValueFieldArray";
import ApiAuthentication from "./components/ApiAuthentication";
import { useSelectedFormTab } from "./hooks/useSelectedFormTab";
import { getHeadersCount, getParamsCount } from "./utils";
import * as Styled from "./styles";

interface Props {
httpMethodOptions: { value: string }[];
Expand All @@ -18,7 +26,13 @@ interface Props {
}

const CommonEditorForm = (props: Props) => {
const { action } = props;
const {
action,
bodyUIComponent,
formName,
isChangePermitted,
paginationUiComponent,
} = props;
const hintMessages = action.messages || [];
const theme = EditorTheme.LIGHT;
const {
Expand All @@ -29,39 +43,89 @@ const CommonEditorForm = (props: Props) => {
datasourceParams,
} = useGetFormActionValues();

const [currentTab, setCurrentTab] = useSelectedFormTab();
const headersCount = getHeadersCount(
actionHeaders,
datasourceHeaders,
autoGeneratedHeaders,
);
const paramsCount = getParamsCount(actionParams, datasourceHeaders);

return (
<Flex
data-testid={props.dataTestId}
flex="1"
flexDirection="column"
gap="spaces-3"
overflow="hidden"
w="100%"
>
<InfoFields
actionName={action.name}
changePermitted={props.isChangePermitted}
formName={props.formName}
options={props.httpMethodOptions}
pluginId={action.pluginId}
theme={theme}
/>
<HintMessages hintMessages={hintMessages} />
<RequestTabs
actionConfigurationHeaders={actionHeaders}
actionConfigurationParams={actionParams}
actionName={action.name}
autogeneratedHeaders={autoGeneratedHeaders}
bodyUIComponent={props.bodyUIComponent}
datasourceHeaders={datasourceHeaders}
datasourceParams={datasourceParams}
formName={props.formName}
paginationUiComponent={props.paginationUiComponent}
pushFields={props.isChangePermitted}
showSettings={false}
theme={theme}
/>
</Flex>
<Styled.Tabs onValueChange={setCurrentTab} value={currentTab}>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshot 2024-12-24 at 10 33 32 AM

Seeing this sticky getting cut off when scrolling

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

<Styled.FormHeader>
<InfoFields
actionName={action.name}
changePermitted={props.isChangePermitted}
formName={props.formName}
options={props.httpMethodOptions}
pluginId={action.pluginId}
theme={theme}
/>
<HintMessages hintMessages={hintMessages} />
<TabsList>
{Object.values(API_EDITOR_TABS)
.filter((tab) => {
return tab !== API_EDITOR_TABS.SETTINGS;
})
.map((tab) => (
<Tab
data-testid={`t--api-editor-${tab}`}
key={tab}
notificationCount={
tab == "HEADERS"
? headersCount
: tab == "PARAMS"
? paramsCount
: undefined
}
value={tab}
>
{createMessage(API_EDITOR_TAB_TITLES[tab])}
</Tab>
))}
</TabsList>
</Styled.FormHeader>

<Styled.TabPanel value={API_EDITOR_TABS.HEADERS}>
<DatasourceConfig
attributeName="header"
autogeneratedHeaders={autoGeneratedHeaders}
data={datasourceHeaders}
/>
<KeyValueFieldArray
actionConfig={actionHeaders}
dataTreePath={`${action.name}.config.headers`}
hideHeader
label="Headers"
name="actionConfiguration.headers"
placeholder="Value"
pushFields={isChangePermitted}
theme={theme}
/>
</Styled.TabPanel>
<Styled.TabPanel value={API_EDITOR_TABS.PARAMS}>
<DatasourceConfig attributeName={"param"} data={datasourceParams} />
<KeyValueFieldArray
actionConfig={actionParams}
dataTreePath={`${action.name}.config.queryParameters`}
hideHeader
label="Params"
name="actionConfiguration.queryParameters"
pushFields={isChangePermitted}
theme={theme}
/>
</Styled.TabPanel>
<Styled.TabPanel className="h-full" value={API_EDITOR_TABS.BODY}>
{bodyUIComponent}
</Styled.TabPanel>
<Styled.TabPanel value={API_EDITOR_TABS.PAGINATION}>
{paginationUiComponent}
</Styled.TabPanel>
<Styled.TabPanel value={API_EDITOR_TABS.AUTHENTICATION}>
<ApiAuthentication formName={formName} />
</Styled.TabPanel>
</Styled.Tabs>
);
};

Expand Down
3 changes: 3 additions & 0 deletions ...luginActionEditor/components/PluginActionForm/components/CommonEditorForm/RequestTabs.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ const StyledTabPanel = styled(TabPanel)`
overflow: auto;
`;

/**
* @deprecated This component will be deleted along with APIEditor/CommonEditorForm.
*/
export function RequestTabs(props: {
autogeneratedHeaders: AutoGeneratedHeader[] | undefined;
datasourceHeaders: Property[];
Expand Down
6 changes: 3 additions & 3 deletions ...s/PluginActionForm/components/CommonEditorForm/components/EmbeddedDatasourcePathField.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ const StyledTooltip = styled.span<{ width?: number }>`
position: absolute;
z-index: 100000;
max-width: 300px;
bottom: 125%;
top: 125%;
left: calc(-10px + ${(props) => (props.width ? props.width / 2 : 0)}px);
margin-left: -60px;

Expand All @@ -165,14 +165,14 @@ const StyledTooltip = styled.span<{ width?: number }>`
&::after {
content: "";
position: absolute;
top: 100%;
bottom: 100%;
left: 50%;
height: 10px;
width: 10px;
margin-left: -5px;
border-width: 5px;
border-style: solid;
border-color: var(--ads-v2-color-bg-emphasis-max) transparent transparent
border-color: transparent transparent var(--ads-v2-color-bg-emphasis-max)
transparent;
}

Expand Down
19 changes: 19 additions & 0 deletions .../src/PluginActionEditor/components/PluginActionForm/components/CommonEditorForm/styles.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import styled from "styled-components";
import { Tabs as AdsTabs, TabPanel as AdsTabPanel } from "@appsmith/ads";

export const RequestMethodSelectContainer = styled.div`
width: 100px;
Expand All @@ -10,3 +11,21 @@ export const RequestMethodSelectContainer = styled.div`
export const DatasourcePathFieldContainer = styled.div`
width: 100%;
`;

export const FormHeader = styled.div`
position: sticky;
top: calc(-1 * var(--ads-v2-spaces-4));
padding-top: var(--ads-v2-spaces-4);
margin-top: calc(-1 * var(--ads-v2-spaces-4));
z-index: var(--ads-v2-z-index-21);
background-color: var(--ads-color-background);
height: 100px;
`;

export const Tabs = styled(AdsTabs)`
height: max-content;
`;

export const TabPanel = styled(AdsTabPanel)`
margin: 0 auto;
`;
1 change: 0 additions & 1 deletion ...src/PluginActionEditor/components/PluginActionForm/components/UQIEditor/UQIEditorForm.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ const UQIEditorForm = () => {
alignItems="center"
data-testid="t--uqi-editor-form"
flexDirection="column"
overflowY="scroll"
w="100%"
>
<FormRender
Expand Down
Loading