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

Ecosystem as table #57

Merged
merged 8 commits into from
Mar 15, 2024
Merged

Ecosystem as table #57

merged 8 commits into from
Mar 15, 2024

Conversation

jlaehne
Copy link
Contributor

@jlaehne jlaehne commented Jan 14, 2024

This PR renders the Ecosystem section as table with banner logos.

Might actually help us also to assess the new banners for how they fit here!

@ericpre
Copy link
Member

ericpre commented Jan 15, 2024

Is it possible to a minimum width to the left columns? When the width of the page is small, the logo appear very small. The advantage of the page is that it responds well to the width and the number of card on a line is reduce as the page width is reduce.

@CSSFrancis
Copy link
Member

@ericpre also on mobile you have the same problem :)

@jlaehne
Copy link
Contributor Author

jlaehne commented Jan 15, 2024

It would have to switch to icons, when the size of the logos gets too small, but I am not sure if that is possible.

@CSSFrancis
Copy link
Member

CSSFrancis commented Jan 15, 2024

It would have to switch to icons, when the size of the logos gets too small, but I am not sure if that is possible.

Hmm.... There is probably a way but I don't think it's a big enough deal to stop this from merging, It does make me realize that pyxem probably needs a more banner like logo :)

@jlaehne
Copy link
Contributor Author

jlaehne commented Jan 16, 2024

  • For pyxem it would be easy, just make a version, where the name is to the right of the crystal.
  • For HyperSpy, I would propose to make a version of the banner, where the hypercube is the same height as the text as otherwise it gets too small.
  • Atomap could also use a banner version with the name to the right.
  • For HyperSpyUI, I would tend just make a variant of the HyperSpy logo with UI added (where it is again good that with Noto we chose a font with a clear capital I).

I am pretty happy with the eXSpy logo in this context. But I am less happy how the holographic effect in the holoSpy logo renders here. I need to touch that one again.

@jlaehne
Copy link
Contributor Author

jlaehne commented Jan 16, 2024

If I increase the size of the banners and first column a little more, like in the last commit. It already looks better for a scaled down width.

@ericpre
Copy link
Member

ericpre commented Jan 16, 2024

If banner style logo are used with a large aspect ratio, the second column can be removed? The alternative is to used the non-banner logo with a 1:1 aspect ratio and keep the second column.
Is it worth putting some badges (pypi, zenodo)?

@CSSFrancis
Copy link
Member

CSSFrancis commented Jan 16, 2024

  • For pyxem it would be easy, just make a version, where the name is to the right of the crystal.

Done here: pyxem/pyxem#984 (comment)

  • For HyperSpy, I would propose to make a version of the banner, where the hypercube is the same height as the text as otherwise it gets too small.
  • Atomap could also use a banner version with the name to the right.

@magnunor I might take a crack at a redesign to the atomap logo if you are interested. (I really want to make the logo into an A...)

  • For HyperSpyUI, I would tend just make a variant of the HyperSpy logo with UI added (where it is again good that with Noto we chose a font with a clear capital I).

What about if we do the Rosttasciio thing and put the UI in the hypercube?

I am pretty happy with the eXSpy logo in this context. But I am less happy how the holographic effect in the holoSpy logo renders here. I need to touch that one again.

I made some suggestions in hyperspy/holospy#20

@CSSFrancis
Copy link
Member

CSSFrancis commented Jan 16, 2024

I need to stop making logos... @magnunor thoughts?

It needs a little more cleaning up but I think the idea is there.

atomap_logo

@magnunor
Copy link

I need to stop making logos... @magnunor thoughts?

It needs a little more cleaning up but I think the idea is there.

atomap_logo

Looks cool! I'll have a more thorough look at it after I sort out the HyperSpy 2.0.0 compatible Atomap release (my current dev-time is sadly quite small at the moment...)

@jlaehne
Copy link
Contributor Author

jlaehne commented Jan 20, 2024

If banner style logo are used with a large aspect ratio, the second column can be removed? The alternative is to used the non-banner logo with a 1:1 aspect ratio and keep the second column.

I still see a point in having the additional spelled out package name, as it is read quicker than a logo with varying font.

At the same time, the banners look better than 1:1 icons in the table. Would be only if one replaces that for narrow windows, but then that would require quite some customization that could break more easily.

Is it worth putting some badges (pypi, zenodo)?

I am not a fan of badges, as they do not match so well with the pydata-sphinx style. We could however think about adding more button-links instead. The gitter badge I would simply remove, because there is a link already!

@jlaehne
Copy link
Contributor Author

jlaehne commented Jan 20, 2024

By the way, on a small mobile screen, the banners in the table are simply left out, which is not a too bad solution, because the essential information remains!

@jlaehne jlaehne mentioned this pull request Jan 23, 2024
7 tasks
@ericpre
Copy link
Member

ericpre commented Jan 27, 2024

On a small screen, the banners are not removed but they are squeezed:

@jlaehne
Copy link
Contributor Author

jlaehne commented Jan 27, 2024

Interesting, I get a view without the logos (maybe because it is zoomed further?):

