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.

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

[redesign] implement new search combobox #2586

Merged
merged 1 commit into from
Jul 27, 2022

Conversation

thomasheyenbrock
Copy link
Collaborator

Part of #2325

This PR adds a Search component to @graphiql/react that allows searching through schema items. There is still some final work left to do for the docs, so the UI you'll see in the preview deployment is not the final one! Expect another PR that finalizes the docs design.

To help implement the combobox and assure that it aligns with all a11y requirements I used @reach/combobox. It seemed pretty light-weight while also being very flexible and customizable. I'm basically proposing this now for the first iteration, but I'm not too opinionated on this choice. It seems good enough at this point and unless there are major blockers I'd recommend taking it. We can always follow up on minor points and maybe switch out the implementation behind the scenes after releasing v2.

@changeset-bot
Copy link

changeset-bot bot commented Jul 25, 2022

⚠️ No Changeset found

Latest commit: 3e8a6c5

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes changesets to release 2 packages
Name Type
@graphiql/react Minor
graphiql Patch

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@codecov
Copy link

codecov bot commented Jul 25, 2022

Codecov Report

Merging #2586 (3e8a6c5) into graphiql-v2 (0786115) will decrease coverage by 0.59%.
The diff coverage is 8.73%.

@@               Coverage Diff               @@
##           graphiql-v2    #2586      +/-   ##
===============================================
- Coverage        56.08%   55.48%   -0.60%     
===============================================
  Files               88       87       -1     
  Lines             5192     5228      +36     
  Branches          1633     1655      +22     
===============================================
- Hits              2912     2901      -11     
- Misses            2270     2317      +47     
  Partials            10       10              
Impacted Files Coverage Δ
.../graphiql-react/src/explorer/components/search.tsx 0.00% <0.00%> (ø)
packages/graphiql-react/src/explorer/context.tsx 8.88% <ø> (+0.88%) ⬆️
...aphiql-react/src/explorer/components/type-link.tsx 88.88% <100.00%> (-3.42%) ⬇️
...s/graphiql-react/src/explorer/components/utils.tsx 100.00% <100.00%> (ø)
packages/graphiql-react/src/icons/index.tsx 100.00% <100.00%> (ø)
packages/graphiql/src/components/DocExplorer.tsx 63.33% <100.00%> (+0.47%) ⬆️
packages/graphiql/src/utility/debounce.ts

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0786115...3e8a6c5. Read the comment docs.

@acao
Copy link
Member

acao commented Jul 26, 2022

beautiful! @reach/combobox seems just fine

noting for further iterations, there is high demand to make this searchable by both title and description, but we can figure that out later on in 2.x

argument?: GraphQLArgument;
};

