readthedocs / readthedocs/ext-theme

Add icon label to icon and text hover label

Open
#342 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Accepted Feature
Dominant language
HTML
Stars
12
Forks
6
Avg merge
13h 25m
Merged PRs (30d)
1

Description

One pattern I've wanted in a few places -- the project search dropdown, the project listing view, etc -- is an icon label that expands out to a full icon/text label. This is not a native FUI element.

This could be pure CSS I feel, but if that feels hard, this might be easiest as a web component.

In an unhovered state, the label would be the equivalent of:

<div class="ui icon green circular label">
  <i class="fas fa-check icon"></i>
</div>

image

In a hovered state, the label would expand to the equivalent of:

<div class="ui green circular label">
  <i class="fas fa-check icon"></i>
  Active
</div>

image

It's probably possible to do this with pure CSS, though might get pretty deep into CSS to achieve this. It might be possible to make this a web component too, and simply add the text/class on hover. Either way there should be a nice transition on the size change.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Begin by examining the project search dropdown and project listing view, the locations named for this pattern, and compare their existing FUI labels. Define the collapsed icon-only and hovered icon-plus-text states, including a smooth size transition, then verify the behavior in each relevant view.

Written by the indexing model from the issue text.

Assessment

Tech stack
css, html
Domain
design, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.