Screenshot_2024-01-27-12-53-56

@jlaehne
Copy link
Contributor Author

jlaehne commented Jan 27, 2024

By the way, in your screenshot the SVGs are scaled correctly, while the PNGs (pyxem, Atomap) are squeezed.

@ericpre
Copy link
Member

ericpre commented Jan 27, 2024

Interesting, I get a view without the logos (maybe because it is zoomed further?):

I don't know but from reading the documentation of list-table, there is no mention of removing a column when the page width is too small and I am not sure that this is expected behaviour.

@jlaehne
Copy link
Contributor Author

jlaehne commented Jan 27, 2024

I don't know but from reading the documentation of list-table, there is no mention of removing a column when the page width is too small and I am not sure that this is expected behaviour.

OK, I checked on a few more devices. In some cases the images are reduced in size, in some they seem to disappear when they are scaled too small.

@jlaehne
Copy link
Contributor Author

jlaehne commented Mar 7, 2024

I adapted the css so that it drops the second column (text titles) when the screen is not wide enough. When it becomes less than 400px wide it switches to text titles and drops the images.

Now to look really good we only need banners for:

  • Atomap
  • ParticleSpy
  • HyperSpyUI

And an svg version (because it properly scales in contrast to png) for:

  • pyxem

@ericpre
Copy link
Member

ericpre commented Mar 8, 2024

It seems that this is now working as expected. Using a table instead of the tile of the cards better fit the content but I find it visually less pleasing but maybe it simply needs tweaking of the table formatting? For example:

If we add any other links (such as link to source code, pypi, documentation, etc.) in the rows, we should make each row a button and that will allow us to remove the second column.

@jlaehne
Copy link
Contributor Author

jlaehne commented Mar 11, 2024

It seems that this is now working as expected. Using a table instead of the tile of the cards better fit the content but I find it visually less pleasing but maybe it simply needs tweaking of the table formatting? For example:

* the logos look to be packed quite close to each other, maybe add more space around them?

* add lines to separate rows, for example: https://getbootstrap.com/docs/5.3/content/tables/#accented-tables

* hooverable rows : for example https://getbootstrap.com/docs/5.3/content/tables/#hoverable-rows or https://getbootstrap.com/docs/5.3/components/list-group/#links-and-buttons, maybe for another time?

I managed to do all proposed tweaks in the css - adapted for both dark and light mode.

If we add any other links (such as link to source code, pypi, documentation, etc.) in the rows, we should make each row a button and that will allow us to remove the second column.

The links are all going to the documentation (for HyperSpy still has to be adapted, because it goes back to the website currently). From there you can access source code, etc. - So for the moment, I do not see a need for additional links.

@CSSFrancis
Copy link
Member

CSSFrancis commented Mar 12, 2024

pyxem_banner

@jlaehne Does this work?

@ericpre
Copy link
Member

ericpre commented Mar 12, 2024

If we add any other links (such as link to source code, pypi, documentation, etc.) in the rows, we should make each row a button and that will allow us to remove the second column.

The links are all going to the documentation (for HyperSpy still has to be adapted, because it goes back to the website currently). From there you can access source code, etc. - So for the moment, I do not see a need for additional links.

Sorry if didn't make sense what I said because I forgot a negation... I meant to say "If we don't add any other link" to suggest to remove the link as the whole line could be used as a button when hoovering.

@ericpre
Copy link
Member

ericpre commented Mar 12, 2024

The holospy logo bright and dark doesn't seem to be aligned?

@jlaehne
Copy link
Contributor Author

jlaehne commented Mar 12, 2024

The holospy logo bright and dark doesn't seem to be aligned?

Thanks, should be fixed, now also added to hyperspy/holospy#26

Also, the pyxem logo works nice (just had to set :class: sd-bg-transparent to avoid some white in the corners)

For Atomap, ParticleSpy and HyperSpyUI I created some placeholder banners so that we can merge this. Can be replaced once proper banners are available for the respective packages.

@jlaehne
Copy link
Contributor Author

jlaehne commented Mar 13, 2024

Sorry if didn't make sense what I said because I forgot a negation... I meant to say "If we don't add any other link" to suggest to remove the link as the whole line could be used as a button when hoovering.

Well, though the logos are visually appealing, with the different fonts and stylized letters, one needs longer to read the names. To get a quick overview of the extension names, I believe people would actually be reading the second column with its uniform font. Therefore, when the window is wide enough, I would leave that column.

@ericpre
Copy link
Member

ericpre commented Mar 13, 2024

Is it worth doing something about the alignment of the holospy logos when switching between bright and dark theme?

@jlaehne
Copy link
Contributor Author

jlaehne commented Mar 13, 2024

Is it worth doing something about the alignment of the holospy logos when switching between bright and dark theme?

Should be fine now. I fixed the dark one to match the light one.

@ericpre ericpre merged commit 58d98ae into hyperspy:main Mar 15, 2024
3 checks passed
@jlaehne jlaehne deleted the table branch March 16, 2024 14:08
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.

None yet

4 participants