export function useSearchResults(caller?: Function) {
Copy link
Member

Choose a reason for hiding this comment

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

oh wow, this is really clever! excellent for both the SDK and graphiql

@thomasheyenbrock
Copy link
Collaborator Author

Extending the search logic should be easy enough to do later on:

  • The useSearchResults hook contains the logic of what items to return from a given schema instance
  • The Search component takes the results and renders it

@acao
Copy link
Member

acao commented Jul 27, 2022

@thomasheyenbrock this is amazing! exactly what I hoped for, and better than I could've done!

@thomasheyenbrock thomasheyenbrock merged commit 0172cb6 into graphiql-v2 Jul 27, 2022
@thomasheyenbrock thomasheyenbrock deleted the feat/docs-search branch July 27, 2022 09:56
@thomasheyenbrock thomasheyenbrock mentioned this pull request Jul 27, 2022
thomasheyenbrock added a commit that referenced this pull request Jul 27, 2022
thomasheyenbrock added a commit that referenced this pull request Jul 27, 2022
thomasheyenbrock added a commit that referenced this pull request Aug 1, 2022
thomasheyenbrock added a commit that referenced this pull request Aug 2, 2022
thomasheyenbrock added a commit that referenced this pull request Aug 4, 2022
thomasheyenbrock added a commit that referenced this pull request Aug 5, 2022
thomasheyenbrock added a commit that referenced this pull request Aug 5, 2022
thomasheyenbrock added a commit that referenced this pull request Aug 5, 2022
thomasheyenbrock added a commit that referenced this pull request Aug 7, 2022
thomasheyenbrock added a commit that referenced this pull request Aug 8, 2022
thomasheyenbrock added a commit that referenced this pull request Aug 9, 2022
thomasheyenbrock added a commit that referenced this pull request Aug 9, 2022
thomasheyenbrock added a commit that referenced this pull request Aug 9, 2022
thomasheyenbrock added a commit that referenced this pull request Aug 9, 2022
thomasheyenbrock added a commit that referenced this pull request Aug 9, 2022
thomasheyenbrock added a commit that referenced this pull request Aug 15, 2022
thomasheyenbrock added a commit that referenced this pull request Aug 19, 2022
thomasheyenbrock added a commit that referenced this pull request Aug 20, 2022
thomasheyenbrock added a commit that referenced this pull request Aug 24, 2022
thomasheyenbrock added a commit that referenced this pull request Aug 24, 2022
thomasheyenbrock added a commit that referenced this pull request Aug 24, 2022
* [redesign]: editor in new design (#2513)

* add postcss config to allow nesting

* avoid processing css from `@graphiql/react` with postcss

* add css files for default fonts

* add long description with markdown to dev schema

* rewrite completion tooltip

* move editor css to @graphiql/react

* git mv editor components to `@graphiql/react`

* adjust editor components after moving to `@graphiql/react`

* move styles for auto-inserted leads

* make dynamic padding more resilient and add explanatory comment

* add extra color to avoid conflicts

* colocate markdown and deprecation styles

* add changesets

* fix spell checking

* add changeset for graphiql@2

* don't enter pre-release mode in changeset

* more elaborate changeset message

* [redesign] layout for editor components (#2515)

* add icons to `@graphiql/react`

* add `UnstyledButton` ui component

* implement new design for editors layout

* rename `Unstyled` to `UnStyled` for spell checking

* remove unused class and whitespace in `className`

* make tiny change for deploy preview 🤞

* this will do it, i think?

Co-authored-by: Rikki Schulte <[email protected]>

* set default background color for editors (#2528)

* set default background colors via css variables (#2530)

* move editor styles to `@graphiql/react` (#2532)

* refresh editor after hiding (#2537)

* add caller argument to editor hooks (#2538)

* implement footer in new design (#2540)

* [redesign] implement new toolbar design (#2524)

* implement new toolbar design

* add `caller` argument for better errors

* [redesign] implement sidebar (#2543)

* implement sidebar in new design

* simplify callback

* [redesign] implement new design for history plugin (#2571)

* add icons

* don't invoce callback when programmatically change resizable element

* implement history in new design

* visually separate favourite history items

* add save button when editing history label

* add changeset

* add missing changesets in retrospect

* fix typos

* fix e2e tests

* remove input outline

* add prerelease versions

* fix opening doc explorer when clicking references (#2578)

* extract loading spinner to `@graphiql/react` (#2581)

* [redesign] move docs components to `@graphiql/react` (#2582)

* move explorer context into folder

* move `TypeLink` component to `@graphiql/react`

* move `FieldLink` component to `@graphiql/react`

* move `DefaultValue` component to `@graphiql/react`

* move `Directive` component to `@graphiql/react`

* extract `MarkdownContent` component in `@gaphiql/react`

* move `Argument` component to `@graphiql/react`

* combine and extend changesets

* add `Search` component to `@graphiql/react` (#2586)

* move remaining doc explorer component to `@graphiql/react` (#2587)

* [redesign] docs (#2588)

* add icons

* add `Button` component to `@graphiql/react`

* add explorer section component

* redesign `SchemaDocumentation` component

* redesign `TypeDocumentation` component

* redesign `FieldDocumentation` component

* redesign `DocExplorer` component

* extend changeset message

* move tab components to `@graphiql/react` (#2591)

* [redesign] implement new design for tabs (#2592)

* implement new design for tabs

* add back `tab` role

* increment versions from release

* [redesign] add settings dialog (#2595)

* add `Dialog` component to `@graphiql/react`

* add a `clear` method to the `Storage` type

* add success and failure states to `Button` component

* add settings dialog

* make sure to show dialog above editor scrollbars

* [redesign] add dark mode (#2596)

* add `ButtonGroup` component to `@graphiql/react`

* dark mode

* add back styles for editor search (#2599)

* add a dialog that shows all available shortkeys (#2601)

* add a dialog that shows all available shortkeys

* use table in short key dialog

* add shortkey for introspection

* add link to codemirror keymaps

* make dropdown menu accessible (#2627)

* fix doc explorer style regressions (#2630)

* fix selector specificity for link styling

* leverage nesting

* fix hiding the headline on focus

* ensure correct focus outlines and remove visited styles

* increment next versions

* adds styles to contain the result window above any footer content (#2621)

* adds styles to contain the result window above any footer content

* simplifies flex value

* use hsl values and reduce number of CSS variables (#2637)

* rename CSS variables for colors (#2641)

* forward refs and props for UI components (#2628)

* [redesign] implement toolbar menu and select in new design (#2631)

* implement toolbar menu in new design

* implement `ToolbarListbox` in new design

* better tooltips

* [v2] cleanup `GraphiQL` component (#2632)

* remove deprecated class methods

* remove utilities

* remove ref forwarding

* refactor inner class component to a function component

* merge main component with context consumer component

* remove component statics

* refactor outer component to be a class component

* remove comments

* add changeset

* remove legacy exports

* [v2] add provider component and deduplicate prop type definitions (#2650)

* add `GraphiQLProvider` to `@graphiql/react` and include `StorageContextProvider`

* add `HistoryContextProvider` to `GraphiQLProvider`

* add `EditorContextProvider` to `GraphiQLProvider`

* add `SchemaContextProvider` to `GraphiQLProvider`

* add `ExecutionContextProvider` to `GraphiQLProvider`

* move `ExplorerContextProvider` to `GraphiQLProvider`

* declare props for `GraphiQLInterface`

* reuse prop definitions from editor components

* merge props for default state of editor tools

* rename prop for toggling headers editor

* re-export GraphiQL provider

* add documention for `@graphiql/react` (#2657)

* add JSDocs for component props and hooks

* add JSDocs for context types

* add README for `@graphiql/react`

* [v2] add plugin api for docs and history (#2674)

* add plugin api for docs and history

* throw error when plugin has no title

* make popover styles look good in dark mode (#2682)

* add example for `graphiql-explorer` (#2683)

* don't pass `shouldPersistHeaders` to fetcher anymore (#2684)

* bump preview versions

* overhaul READMEs and add migratio guide for `graphiql@2`

Co-authored-by: Rikki Schulte <[email protected]>
Co-authored-by: Jonathan Brennan <[email protected]>
thomasheyenbrock added a commit that referenced this pull request Aug 24, 2022
thomasheyenbrock added a commit that referenced this pull request Aug 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants