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

Added icon details view #154

Merged
merged 17 commits into from
Sep 28, 2022
Merged

Added icon details view #154

merged 17 commits into from
Sep 28, 2022

Conversation

jorgeamadosoria
Copy link
Contributor

@jorgeamadosoria jorgeamadosoria commented Dec 4, 2021

Addresses:
#17 - Compact layout
#95 - Link to outdated icons
#43 - Icon detail view
#149 - Download of color SVGs

image

The report button simply links to the issue template for update, and fills the title with the brand to be updated. It also includes a test in the e2e file.


The changes for the compact layout are:

  • Reduced gutters
  • Reduced width for cards
  • Reduced margins for card title
  • Changed the color button to vertical to reduce the width of the card
  • Removed the leading # in the color button text to reduce the width of it
  • Set titles to a fixed width with an ellipsis overflow to avoid multilineal titles (full title available as tooltip)
  • Removed guidelines and licenses from the cards.

this change should be complemented with an additional "details" button alongside the other two. In this detail view the guidelines and licenses will be shown, to avoid loss of information

Copy link
Member

@mondeja mondeja left a comment

Choose a reason for hiding this comment

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

Great.

As I understand, in the original report, the reporter mocked a toggling functionality to change between layouts.

Maybe that would be even enough to solve the problem of the lack of licenses and brands guidelines in this: a toggling feature just like order, color and download type buttons. The licenses and brand guidelines would be only shown on expanded layout. Not sure about this, but at least the licenses and brand guidelines functionality would not be dropped in this PR, which I consider a setback.

Also, I think that the design currently implemented in this PR could be a bit claustrophobic for some users.

public/index.pug Outdated Show resolved Hide resolved
public/index.pug Outdated Show resolved Hide resolved
public/index.pug Outdated Show resolved Hide resolved
@jorgeamadosoria
Copy link
Contributor Author

Great.

As I understand, in the original report, the reporter mocked a toggling functionality to change between layouts.

Maybe that would be even enough to solve the problem of the lack of licenses and brands guidelines in this: a toggling feature just like order, color and download type buttons. The licenses and brand guidelines would be only shown on expanded layout. Not sure about this, but at least the licenses and brand guidelines functionality would not be dropped in this PR, which I consider a setback.

Also, I think that the design currently implemented in this PR could be a bit claustrophobic for some users.

a toggle was floated, but I seem to remember that the compact layout was ultimately just decided to be the layout. @ericcornelissen had some comments to that effect, I remember. I may be wrong, I would have to go back and check, but I'm pretty sure the toggle was dropped.

More importantly, I (personally) don't think a toggle is all that important. To the point that if the previous layout was to be kept as an option, I wouldn't have taken this issue. It would be complicating things for not a lot of improvement.

As for license and guidelines, the problem is that this PR is not really for merging just yet. I want to validate the design first, hence why it's here. Once that's done, I will build the detail view PR upon this one.

The detail view PR that is under way should build upon the compact layout, and will include license and guidelines. No need for a separate toggle for it. We could have either a toggle for standard layout / compact layout, or no toggle at all and just compact layout (my choice is the latter).

I agree that the current design may be claustrophobic, specially compared with the previous one. I personally like it, but I'm biased so my opinion does not carry a lot of weight. I'm willing to redesign this if there are other, more aesthetically pleasing ideas. We need to just keep in mind that the design has to be compact, but other than that, I'm open to ideas for improvement.

@jorgeamadosoria
Copy link
Contributor Author

Now going over the original thread, I can't find the place the toggle was discussed for dropping. Maybe it never was and I imagined the whole thing.
In any case, is a choice of layouts really necessary?

@mondeja
Copy link
Member

mondeja commented Dec 10, 2021

In any case, is a choice of layouts really necessary?

I think that could be great, even necessary due to a lot of things, but this would also depend on how to details view is solved.

  • The issue Set Creation Date of PDF to date of addition / modification in main repo. simple-icons-pdf#7 could be a great addition for the website. Display new last updated date of an icon and the date of inclusion is really useful. This probably would be too much information for a details view in compact mode, but it would fit in a details view for expanded mode. Even could be added in expanded mode without "details view", I don't know because I still don't know what you mean by a detail view.
  • Many users could feel rejected by a compact mode as the unique option, especially non-developer users who go for simple icons to only download an icon to play with it. The first impression of such a reduced view could scare them away. Yesterday tested this compact mode with an acquaintance and it found it too overwhelming in a laptop, not tested in a mobile view though.

It would be complicating things for not a lot of improvement.

🤔 It is just another theme with media selectors, like dark-light themes, changing 11 CSS properties. I don't think it's too much and it doesn't introduce any new patterns to the project. Is not an improvement, but it would not regress at least.

@jorgeamadosoria
Copy link
Contributor Author

jorgeamadosoria commented Dec 11, 2021

In any case, is a choice of layouts really necessary?

I think that could be great, even necessary due to a lot of things, but this would also depend on how to details view is solved.

  • The issue Set Creation Date of PDF to date of addition / modification in main repo. simple-icons-pdf#7 could be a great addition for the website. Display new last updated date of an icon and the date of inclusion is really useful. This probably would be too much information for a details view in compact mode, but it would fit in a details view for expanded mode. Even could be added in expanded mode without "details view", I don't know because I still don't know what you mean by a detail view.
  • Many users could feel rejected by a compact mode as the unique option, especially non-developer users who go for simple icons to only download an icon to play with it. The first impression of such a reduced view could scare them away. Yesterday tested this compact mode with an acquaintance and it found it too overwhelming in a laptop, not tested in a mobile view though.

It would be complicating things for not a lot of improvement.

🤔 It is just another theme with media selectors, like dark-light themes, changing 11 CSS properties. I don't think it's too much and it doesn't introduce any new patterns to the project. Is not an improvement, but it would not regress at least.

Detail views ticket: #43
It's a modal / page / slide that has more details about the icons than what is shown in the card. Everything that you have can be shown in a detail view.

I wouldn't make detail view compact / comfortable. Detail view is supposed to contain everything, not just a bit of info, so making it compact kind of defeats the purpose.

I'm against the toggle between layouts. It's more code for a user feature than I'm not sure if it's going to see a lot of use. If the current compact layout is overwhelming due to having too much going on, then we can close the PR and forget about the compact layout, or we could tweak the compact layout to make it less aggressive. After all, the website, even with compact layout mode, is already very generous with the size of icon names and previews, when compared with other icon libraries.

Also note that compact layout not only changes CSS properties, it also requires some markup changes. Maybe those could be dealt away with more CSS, I don't know. I can try to make the compact layout work with only CSS to remove that variable from the discussion.

It's not that it is not doable: it is. I just don't know if it's something we really need to have.

@mondeja
Copy link
Member

mondeja commented Dec 11, 2021

OK, I will not block this as the request is not clear about it, so go ahead with compact layout only 👍 We can always add the toggle if any maintainer or user asks for it.

@jorgeamadosoria
Copy link
Contributor Author

OK, I will not block this as the request is not clear about it, so go ahead with compact layout only 👍 We can always add the toggle if any maintainer or user asks for it.

As a compromise, I'm going to try and make the changes CSS only, so the toggle can be added without much effort, as you pointed out before.

In any case, this PR is not going to be merged any time soon: I need to add the detail view first or we would be losing information. So we have time to get more feedback either way.

@jorgeamadosoria
Copy link
Contributor Author

@mondeja Hey, so, I moved the changes in the HTML to be handled by CSS only, and it turned out to be easier than I thought. So I went ahead and added the toggle you wanted.

I still think we don't need that, but for what it's worth, is in there now.

public/scripts/layout.js Outdated Show resolved Hide resolved
scripts/removed-icons.js Show resolved Hide resolved
public/scripts/layout.js Outdated Show resolved Hide resolved
tests/e2e.test.js Show resolved Hide resolved
webpack.config.js Outdated Show resolved Hide resolved
public/removed.pug Outdated Show resolved Hide resolved
public/index.pug Outdated Show resolved Hide resolved
@mondeja mondeja added enhancement New feature or request design Issues and Pull Requests regarding the visual design of the website labels Dec 23, 2021
This was linked to issues Jan 9, 2022
@mondeja
Copy link
Member

mondeja commented Feb 1, 2022

Would you mind to resolve the conflicts @jorgeamadosoria?

@jorgeamadosoria
Copy link
Contributor Author

Would you mind to resolve the conflicts @jorgeamadosoria?

done

@jorgeamadosoria
Copy link
Contributor Author

All the conflicts are resolved. Can we get this merged or rejected before more conflicts arise, please, @mondeja ?

@mondeja
Copy link
Member

mondeja commented Sep 27, 2022

I'll try to merge this with master ASAP

@mondeja mondeja changed the title Added link to report outdated icon as well as compact layout Added icon details view Sep 28, 2022
@mondeja mondeja merged commit f8bb56e into master Sep 28, 2022
@mondeja mondeja deleted the issue-95 branch September 28, 2022 14:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design Issues and Pull Requests regarding the visual design of the website enhancement New feature or request
Projects
None yet
2 participants