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

use hsl values and reduce number of CSS variables #2637

Merged
merged 1 commit into from
Aug 7, 2022

Conversation

thomasheyenbrock
Copy link
Collaborator

@thomasheyenbrock thomasheyenbrock commented Aug 6, 2022

Inspired by #2635, this is a proposal for how we can prepare v2 so that adding a theme prop down the road won't be a breaking change.

The main idea is to move the color conversion (non-transparent to transparent) into CSS instead of doing it in JS. We achieve this by storing the HSL values as list in the CSS variables. To applying a color we can then just do hsl(var(--color-pink). To apply a transparent shade of a color we can do hsla(var(--color-pink), 0.15).

This reduces the number of CSS variables that users need to care about when creating their custom theme, and it should align nicely with the idea of @jonathanawesome to have a theme prop like this in future versions:

<GraphiQL theme={{ colors: { primary: "<some-color>" } }} />

@changeset-bot
Copy link

changeset-bot bot commented Aug 6, 2022

⚠️ No Changeset found

Latest commit: 36c42d6

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 no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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 Aug 6, 2022

Codecov Report

Merging #2637 (36c42d6) into graphiql-v2 (d5aef50) will not change coverage.
The diff coverage is n/a.

@@             Coverage Diff              @@
##           graphiql-v2    #2637   +/-   ##
============================================
  Coverage        57.61%   57.61%           
============================================
  Files               93       93           
  Lines             5384     5384           
  Branches          1753     1753           
============================================
  Hits              3102     3102           
  Misses            2262     2262           
  Partials            20       20           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@jonathanawesome
Copy link
Collaborator

The switch to alpha values is especially apparent in dark mode...it's a drastic difference and much more accurate to the design in the Figma file.

Before/after screenshots for those that aren't interested in running the app.

Before:
Screen Shot 2022-08-06 at 9 10 58 AM

After:
Screen Shot 2022-08-06 at 9 11 18 AM

--color-purple: 243, 100%, 77%;
--color-blue: 208, 100%, 72%;
--color-orche: 30, 100%, 80%;
--color-neutral: 219, 29%, 78%;
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is where we may run into extensibility issues in the future. I did some testing auto-generating dark mode values was less reliable than it was in light mode. It's a well-understood dark theme problem, and we can decide how to deal with it down the road.

--color-red-background: rgba(248, 91, 48, 0.12);
--color-green-background: rgba(43, 171, 124, 0.12);
--color-neutral-background: rgba(59, 75, 104, 0.1);
--color-pink: 320, 95%, 43%;
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is much more clean, well done! Once the theme API is opened up, it may be a stretch to require implementors to provide hsl values, but we can do some conversion if we have to, and once we get there.

@thomasheyenbrock thomasheyenbrock merged commit 430d60b into graphiql-v2 Aug 7, 2022
@thomasheyenbrock thomasheyenbrock deleted the feat/alpha-color-palette branch August 7, 2022 08:19
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]>
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