Skip to content
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
32a62b0
feat(color-loupe): implement Color Loupe component with base function…
blunteshwar Apr 7, 2026
257afe2
Merge branch 'main' into claude-do-the-honors
blunteshwar Apr 16, 2026
c07e84e
refactor(color-loupe): added migration planning and docs
blunteshwar Apr 16, 2026
758d969
fix(color-loupe): fixed styling
blunteshwar Apr 16, 2026
688e358
Merge branch 'color-loupe-migration' into claude-do-the-honors
blunteshwar Apr 16, 2026
087c548
chore(color-loupe): add TODO for opacity-checkerboard migration
blunteshwar Apr 17, 2026
067bbe6
chore(color-loupe): reverting some changes
blunteshwar Apr 17, 2026
cffaead
feat(color-loupe): enhance color loupe functionality and documentation
blunteshwar Apr 17, 2026
50b7660
refactor(color-loupe): rename States story to OpenAndClosedStates and…
blunteshwar Apr 17, 2026
eb74d4b
refactor(color-loupe): update clip-path and SVG path for improved sha…
blunteshwar Apr 21, 2026
e207c22
fix(color-loupe): correct story identifiers in accessibility tests
blunteshwar Apr 21, 2026
fc8dbcf
chore(color-loupe): address PR review feedback
blunteshwar Apr 21, 2026
474e315
test(color-loupe): improve opacity assertions in OpenAttributeTest
blunteshwar Apr 21, 2026
7acd6ea
refactor(color-loupe): refactored css according to styling guides
blunteshwar Apr 22, 2026
5fd30c1
refactor(color-loupe): added default color to base
blunteshwar Apr 22, 2026
05cafaf
docs(color-loupe): update documentation for color loupe anatomy and i…
blunteshwar Apr 22, 2026
0e20e5f
chore: minor fix
blunteshwar Apr 22, 2026
11f1742
refactor(color-loupe): improved stories
blunteshwar Apr 22, 2026
2a706e5
docs(color-loupe): reference existing validateColorString in @todo
blunteshwar Apr 22, 2026
2599274
chore: minor fix
blunteshwar Apr 22, 2026
e360348
chore: added a line to remove linting error
blunteshwar Apr 22, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions 2nd-gen/packages/core/components/color-loupe/ColorLoupe.base.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
/**
* Copyright 2026 Adobe. All rights reserved.
* This file is licensed to you under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. You may obtain a copy
* of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under
* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
* OF ANY KIND, either express or implied. See the License for the specific language
* governing permissions and limitations under the License.
*/

import { property } from 'lit/decorators.js';

import { SpectrumElement } from '@spectrum-web-components/core/element/index.js';

import { COLOR_LOUPE_DEFAULT_COLOR } from './ColorLoupe.types.js';

