Skip to content
This repository was archived by the owner on Jul 19, 2024. It is now read-only.

Add Request Settings Modal autofocus to ease up "add description" user journey #148

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,7 @@ export const RequestActionsDropdown = ({
<RequestSettingsModal
request={request}
onHide={() => setIsSettingsModalOpen(false)}
autoFocusOn="name"
/>
)}
</Fragment>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,20 @@ import { MarkdownEditor } from '../markdown-editor';

export interface RequestSettingsModalOptions {
request: Request | GrpcRequest | WebSocketRequest;
autoFocusOn?: 'name' | 'description';
}
interface State {
defaultPreviewMode: boolean;
activeWorkspaceIdToCopyTo: string;
}

export const RequestSettingsModal = ({ request, onHide }: ModalProps & RequestSettingsModalOptions) => {
export const RequestSettingsModal = ({ request, onHide, autoFocusOn }: ModalProps & RequestSettingsModalOptions) => {
const modalRef = useRef<ModalHandle>(null);
const editorRef = useRef<CodeEditorHandle>(null);
const nameRef = useRef<HTMLInputElement>(null);
const { organizationId, projectId, workspaceId } = useParams() as { organizationId: string; projectId: string; workspaceId: string };
const workspacesFetcher = useFetcher();

useEffect(() => {
const isIdleAndUninitialized = workspacesFetcher.state === 'idle' && !workspacesFetcher.data;
if (isIdleAndUninitialized) {
Expand All @@ -37,12 +40,24 @@ export const RequestSettingsModal = ({ request, onHide }: ModalProps & RequestSe
}, [organizationId, projectId, workspacesFetcher]);
const projectLoaderData = workspacesFetcher?.data as ProjectLoaderData;
const workspacesForActiveProject = projectLoaderData?.workspaces.map(w => w.workspace) || [];

const [state, setState] = useState<State>({
defaultPreviewMode: !!request?.description,
activeWorkspaceIdToCopyTo: '',
});

useEffect(() => {
modalRef.current?.show();

if (autoFocusOn) {
setTimeout(() => {
if (autoFocusOn === 'description') {
editorRef.current?.focus();
} else if (autoFocusOn === 'name') {
nameRef.current?.focus();
}
});
}
}, []);

const requestFetcher = useFetcher();
Expand All @@ -56,6 +71,7 @@ export const RequestSettingsModal = ({ request, onHide }: ModalProps & RequestSe
encType: 'application/json',
});
};

async function handleMoveToWorkspace() {
guard(state.activeWorkspaceIdToCopyTo, 'Workspace ID is required');
patchRequest(request._id, { parentId: state.activeWorkspaceIdToCopyTo });
Expand Down Expand Up @@ -93,6 +109,7 @@ export const RequestSettingsModal = ({ request, onHide }: ModalProps & RequestSe
Name{' '}
<span className="txt-sm faint italic">(also rename by double-clicking in sidebar)</span>
<input
ref={nameRef}
type="text"
placeholder={request?.url || 'My Request'}
defaultValue={request?.name}
Expand Down
1 change: 1 addition & 0 deletions packages/insomnia/src/ui/components/panes/request-pane.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,7 @@ export const RequestPane: FC<Props> = ({
<RequestSettingsModal
request={activeRequest}
onHide={() => setIsRequestSettingsModalOpen(false)}
autoFocusOn="description"
/>
)}
</Pane>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -401,6 +401,7 @@ export const WebSocketRequestPane: FC<Props> = ({ environment }) => {
<RequestSettingsModal
request={activeRequest}
onHide={() => setIsRequestSettingsModalOpen(false)}
autoFocusOn="description"
/>
)}
</Pane>
Expand Down
1 change: 1 addition & 0 deletions packages/insomnia/src/ui/routes/debug.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -1059,6 +1059,7 @@ export const Debug: FC = () => {
<RequestSettingsModal
request={activeRequest}
onHide={() => setIsRequestSettingsModalOpen(false)}
autoFocusOn="name"
/>
)}
</ErrorBoundary>
Expand Down