Skip to content
This repository was archived by the owner on Apr 20, 2026. It is now read-only.

Commit 8ece3da

Browse files
jkrengeclaude
andcommitted
docs: rename screenshots and add CSS element hiding examples
Rename screenshots to descriptive filenames (shorttext/longtext/emptystate variants) and reorganize the comparison table into 3 rows of 2. Add documentation for hiding widget elements via CSS classes. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent be65b38 commit 8ece3da

7 files changed

Lines changed: 53 additions & 18 deletions

README.md

Lines changed: 53 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,26 @@ Use this widget as-is, or as a starting point for building your own custom integ
66

77
**[Live demo](https://parcellab.github.io/selection-guide-ui/)**
88

9-
| Neutral | Colored |
9+
**Sample with short info text**
10+
11+
| | |
12+
| :---: | :---: |
13+
| ![Short text, neutral](screenshots/shorttext_neutral_comfortable_inline.png) | ![Short text, colored](screenshots/shorttext_colored_compact_card.png) |
14+
| neutral color, comfortable spacing, inline display | colored, compact spacing, card display |
15+
16+
**Sample with longer info text**
17+
18+
| | |
1019
| :---: | :---: |
11-
| ![Empty state](screenshots/widget-empty-state.png) | ![Fallback true-to-size](screenshots/widget-fallback-true-to-size.png) |
12-
| `notFoundMode: 'empty'` | `notFoundMode: 'true-to-size'` |
13-
| ![Runs small](screenshots/widget-runs-small.png) | ![Runs small colored](screenshots/widget-runs-small-colored.png) |
14-
| `appearance: 'neutral'` · long summary | `appearance: 'colored'` · long summary |
15-
| ![True to size](screenshots/widget-true-to-size-neutral.png) | ![True to size colored](screenshots/widget-true-to-size-colored.png) |
16-
| `appearance: 'neutral'` · short summary | `appearance: 'colored'` · short summary |
20+
| ![Long text, neutral](screenshots/longtext_neutral_compact_inline.png) | ![Long text, colored](screenshots/longtext_colored_compact_card.png) |
21+
| neutral color, compact spacing, inline display | colored, compact spacing, card display |
22+
23+
**Missing data**
24+
25+
| | |
26+
| :---: | :---: |
27+
| ![Empty state, show default](screenshots/emptystate_show-default.png) | ![Empty state, show missing](screenshots/emptystate_show-missing.png) |
28+
| `notFoundMode: 'true-to-size'` — shows default fit info | `notFoundMode: 'empty'` — shows missing data notice |
1729

1830
## Overview
1931

@@ -164,17 +176,40 @@ The widget renders in **light DOM** (not Shadow DOM), so host-page typography in
164176
### Element Classes
165177

166178
```
167-
.pl-size-recommender__header
168-
.pl-size-recommender__title
169-
.pl-size-recommender__pill
170-
.pl-size-recommender__scale
171-
.pl-size-recommender__scale-labels
172-
.pl-size-recommender__track
173-
.pl-size-recommender__marker
174-
.pl-size-recommender__confidence
175-
.pl-size-recommender__recommendation
176-
.pl-size-recommender__recommendation-title
177-
.pl-size-recommender__recommendation-summary
179+
.pl-size-recommender__header — header row (title + pill)
180+
.pl-size-recommender__title — "How It Fits" heading
181+
.pl-size-recommender__pill — fit category badge
182+
.pl-size-recommender__scale — scale container (labels + track)
183+
.pl-size-recommender__scale-labels — "Runs Small / True to Size / Runs Large"
184+
.pl-size-recommender__track — the horizontal fit bar
185+
.pl-size-recommender__marker — position dot on the track
186+
.pl-size-recommender__recommendation — recommendation callout card
187+
.pl-size-recommender__recommendation-header — header row inside recommendation
188+
.pl-size-recommender__recommendation-icon — fit direction icon (↑/↓/−)
189+
.pl-size-recommender__recommendation-title — e.g., "Consider sizing up"
190+
.pl-size-recommender__recommendation-meta — confidence text
191+
.pl-size-recommender__recommendation-summary — AI-generated feedback summary
192+
```
193+
194+
### Hiding Elements
195+
196+
Use `display: none` on any element class to hide specific parts:
197+
198+
```css
199+
/* Hide the confidence score */
200+
.pl-size-recommender__recommendation-meta { display: none; }
201+
202+
/* Hide the AI summary text */
203+
.pl-size-recommender__recommendation-summary { display: none; }
204+
205+
/* Hide the fit category pill badge */
206+
.pl-size-recommender__pill { display: none; }
207+
208+
/* Hide the entire scale bar */
209+
.pl-size-recommender__scale { display: none; }
210+
211+
/* Hide the widget entirely when in empty/no-data state */
212+
.pl-size-recommender--state-empty { display: none; }
178213
```
179214

180215
### CSS Variables
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)