/**
* A visual magnifier that shows the currently picked color, including
* transparency over an opacity checkerboard, inside a loupe shape.
*
* The loupe is not an interactive control — accessibility semantics are
* provided by the parent color picker / color field.
*
* @element swc-color-loupe
*/
export abstract class ColorLoupeBase extends SpectrumElement {
// ─────────────────
// SHARED API
// ─────────────────

/**
* Whether the loupe is visible. When `false` the loupe is hidden via
* CSS opacity and transform transitions.
*/
@property({ type: Boolean, reflect: true })
public open = false;

/**
* The CSS color value to display inside the loupe.
* Supports any valid CSS color string, including those with alpha
* transparency (which reveals the checkerboard behind).
*/
@property({ type: String })
public color = COLOR_LOUPE_DEFAULT_COLOR;
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should be validating color is a valid CSS string and warn/error if its invalid. I could see a method similar to ifDefined that we can use across other components expecting CSS strings. isValidColoror isCSSColor something along those lines. could be established here or just go straight to core tools as a utility method.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We might want to leave that to implementation to use their own validation to avoid any perf load and also they might accept a format that we don't include. Possibly a TODO to investigate later?

Copy link
Copy Markdown
Contributor

@caseyisonit caseyisonit Apr 22, 2026

Choose a reason for hiding this comment

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

when i say validating i mean string validation that it matches a color value structure. like does it match an rgba(0, 0, 0, 0) as a string for an example.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

We already have a method public validateColorString in ColorController.ts in reactive controllers. Since color-loupe always receives color from parent-component hence it does not use validateColorString method.

Copy link
Copy Markdown
Contributor Author

@blunteshwar blunteshwar Apr 22, 2026

Choose a reason for hiding this comment

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

ColorController.validateColorStringis the right hook if this ever needs standalone validation. Updated the @todo to reference the existing utility rather than proposing a new one, and made the reasoning explicit (the loupe delegates to its parent, which validates upstream):

/**
 * The CSS color value to display inside the loupe.
 * Supports any valid CSS color string, including those with alpha
 * transparency (which reveals the checkerboard behind).
 *
 * Default is semi-transparent red so the opacity checkerboard is visible
 * when the component is rendered without a `color` attribute.
 *
 * @todo Runtime validation is intentionally not performed here. The loupe
 * always receives its color from a parent color-picker component, which
 * validates upstream via `validateColorString` on `ColorController`. If
 * the loupe ever needs standalone validation (e.g. consumed outside a
 * parent color picker), reuse `ColorController.validateColorString`
 * rather than adding a separate utility.
 */

}
17 changes: 17 additions & 0 deletions 2nd-gen/packages/core/components/color-loupe/ColorLoupe.types.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
/**
* Copyright 2026 Adobe. All rights reserved.
* This file is licensed to you under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. You may obtain a copy
* of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under
* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
* OF ANY KIND, either express or implied. See the License for the specific language
* governing permissions and limitations under the License.
*/

/**
* Default color value for a newly created color loupe.
* Semi-transparent red allows the opacity checkerboard to show through.
*/
export const COLOR_LOUPE_DEFAULT_COLOR = 'rgba(255, 0, 0, 0.5)';
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

this isnt a type and can we defined in the base since its just a default value

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Good catch — you're right, it wasn't a type. Since COLOR_LOUPE_DEFAULT_COLOR was the only thing in ColorLoupe.types.ts and no associated enum/union justified its existence, I deleted the file entirely. The default now lives inline at the property declaration in the base class:

@property({ type: String })
public color = 'rgba(255, 0, 0, 0.5)';

A short line in the property JSDoc explains the choice (semi-transparent red reveals the opacity checkerboard on initial render).

Also updated the index.ts barrel to drop the types re-export, and the migration checklist to note the file is intentionally absent with a link back to this thread for future reference.

13 changes: 13 additions & 0 deletions 2nd-gen/packages/core/components/color-loupe/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
/**
* Copyright 2026 Adobe. All rights reserved.
* This file is licensed to you under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. You may obtain a copy
* of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under
* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
* OF ANY KIND, either express or implied. See the License for the specific language
* governing permissions and limitations under the License.
*/
export * from './ColorLoupe.base.js';
export * from './ColorLoupe.types.js';
6 changes: 6 additions & 0 deletions 2nd-gen/packages/swc/.storybook/preview.ts
Original file line number Diff line number Diff line change
Expand Up @@ -360,6 +360,12 @@ const preview = {
['Rendering and styling migration analysis'],
'Color field',
['Rendering and styling migration analysis'],
'Color loupe',
[
'Accessibility migration analysis',
'Migration checklist',
'Rendering and styling migration analysis',
],
'Divider',
[
'Accessibility migration analysis',
Expand Down
85 changes: 85 additions & 0 deletions 2nd-gen/packages/swc/components/color-loupe/ColorLoupe.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
/**
* Copyright 2026 Adobe. All rights reserved.
* This file is licensed to you under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. You may obtain a copy
* of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under
* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
* OF ANY KIND, either express or implied. See the License for the specific language
* governing permissions and limitations under the License.
*/

import { CSSResultArray, html, TemplateResult } from 'lit';
import { classMap } from 'lit/directives/class-map.js';

import { ColorLoupeBase } from '@spectrum-web-components/core/components/color-loupe';

import styles from './color-loupe.css';

/**
* A visual magnifier that displays the currently picked color inside a
* loupe-shaped container with an opacity checkerboard behind transparent
* colors. The loupe is a non-interactive, visual-only companion to
* color selection controls such as `<swc-color-field>`.
*
* @element swc-color-loupe
* @status preview
* @since 0.0.1
*
* @example
* <swc-color-loupe open color="rgba(0, 128, 255, 0.7)"></swc-color-loupe>
*/
export class ColorLoupe extends ColorLoupeBase {
// ──────────────────────────────
// RENDERING & STYLING
// ──────────────────────────────

// TODO: Migrate opacity-checkerboard to 2nd gen and consume it here; checkerboard styling is currently hardcoded in color-loupe.css.
Comment thread
caseyisonit marked this conversation as resolved.
Outdated

public static override get styles(): CSSResultArray {
return [styles];
}

protected override render(): TemplateResult {
return html`
<div
class=${classMap({
['swc-ColorLoupe']: true,
})}
>
<div class="swc-ColorLoupe-checkerboard swc-ColorLoupe--clipped"></div>
<div
class="swc-ColorLoupe-colorFill swc-ColorLoupe--clipped"
style="background: ${this.color}"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think we need to add a comment in the contributor docs stating to pass only CSS only strings from trusted sources.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Good call. Added a new section "Inline CSS strings from component properties" to CONTRIBUTOR-DOCS/02_style-guide/02_typescript/09_rendering-patterns.md in commit fc8dbcf5bd.

Using this style="background: ${this.color}" line as the worked example, the new section codifies four rules:

  1. Only accept CSS strings from trusted sources
  2. Prefer structured inputs (classMap + design tokens) over free-form CSS
  3. Scope values through a CSS custom property (styleMap({'--swc-...': value})) rather than interpolating a full declaration
  4. Document the trust contract on the property's JSDoc

It also includes ✅ preferred / ✅ acceptable / ⚠️ use-with-care code examples so it's actionable in review.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The second example it provides of passing this into the value of a custom property vs straight to the background would be preferred, and is the pattern also exemplified in the Spectrum CSS solution.

Copy link
Copy Markdown
Contributor Author

@blunteshwar blunteshwar Apr 22, 2026

Choose a reason for hiding this comment

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

Implemented. The template now routes this.color through a CSS custom property via styleMap, and the stylesheet consumes that property:

// ColorLoupe.ts
style=${styleMap({
  '--swc-color-loupe-picked-color': this.color,
})}
/* color-loupe.css */
.swc-ColorLoupe-colorFill {
  background: var(--swc-color-loupe-picked-color);
}

On HSV point — both background: ${this.color} and background: var(--swc-color-loupe-picked-color) hand the same string to the same browser CSS parser, so the set of accepted color formats is identical across the two patterns. The loupe always receives a CSS-valid string from its parent color picker, which is where non-CSS color-space conversion (including HSV → HSL/RGB) happens.

></div>
<svg aria-hidden="true" class="swc-ColorLoupe-svg" overflow="visible">
Comment thread
blunteshwar marked this conversation as resolved.
<defs>
<path
id="loupe-path"
d="M 22 60 C 18.2 56 14.6 51.7 11.3 47.2 C 8.3 43.3 5.7 39.1 3.5 34.7 C 1.2 30 0 25.9 0 22.4 C 0 17.2 1.8 12.2 5 8.2 C 8.2 4.2 12.7 1.5 17.6 0.4 C 22.6 -0.6 27.8 0.2 32.3 2.6 C 36.8 5 40.3 8.9 42.3 13.7 C 43.4 16.4 44 19.4 44 22.4 C 44 25.9 42.8 30 40.5 34.7 C 38.3 39.1 35.7 43.3 32.7 47.3 C 29.4 51.7 25.8 56 22 60 Z"
transform="translate(2, 2)"
/>
<mask id="loupe-mask">
<rect x="0" y="0" height="100" width="100" fill="white" />
<use href="#loupe-path" fill="black" />
</mask>
</defs>

<g class="swc-ColorLoupe-loupe">
<use
href="#loupe-path"
mask="url(#loupe-mask)"
class="swc-ColorLoupe-innerBorder"
/>
<use
href="#loupe-path"
mask="url(#loupe-mask)"
class="swc-ColorLoupe-outerBorder"
/>
</g>
</svg>
</div>
`;
}
}
102 changes: 102 additions & 0 deletions 2nd-gen/packages/swc/components/color-loupe/color-loupe.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
/**
* Copyright 2026 Adobe. All rights reserved.
* This file is licensed to you under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. You may obtain a copy
* of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under
* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
* OF ANY KIND, either express or implied. See the License for the specific language
* governing permissions and limitations under the License.
*/

Comment thread
blunteshwar marked this conversation as resolved.
:host {
display: block;
position: absolute;
inset-block-end: calc((token("color-handle-size") - token("color-handle-outer-border-width")) + var(--swc-color-loupe-offset, token("color-loupe-bottom-to-color-handle")));
inset-inline-end: calc(50% - (token("color-loupe-width") / 2));
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Since color-loupe-width is referenced multiple times, you can hold this value in a private property.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done. Defined once as a private property on :host and referenced from all three sites:

:host {
  --_swc-color-loupe-width: token("color-loupe-width");
  ...
  inline-size: var(--_swc-color-loupe-width);
  inset-inline-end: calc(50% - (var(--_swc-color-loupe-width) / 2));
}

:host(:dir(rtl)) {
  inset-inline-end: calc(50% - (var(--_swc-color-loupe-width) / 2) - 1px);
}

}

* {
box-sizing: border-box;
}

.swc-ColorLoupe {
--_swc-color-loupe-opacity: var(--swc-color-loupe-opacity, 0);
--_swc-color-loupe-transform: var(--swc-color-loupe-transform, translateY(var(--swc-color-loupe-animation-distance, 8px)));

position: relative;
inline-size: token("color-loupe-width");
block-size: token("color-loupe-height");
pointer-events: none;
opacity: var(--_swc-color-loupe-opacity);
filter: drop-shadow(var(--swc-color-loupe-drop-shadow-x, token("drop-shadow-elevated-x")) var(--swc-color-loupe-drop-shadow-y, token("drop-shadow-elevated-y")) var(--swc-color-loupe-drop-shadow-blur, token("drop-shadow-elevated-blur")) var(--swc-color-loupe-drop-shadow-color, token("drop-shadow-elevated-color")));
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Per our guidelines, we are not exposing every token, only those that are actually modified by the component. This definition can be simplified to remove all of the exposed properties. Same for several other instances in this stylesheet.

I assume AI just converted the mod properties, but again, that is an anti-pattern.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done. Exposed --swc-color-loupe-* surface went from 10 properties down to 1 (only --swc-color-loupe-picked-color, which the component itself modifies on every render via the template).

Collapsed to direct token() calls (none modified by the component):

  • --swc-color-loupe-offset
  • --swc-color-loupe-animation-distance
  • --swc-color-loupe-drop-shadow-{x,y,blur,color} (×4)
  • --swc-color-loupe-inner-border-{color,width} (×2)
  • --swc-color-loupe-outer-border-width

The --swc-color-loupe-opacity / --swc-color-loupe-transform passthrough pair got replaced with literals on .swc-ColorLoupe, driven by :host([open]) .swc-ColorLoupe.

The outer-border-color is only modified in forced-colors mode, so per the exclusions guideline it's now an internal --_swc-color-loupe-outer-border-color shared by the normal rule and the forced-colors media query — same pattern status-light uses.

transform: var(--_swc-color-loupe-transform);
transform-origin: bottom center;
transition:
transform 100ms ease-in-out,
opacity 125ms ease-in-out;
}

/* Opacity checkerboard shown behind transparent picked colors.
The dark-square token has separate light/dark theme values, so
we use light-dark() with the explicit theme variants. */
.swc-ColorLoupe-checkerboard {
position: absolute;
inset-block-start: 2px;
inset-inline-start: 2px;
inline-size: 100%;
block-size: 100%;
background: repeating-conic-gradient(light-dark(var(--swc-opacity-checkerboard-square-dark-light), var(--swc-opacity-checkerboard-square-dark-dark)) 0% 25%, token("opacity-checkerboard-square-light") 0% 50%) 0 0 / token("opacity-checkerboard-square-size-medium") token("opacity-checkerboard-square-size-medium");
}

/* Color fill layer — displays the picked color */
.swc-ColorLoupe-colorFill {
position: absolute;
inset-block-start: 2px;
inset-inline-start: 2px;
inline-size: 100%;
block-size: 100%;
}

/* Clip to the loupe teardrop shape */
.swc-ColorLoupe--clipped {
clip-path: path("M 22 60 C 18.2 56 14.6 51.7 11.3 47.2 C 8.3 43.3 5.7 39.1 3.5 34.7 C 1.2 30 0 25.9 0 22.4 C 0 17.2 1.8 12.2 5 8.2 C 8.2 4.2 12.7 1.5 17.6 0.4 C 22.6 -0.6 27.8 0.2 32.3 2.6 C 36.8 5 40.3 8.9 42.3 13.7 C 43.4 16.4 44 19.4 44 22.4 C 44 25.9 42.8 30 40.5 34.7 C 38.3 39.1 35.7 43.3 32.7 47.3 C 29.4 51.7 25.8 56 22 60 Z");
}

/* SVG overlay — inherits host dimensions */
.swc-ColorLoupe-svg {
position: absolute;
inline-size: inherit;
block-size: inherit;
}

/* Inner border: filled with the picked color + thin stroke */
.swc-ColorLoupe-innerBorder {
fill: none;
stroke: var(--swc-color-loupe-inner-border-color, token("color-loupe-inner-border"));
stroke-width: var(--swc-color-loupe-inner-border-width, token("color-loupe-inner-border-width"));
}

/* Outer border: unfilled with wider stroke */
.swc-ColorLoupe-outerBorder {
fill: none;
stroke: var(--swc-color-loupe-outer-border-color, token("color-loupe-outer-border"));
stroke-width: calc(var(--swc-color-loupe-outer-border-width, token("color-loupe-outer-border-width")) + 2px);
}

/* Compensates for sub-pixel rounding in RTL that shifts the loupe */
:host(:dir(rtl)) {
inset-inline-end: calc(50% - (token("color-loupe-width") / 2) - 1px);
}

:host([open]) {
--swc-color-loupe-opacity: 1;
--swc-color-loupe-transform: translate(0, 0);
}

@media (forced-colors: active) {
Comment thread
blunteshwar marked this conversation as resolved.
.swc-ColorLoupe-outerBorder {
--swc-color-loupe-outer-border-color: CanvasText;
}
}
22 changes: 22 additions & 0 deletions 2nd-gen/packages/swc/components/color-loupe/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
/**
* Copyright 2026 Adobe. All rights reserved.
* This file is licensed to you under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. You may obtain a copy
* of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under
* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
* OF ANY KIND, either express or implied. See the License for the specific language
* governing permissions and limitations under the License.
*/
import { defineElement } from '@spectrum-web-components/core/element/index.js';

import { ColorLoupe } from './ColorLoupe.js';

export * from './ColorLoupe.js';
declare global {
interface HTMLElementTagNameMap {
'swc-color-loupe': ColorLoupe;
}
}
defineElement('swc-color-loupe', ColorLoupe);
Loading
Loading