go-gitea / gitea

Git with a cup of tea! Painless self-hosted all-in-one software development service, including Git hosting, code review, team collaboration, package registry and CI/CD
https://gitea.com
MIT License
45.26k stars 5.51k forks source link

Fomantic UI replacements via web components #29849

Open silverwind opened 8 months ago

silverwind commented 8 months ago

Feature Description

As many know, we want to get rid of Fomantic UI. I propose the following:

I think custom elements are the future for Gitea's UI as they work on both backend-rendered content as well as frameworks like Vue and React.

We should first investigate if there are suitable web components available for these modules. Requrement for them is that they have good a11y and they need to be headless (e.g. no CSS).

If no suitable npm modules are available, we can write our own like was recently done for <overflow-menu> and <absolute-date>.

silverwind commented 8 months ago

https://github.com/shoelace-style/shoelace looks like a interesting library of web components. It uses floating-ui so should be top-notch for placment of floating content.

harryzcy commented 8 months ago

Some of the components may be rarely used. What about implementing them via tailwindcss?

silverwind commented 8 months ago

What does "implementing via tailwindcss" exactly mean? You can't implement stuff like interactivity, reactivity, a11y and many other things with CSS alone.

harryzcy commented 8 months ago

What does "implementing via tailwindcss" exactly mean? You can't implement stuff like interactivity, reactivity, a11y and many other things with CSS alone.

I get it. I only mean some CSS only UI components.

silverwind commented 8 months ago

Sure, what can be done with CSS only should be done with it. But I'm really talking about the more complex components like Dropdown and Modal which will require JS.

denyskon commented 8 months ago

https://github.com/shoelace-style/shoelace looks like a interesting library of web components. It uses floating-ui so should be top-notch for placment of floating content.

@silverwind This looks really promising, did you try it already? There are lots of styling options....

silverwind commented 8 months ago

Did not try it yet, but first we should assert that the a11y of these components is ok. We should not blindly trust their claims 😆.

denyskon commented 7 months ago

@wxiaoguang I've seen you evaluating a11y for some components. What do you normally test? I'd really like if we could replace fomantic soon, but as silverwind said we need to check a11y for these components first 😅

wxiaoguang commented 7 months ago

There are some details in aria.md. Usually: the screen content could be read out correctly, the a11y active element could be highlighted and switched correctly. Actually the most difficult part is "dropdown ( menu / select / combobox / popup )". Other components are quite easy to work with native a11y support.

silverwind commented 7 months ago

@wxiaoguang maybe you can review these components for their accessibility:

wxiaoguang commented 7 months ago

@wxiaoguang maybe you can review these components for their accessibility:

I think they work well

delvh commented 7 months ago

I just tested these four components. All are easily accessible (from my perspective as an unimpaired user).

There might be one issue where I'm not quite sure how bad it is: The components lack any aria- attributes (besides aria-disabled="false" and role="…"). I don't know how much impaired users rely on these being explicitly present. As long as we only have text content within, my guess is it should be fine.

As such, here's my :+1: to adopt shoelace instead.

denyskon commented 7 months ago

Shoelace is currently being transferred to become a project of FontAwesome: https://www.kickstarter.com/projects/fontawesome/web-awesome/description

They stated that there will be a bunch of breaking changes for 3.0, maybe it does make sense to wait

silverwind commented 7 months ago

I'm skeptical, seen too many such takeovers go wrong. I guess we'll wait until it's clear which components will be part of their "pro" version.

Also I would like to avoid a FontAwesome dependency, we ripped that out of Gitea not too long ago 😆.

denyskon commented 7 months ago

There is a lot of information in https://www.kickstarter.com/projects/fontawesome/web-awesome/faqs

I'm sceptical too, but it doesn't seem like anything bad will happen to the existing project, just that new development will probably focus more on the pro version than the free one

silverwind commented 7 months ago

Seems okay. Basic components will remain in the free version and those are all we need. We definitely don't need things like data grid.

Of course we should remain on the lookout for other webcomponent-based frameworks, the lighter the better.

condemil commented 3 months ago

Actually there are ways to implement dropdown and modal without JS, as soon as Gitea uses Tailwind you can check how it's done in daisyUI and use the similar approach in Gitea if it fits the need:

https://daisyui.com/components/dropdown/ https://daisyui.com/components/modal/

silverwind commented 3 months ago

there are ways to implement dropdown and modal without JS

Only the very simplest of dropdowns can. As soon as you need functionality like a search you are in JS land.

Edit: I guess "Dropdown" is a convoluted term. If it just means floating content, then I can recommend either tippy.js or its successor floating-ui which both allow very sophisticated placement of floating content.

condemil commented 3 months ago

Search could be done with htmx

surfinky commented 4 weeks ago

If you are looking at Web Components which is the most future proof approach that is lightweight, stay the hell away from Shoelace, or any component library that relies on or includes build steps for nonsense like TypeScript.