sourcegraph/client
Felix Kling d2b6ffa2b3
feat(svelte): Improve small screeen behavior (#63859)
Closes srch-730

This is an initial attempt to improve the web app for small screens.
This commit makes the following changes for small screens:

- Search home page:
  - No more search input overflow
- History button is rendered on same line as other action buttons (saves
some vertical space)
- Search results page:
  - Search input is rendered in the page, not in the header (more space)
- Filters sidebar is hidden by default and can be shown via a `Filters`
button.
  - The filters sidebar opens fullscreen and has a close button
  - The progrss button is smaller due to showing less information
- Repository pages:
- File sidebar is hidden by default. It can be shown via a new button
that is visible in the file headers
  - The file sidebar opens fullscreen and has a close button
- NOTE: Selecting a file currently does not close the file sidebar,
navigation happens in the background
  - Cody sidebar opens fullscreen and has the same close button
- General:
  - Fuzzy finder opens fullscreen and has a larger close button
  - Tabs don't show keyboard shortcuts

I tried to stick to CSS as much as possible but for some things to work
I had to change component structures or rendered elements conditionally.
Specifically when a component was already using `$isViewportMobile` I
usually just rendered elements conditionally.

I extended the `Panel` component to have a special 'mobile' mode, since
I realized I was doing similar changes to the filters, file tree and
cody sidebar.
The cody sidebar is a bit of a special case though because it's not even
rendered by default. So there are some additional steps required to sync
the open state.

Screenshots (iPhone SE, which is one of the smaller phones I guess)

| Situation | Before | After |
|--------|--------|--------|
| Search home |
![2024-07-16_19-13](https://github.com/user-attachments/assets/0072a7b5-07dd-4e2e-bd20-5dd2db53b17d)
|
![2024-07-16_19-16_2](https://github.com/user-attachments/assets/4e9d8af3-e160-4a76-b1e0-158b47520dc9)
|
| Search results |
![2024-07-16_19-14](https://github.com/user-attachments/assets/7555747d-38b4-4db1-a53f-10d6308933b4)
|
![2024-07-16_19-17](https://github.com/user-attachments/assets/6b18db5e-0479-4daa-9342-e88d91a84dbc)
|
| Filters |
![2024-07-16_19-14](https://github.com/user-attachments/assets/7555747d-38b4-4db1-a53f-10d6308933b4)
|
![2024-07-16_19-17_1](https://github.com/user-attachments/assets/c33b5f7e-9723-412c-b682-2806c6e5d3da)
|
| Repo |
![2024-07-16_19-15_1](https://github.com/user-attachments/assets/c90af0ae-8b4e-4c2d-a153-f2bd149a83e5)
|
![2024-07-16_19-17_3](https://github.com/user-attachments/assets/554002c5-8759-4aeb-bcfe-578c339c13de)
|
| File sidebar |
![2024-07-16_19-15_1](https://github.com/user-attachments/assets/c90af0ae-8b4e-4c2d-a153-f2bd149a83e5)
|
![2024-07-16_19-17_4](https://github.com/user-attachments/assets/8baf73f9-0455-4e73-9d7c-032df461871d)
|
| Cody sidebar |
![2024-07-16_19-15_2](https://github.com/user-attachments/assets/8db143bd-ec77-4d4b-8572-23393d056805)
|
![2024-07-16_19-18](https://github.com/user-attachments/assets/b34f8470-1a4d-4682-afb9-5af7ef474191)
|
| Repo search |
![2024-07-16_19-16_1](https://github.com/user-attachments/assets/401fd0b6-8f8f-4b6d-bfcd-99510ee30151)
|
![2024-07-16_19-17_5](https://github.com/user-attachments/assets/57a95fb0-93de-40fa-b5c1-ce3be4a64f6b)
|
| Fuzzy finder |
![2024-07-16_19-16](https://github.com/user-attachments/assets/66a55a9f-95eb-4b7a-b102-67508334ba81)
|
![2024-07-16_19-18_1](https://github.com/user-attachments/assets/9c2859a4-33f4-40af-8028-3e0c6953a579)
|
| Rev picker |
![2024-07-17_00-42](https://github.com/user-attachments/assets/bdc0c993-592f-4975-950b-3b7a13edc810)
|
![2024-07-17_00-41](https://github.com/user-attachments/assets/4f42e7e5-387a-40dc-80aa-109481f0399c)
|

Me rambling about the changes:



https://github.com/user-attachments/assets/670f7764-0ef2-4f1b-bc33-89a86d4b2274


Note that the commits and commit pages already seem to look fine. The
branches, tags and contributors pages are a bit broken due to use of
tables and fixed columns. I can look at those separately.

## Test plan

Manual testing
2024-07-17 16:11:10 +02:00
..
branded fix(svelte): Prefill search home page query input with (default) context filter (#63740) 2024-07-09 22:02:04 +00:00
browser Add v2 telemetry infrastructure to browser extensions and native inte… (#63458) 2024-07-03 16:47:37 -07:00
build-config [React]: Add initial usage of the new web worker-based cody web chat (#62792) 2024-06-26 12:13:29 -03:00
client-api v2t: add v2 telemetry to the client/shared folder (#62586) 2024-06-03 16:34:28 -07:00
codeintellify Migrate deprecated rxjs functions/methods (#61222) 2024-04-08 11:23:34 +02:00
cody-context-filters-test-dataset Create a shared Cody Ignore dataset (#61968) 2024-05-09 13:18:35 +00:00
cody-shared Add a better Cody client server-sent configuration mechanism (#63591) 2024-07-03 22:57:31 +00:00
cody-ui Cody web: Bring back old packages from git history (#61376) 2024-04-08 14:21:41 +02:00
common Svelte: add more general shrinkable path (#63770) 2024-07-12 10:36:37 -06:00
eslint-plugin-wildcard chore: upgrade to Aspect CLI 5.8.5 (#57961) 2023-10-30 17:01:58 +02:00
extension-api Docs: update links to point to new site (#60381) 2024-02-13 00:23:47 +00:00
extension-api-types use @typescript-eslint projectService for faster eslint (#57851) 2023-10-24 01:40:40 +00:00
http-client reapply "switch from jest to vitest for faster, simpler tests (#57886)" (#58145) 2023-11-07 12:00:18 +02:00
jetbrains looser eslint rules (#63511) 2024-06-27 08:42:51 +00:00
observability-client reapply "switch from jest to vitest for faster, simpler tests (#57886)" (#58145) 2023-11-07 12:00:18 +02:00
observability-server reapply "switch from jest to vitest for faster, simpler tests (#57886)" (#58145) 2023-11-07 12:00:18 +02:00
shared various improvements to saved searches (#63539) 2024-07-15 20:12:34 +00:00
storybook fix: update links for dev docs (#62758) 2024-05-17 13:47:34 +02:00
template-parser reapply "switch from jest to vitest for faster, simpler tests (#57886)" (#58145) 2023-11-07 12:00:18 +02:00
testing various improvements to saved searches (#63539) 2024-07-15 20:12:34 +00:00
vscode vsce: patch release v2.2.17 (#63617) 2024-07-03 14:54:12 +00:00
web factor out PatternContainedInput (#63869) 2024-07-17 08:25:09 +00:00
web-sveltekit feat(svelte): Improve small screeen behavior (#63859) 2024-07-17 16:11:10 +02:00
wildcard various improvements to saved searches (#63539) 2024-07-15 20:12:34 +00:00
BUILD.bazel Added ts_projects for storybook files in client/* (#59400) 2024-01-09 10:37:53 -08:00
README.md use esbuild for client/web builds (#57365) 2023-10-23 10:59:06 -07:00

Frontend packages

List

  • web: The web application deployed to http://sourcegraph.com/
  • browser: The Sourcegraph browser extension adds tooltips to code on different code hosts.
  • vscode: The Sourcegraph VS Code extension.
  • extension-api: The Sourcegraph extension API types for the Sourcegraph extensions. Published as sourcegraph.
  • extension-api-types: The Sourcegraph extension API types for client applications that embed Sourcegraph extensions and need to communicate with them. Published as @sourcegraph/extension-api-types.
  • sandboxes: All demos-mvp (minimum viable product) for the Sourcegraph web application.
  • shared: Contains common TypeScript/React/SCSS client code shared between the browser extension and the web app. Everything in this package is code-host agnostic.
  • branded: Contains React components and implements the visual design language we use across our web app and e.g. in the options menu of the browser extension. Over time, components from shared and branded packages should be moved into the wildcard package.
  • wildcard: Package that encapsulates storybook configuration and contains our Wildcard design system components. If we're using a component in two or more different areas (e.g. web-app and browser-extension) then it should live in the wildcard package. Otherwise the components should be better colocated with the code where they're actually used.
  • search: Search-related code that may be shared between all clients, both branded (e.g. web, VS Code extension) and unbranded (e.g. browser extension)
  • storybook: Storybook configuration.

Further migration plan

  1. Fix circular dependency in TS project-references graph wildcard package should not rely on web and probably shared, branded too. Ideally it should be an independent self-contained package.

  2. Decide on package naming and update existing package names. Especially it should be done for a shared package because we have multiple shared folders inside of other packages. It's hard to understand from where dependency is coming from and it's not possible to refactor import paths using find-and-replace.

  3. Investigate if we can painlessly switch to npm workspaces.

  4. Content of packages shared and branded should be moved to wildcard and refactored using the latest FE rules and conventions. Having different packages clearly communicates the migration plan. Developers first should look for components in the wildcard package and then fall-back to legacy packages if wildcard doesn't have the solution to their problem yet.

  5. shared contains utility functions, types, polyfills, etc which is not a part of the Wildcard component library. These modules should be moved into utils package and other new packages: e.g. api for GraphQL client and type generators, etc.

  6. Packages should use package name (e.g. @sourcegraph/wildcard) for imports instead of the relative paths (e.g. ../../../../wildcard/src/components/Markdown) to avoid long relative-paths and make dependency graph between packages clear. (Typescript will warn if packages have circular dependencies). It's easy to refactor such isolated packages, extract functionality into new ones, or even into new repositories.