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

Make copybutton image (or other aspects of it) configurable #134

Open
3 tasks
choldgraf opened this issue Jul 3, 2021 · 2 comments
Open
3 tasks

Make copybutton image (or other aspects of it) configurable #134

choldgraf opened this issue Jul 3, 2021 · 2 comments
Labels
enhancement New feature or request

Comments

@choldgraf
Copy link
Member

In #133 we discussed that some people might want the copybutton image to be configurable. For example, provide a local SVG and use that for the copybutton image on the website. @pradyunsg suggested that we wait to see if we get a signal from users that this is something they'd want to have.

Actions

  • Wait a few months to see if anybody asks to change the copybutton image back, or more generally for configurability.
  • Decide if we want to support this after a few months
  • ...figure out next steps to take
@pradyunsg
Copy link
Member

pradyunsg commented Oct 20, 2021

Hi. Uh... I'd like to change the copy button back. 🙈

I've been playing around with various documentation themes, and the style we had earlier is more common and more neutral, contributing to nicer aesthetics than the GH-inspired style in more contexts.

@choldgraf
Copy link
Member Author

choldgraf commented Oct 20, 2021

@pradyunsg - a couple quick thoughts:

In general we probably don't wanna change the default too many times since it'll "surprise" users when it happens, and in my experience surprises are not good 😅

That being said, we don't have a strong rationale for the current icon choice, so if we can document a better rationale for why the default icon should be different, I'd be +1 on merging a PR that changes the icon + gives a reasoning behind why it is the choice (so that we don't run the risk of "I prefer this one, you prefer that one" design flip-flopping).

Does that make sense to you?

(also changing the default feels like it warrants a dedicated issue rather than wrapping it up in the configurability question IMO)

A few things that seem like reasonable guiding principles to me:

  • Should use an icon that is nearly universally recognized as a "copy" icon
  • Should work well-enough with a variety of visual contexts
  • Should not be "highly opinionated" in terms of colors, styles, shadows, etc
  • Should behave "like a button" so that users know to click it
  • Should not deviate much from what copybuttons in other documentation sites look like
  • Make the HTML / CSS flexible enough that theme creators could easily modify the CSS needed to get the look and feel they want

I'll also note that since this extension was updated to riff off of GitHub, they've changed the icon that's used with copying, here's how it looks now:

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants