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

Rename background option to backgroundColor for clarity #10

Closed
sindresorhus opened this issue Apr 7, 2018 · 3 comments
Closed

Rename background option to backgroundColor for clarity #10

sindresorhus opened this issue Apr 7, 2018 · 3 comments

Comments

@sindresorhus
Copy link

When just reading the options in the code it's not immediately clear it's the background color. This would also better match the colors option.

@dominikwilkowski
Copy link
Owner

Mh 🤔 that would break the API and issue a new major version. Not sure if it's worth it. I keep it in the back of my mind and leave this issue open for others to add their perspectives.

@sindresorhus
Copy link
Author

You don't have to make it a breaking change. I would just rename it and add an alias for background=>backgroundColor to preserve backward compatibility, and then remove the alias in the next major.

@dominikwilkowski
Copy link
Owner

Yeah I did just that. Let me know if you have issues.

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

No branches or pull requests

2 participants