Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

remove logoWidth param #10285

Open
chris48s opened this issue Jun 21, 2024 · 1 comment · May be fixed by #10878
Open

remove logoWidth param #10285

chris48s opened this issue Jun 21, 2024 · 1 comment · May be fixed by #10878
Assignees
Labels
core Server, BaseService, GitHub auth, Shared helpers

Comments

@chris48s
Copy link
Member

📋 Description

Shields exposes a param called logoWidth.
It is not very useful and doesn't really do what you would expect it to do, but it does exist.
https://img.shields.io/badge/foo-bar-blue?logo=javascript
https://img.shields.io/badge/foo-bar-blue?logo=javascript&logoWidth=50
This is really a hangover from the "popout" style which was removed in #3747
Tbh, we probably should have got rid of it then, but we didn't.

I propose we remove this param.
Passing it in the query string or an endpoint badge response should not throw an error, but it should also have no effect. We should remove it from the documentation.

The process should look similar to #10284 which removes the logoPosition param (which already did nothing).

@chris48s chris48s added the core Server, BaseService, GitHub auth, Shared helpers label Jun 21, 2024
@jNullj jNullj self-assigned this Feb 8, 2025
jNullj added a commit to jNullj/shields-fun-fork that referenced this issue Feb 8, 2025
@jNullj jNullj linked a pull request Feb 8, 2025 that will close this issue
@LitoMore
Copy link
Contributor

LitoMore commented Feb 9, 2025

There are some projects that use the logoWidth for adjusting the icon size, like https://github.com/xojs/xo?tab=readme-ov-file#badge.

Should we use a new parameter to allow users to customize the icon size?

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
core Server, BaseService, GitHub auth, Shared helpers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants