color-elements 0.0.2 → 0.0.4

package/src/color-swatch/README.md

@@ -2,32 +2,221 @@
 
 ## Examples
 
-### Static
+### Basic usage
+
+<table>
+<thead>
+	<tr>
+		<th></th>
+		<th>Default</th>
+		<th>Large</th>
+	</tr>
+</thead>
+<tbody>
+<tr>
+<th>Static</th>
+<td>
 
 ```html
 <color-swatch>oklch(70% 0.25 138)</color-swatch>
 ```
+</td>
+<td>
 
 ```html
 <color-swatch size="large">oklch(70% 0.25 138)</color-swatch>
 ```
-
-### Editable
+</td>
+</tr>
+<tr>
+<th>Editable</th>
+<td>
 
 ```html
 <color-swatch>
 	<input value="oklch(70% 0.25 138)" />
 </color-swatch>
 ```
+</td>
+<td>
 
 ```html
 <color-swatch size="large">
 	<input value="oklch(70% 0.25 138)" />
 </color-swatch>
 ```
+</td>
+</tr>
+</tbody>
+</table>
+
+You can use a `--details-style: compact` CSS property to only show the details on user interaction:
+
+```html
+<color-swatch style="--details-style: compact">oklch(70% 0.25 138)</color-swatch>
+<color-swatch size="large" style="--details-style: compact">oklch(70% 0.25 138)</color-swatch>
+```
+
+Warning: This is not keyboard accessible by default.
+To make the element focusable and also show the popup when it is focused, you need to add `tabindex="0"` to your element:
+
+```html
+<color-swatch size="large" style="--details-style: compact" tabindex="0">oklch(70% 0.25 138)</color-swatch>
+```
+
+By default, the popup will be shown when the element is hovered, focused, `:active`, or the target of the URL hash.
+To circumvent user interaction and force the popup to be open use the `open` attribute.
+You can also use `open="false"` to force it to be closed regardless of interaction:
+
+```html
+<div style="--details-style: compact">
+	<color-swatch size="large">oklch(70% 0.25 138)</color-swatch>
+	<color-swatch size="large" open>oklch(70% 0.25 138)</color-swatch>
+	<color-swatch size="large" open="false">oklch(70% 0.25 138)</color-swatch>
+</div>
+```
+
+### The `value` attribute
+
+You can provide the color via the `value` attribute,
+which can be more convenient when you have slotted content.
+
+In that case, the content of the element is merely presentational
+(unless it’s an `<input>`).
+If you don’t specify any content, no text will be shown.
+
+<table>
+<thead>
+	<tr>
+		<th>Static</th>
+		<th>Editable</th>
+	</tr>
+</thead>
+<tbody>
+<tr>
+
+<td>
+
+```html
+<color-swatch value="oklch(70% 0.25 138)" size="large">red</color-swatch>
+```
+
+</td>
+<td>
+
+```html
+<color-swatch value="oklch(70% 0.25 138)" size="large">
+	<input />
+</color-swatch>
+```
+</td>
+
+</tr>
+</tbody>
+</table>
+
+You can also use this as a property when creating color swatches dynamically:
+
+```html
+<div id="future_swatch_container"></div>
+<script>
+let swatch = document.createElement("color-swatch");
+swatch.value = "oklch(65% 0.15 210)";
+swatch.setAttribute("size", "large");
+swatch.textContent = "Turquoise";
+future_swatch_container.append(swatch);
+</script>
+```
+
+### The `label` attribute
+
+You can provide the color label via the `label` attribute.
+
+<table>
+<thead>
+	<tr>
+		<th></th>
+		<th>Default</th>
+		<th>Large</th>
+	</tr>
+</thead>
+<tbody>
+<tr>
+<th>Static</th>
+<td>
+
+```html
+<color-swatch label="Turquoise">oklch(65% 0.15 210)</color-swatch>
+```
+</td>
+<td>
+
+```html
+<color-swatch label="Turquoise" size="large">oklch(65% 0.15 210)</color-swatch>
+```
+</td>
+</tr>
+<tr>
+<th>Editable</th>
+<td>
+
+```html
+<color-swatch label="Turquoise">
+	<input value="oklch(65% 0.15 210)" />
+</color-swatch>
+```
+</td>
+<td>
+
+```html
+<color-swatch label="Turquoise" size="large">
+	<input value="oklch(65% 0.15 210)" />
+</color-swatch>
+```
+</td>
+</tr>
+</tbody>
+</table>
+
+If the attribute's value matches the element's content, no additional text with the label will be shown.
+
+```html
+<color-swatch label="Turquoise" value="oklch(65% 0.15 210)" size="large">Turquoise</color-swatch>
+```
+
+If used as a property and is not defined via the `label` attribute, its value is that of the element text content.
+
+### The `info` attribute
+
+You can use the `info` attribute to show information about the color.
+Currently, the only type of information supported is color coords (in any color space), but more will be added in the future.
+
+```html
+<color-swatch info="oklch.l, oklch.c, oklch.h" size="large">
+	oklch(70% 0.25 138)
+</color-swatch>
+```
+
+By default, the label for each value will be determined automatically from the type of information (e.g. the full coord name if a coord),
+but you can customize this by adding a label before the description of the data:
+
+```html
+<color-swatch info="L: oklch.l, C: oklch.c, H: oklch.h" size="large">
+	oklch(70% 0.25 138)
+</color-swatch>
+```
+
+
+The `info` attribute plays quite nicely with the `--details-style: compact` style:
+
+```html
+<color-swatch size="large" info="oklch.l, oklch.c, oklch.h" style="--details-style: compact">oklch(70% 0.25 138)</color-swatch>
+```
 
 ### With slot content
 
+Before and after:
+
 ```html
 <color-swatch>
 	<label slot="before" for=c1>Accent color:</label>
@@ -35,9 +224,16 @@
 </color-swatch>
 ```
 
+```html
+<color-swatch>
+	<label slot="before" for=c1>Accent color:</label>
+	oklch(70% 0.25 138)
+</color-swatch>
+```
+
 ```html
 <color-swatch size="large">
-	<label slot="before" id=c2>Accent color:</label>
+	<label slot="before" for=c2>Accent color:</label>
 	<input value="oklch(70% 0.25 138)" id=c2 />
 	<small slot="after">Tip: Pick a bright medium color.</small>
 </color-swatch>
@@ -52,6 +248,10 @@ Adding text within the default swatch:
 </color-swatch>
 ```
 
+Note that the text color will automatically switch from black to white to remain readable (using [this technique](https://lea.verou.me/blog/2024/contrast-color/)).
+
+----
+
 Replacing the whole swatch with a custom element:
 
 ```html
@@ -61,10 +261,12 @@ Replacing the whole swatch with a custom element:
 </color-swatch>
 ```
 
+<!--
 ### Bound to CSS property
 
 You can automatically bind the color swatch to a CSS property by setting the `property` attribute.
-Then you don’t need to provide an initial value, it will be read from the CSS property.
+Then you don’t need to provide an initial value, it will be read from the CSS property,
+and updating the color will update the CSS property.
 
 ```html
 <color-swatch size="large" property="--color-red">
@@ -72,6 +274,10 @@ Then you don’t need to provide an initial value, it will be read from the CSS
 </color-swatch>
 ```
 
+You can use `scope` to select the closest ancestor (via a CSS selector) on which the CSS property will be read from and written to.
+If you don’t, the `<html>` element will be used.
+-->
+
 ### Events
 
 ```html
@@ -97,4 +303,57 @@ Then you don’t need to provide an initial value, it will be read from the CSS
 	<input value="oklch(70% 0.25 138)" />
 </color-swatch>
 <button onclick='dynamic_editable.color = "oklch(60% 0.15 0)"'>Change color</button>
-```
+```
+
+## Reference
+
+### Attributes & Properties
+
+| Attribute | Property | Property type | Default value | Description |
+|-----------|----------|---------------|---------------|-------------|
+| `color` | `color` | `Color` &#124; `string` | - | The current color value. |
+| `info` | `info` | `string` | - | Comma-separated list of coords of the current color to be shown. |
+| `value` | `value` | `string` | - | The current value of the swatch. |
+| `label` | `label` | `string` | - | The label of the swatch (e.g., color name). Defaults to the element text content. |
+| `size` | - | `large` | - | The size of the swatch. Currently, it is used only to make a large swatch. |
+| `property` | `property` | `string` | - | CSS property to bind to. |
+| `scope` | `scope` | `string` | `:root` | CSS selector to use as the scope for the specified CSS property. |
+| `gamuts` | `gamuts` | `string` | `srgb, p3, rec2020: P3+, prophoto: PP` | Comma-separated list of gamuts to be used by the gamut indicator. |
+| `open` | `open` | | `null` | Force the details popup open or closed. |
+
+### Getters
+
+These properties are read-only.
+
+| Name | Type | Description |
+|----------|------|-------------|
+| `gamut` | `string` | The id of the current gamut (e.g. `srgb`). |
+
+### CSS variables
+
+| Name | Type | Description |
+|----------|---------------|-------------|
+| `--details-style` | `compact` &#124; `normal` (default) | |
+| `--transparency-grid` | `<image>` | Gradient used as a background for transparent parts of the swatch. |
+| `--transparency-cell-size` | `<length>` | The size of the cells of the transparency gradient. |
+| `--transparcency-background` | `<color>` | The background color of the transparency gradient. |
+| `--transparency-darkness` | `<percentage>` | The opacity of the black color used for dark parts of the transparency gradient. |
+
+### Parts
+
+| Name | Description |
+|------|-------------|
+| `swatch` | The swatch used to render the color. |
+| `details` | Wrapper around all non-swatch content (color name, info, etc) |
+| `label` | The label of the swatch |
+| `color-wrapper` | Wrapper around the color name itself |
+| `gamut` | Gamut indicator |
+| `info` | Any info generateed by the `info` attribute |
+
+### Events
+
+| Name | Description |
+|------|-------------|
+| `valuechange` | Fired when the value changes for any reason, and once during initialization. |
+| `colorchange` | Fired when the color changes for any reason, and once during initialization. |
+| `gamutchange` | Fired when the gamut changes for any reason, and once during initialization. |

package/src/color-swatch/color-swatch.css

@@ -1,64 +1,207 @@
 :host {
 	--_transparency-cell-size: var(--transparency-cell-size, .5em);
-	--_transparency-background: var(--transparcency-background, transparent);
+	--_transparency-background: var(--transparency-background, transparent);
 	--_transparency-darkness: var(--transparency-darkness, 5%);
-	--_transparency: var(--transparcency,
+	--_transparency-grid: var(--transparency-grid,
 		repeating-conic-gradient(transparent 0 25%, rgb(0 0 0 / var(--_transparency-darkness)) 0 50%)
 		0 0 / calc(2 * var(--_transparency-cell-size)) calc(2 * var(--_transparency-cell-size))
 		content-box border-box var(--_transparency-background)
 	);
+
+	position: relative;
 	display: inline-flex;
 	gap: .3em;
-	width: min-content;
+	width: var(--color-swatch-width, fit-content);
 	margin: .3em;
+	border-radius: var(--color-swatch-radius, .2rem);
 }
 
 :host([size="large"]) {
 	flex-flow: column;
+	inline-size: 11em;
+	min-block-size: 6em;
+	contain: inline-size;
+	container-name: color-swatch;
+	container-type: inline-size;
+}
+
+slot {
+	all: inherit;
+	display: contents;
 }
 
 #gamut {
 	font-size: 80%;
+
+	&:is(:host([size="large"]) *) {
+		position: absolute;
+		top: 0;
+		right: 0;
+		margin: .5rem;
+	}
+
+	&:not(:host([size="large"]) *) {
+		@container style(--details-style: compact) {
+			position: absolute;
+			font-size: 50%;
+			top: 0;
+			right: 0;
+			margin: .2rem;
+		}
+
+		&:is(.static *) {
+			align-self: baseline;
+		}
+	}
+
+
+
+	&[style*="--gamut-level: 0"] {
+		display: none;
+	}
+}
+
+[part="info"] {
+	margin: 0;
+	display: inline-flex;
+	display: none;
+	gap: .5em;
+
+	&:is(:host([size="large"]) &) {
+		display: grid;
+		grid-template-columns: max-content auto;
+		gap: .1em .2em;
+		font-size: max(9px, 80%);
+		justify-content: start;
+
+		.coord {
+			display: contents;
+		}
+	}
+
+	.coord {
+		display: flex;
+		gap: .2em;
+
+		dd {
+			margin: 0;
+			font-weight: bold;
+			font-variant-numeric: tabular-nums;
+		}
+	}
 }
 
-#wrapper {
+[part="details"] {
 	display: flex;
 	flex-flow: inherit;
 	gap: inherit;
 
+	/* Prevent flex items from overflowing */
+	min-inline-size: 0;
+
 	&.static {
-		gap: .4em;
+		&:is(:host([size="large"]) *) {
+			background: canvas;
+		}
 	}
 
 	&:not(:host([size="large"]) *) {
 		align-items: baseline;
 	}
-}
 
-[part="color-wrapper"] {
-	position: relative;
-	display: flex;
-	gap: .2em;
+	@container color-swatch (width <= 5rem) {
+		font-size: 80%;
+	}
+
+	@container style(--details-style: compact) {
+		--_border-color: var(--border-color, color-mix(in oklab, buttonborder 20%, oklab(none none none / 0%)));
+		--_pointer-height: var(--pointer-height, .5em);
+		--_transition-duration: var(--transition-duration, 400ms);
+		--_details-popup-width: var(--details-popup-width, max-content);
 
-	&:not(.static *) {
-		#gamut {
+		position: absolute;
+		left: 50%;
+		z-index: 2;
+		translate: -50% 0;
+		bottom: 100%;
+		margin-bottom: calc(var(--_pointer-height) * .8);
+		width: var(--_details-popup-width);
+		background: canvas;
+		border: 1px solid var(--_border-color);
+		padding: .6em 1em;
+		border-radius: .2rem;
+		box-shadow: 0 .05em 1em -.7em black;
+		transition: var(--_transition-duration) allow-discrete;
+		transition-property: all, display;
+		transition-delay: 0s, var(--_transition-duration);
+		transform-origin: 50% calc(100% + var(--_pointer-height));
+
+		&[popover] {
+			/* Make the triangle pointer visible */
+			overflow: visible;
+
+			/* Bring the popover back on the screen */
+			position: fixed;
+			inset: unset;
+
+			/* And position it relative to the parent swatch */
+			left: var(--_popover-left);
+			top: var(--_popover-top);
+			translate: -50% -100%;
+		}
+
+		/* Triangle pointer */
+		&::before {
+			content: "";
 			position: absolute;
-			inset: .3em;
-			inset-inline-start: auto;
+			top: 100%;
+			left: 50%;
+			translate: -50% -50%;
+			aspect-ratio: 1;
+			height: calc(var(--_pointer-height) * sqrt(2));
+			background: inherit;
+			border: inherit;
+			rotate: -45deg;
+			clip-path: polygon(0 0, 0 100%, 100% 100%);
 		}
-	}
 
-	::slotted(input) {
-		padding-inline-end: 2em;
+		&:not(:is(:host(:hover), :host(:focus-within), :host(:active), :host(:target), :host([open])) *),
+		&:is(:host([open=false]) *) {
+			display: none;
+			opacity: 0;
+			scale: 0;
+		}
 	}
 }
 
-slot:not([name]) {
+[part="color"] {
+	display: flex;
+	gap: .2em;
+}
+
+[part="label"] {
+	overflow: hidden;
 	white-space: nowrap;
+	text-overflow: ellipsis;
 }
 
-::slotted(input) {
-	font: inherit;
+slot:not([name]) {
+	&::slotted(input) {
+		display: flex;
+		box-sizing: border-box;
+		min-width: 10ch;
+		font: inherit;
+	}
+
+	&:is(:host([size="large"]) *)::slotted(input) {
+		width: 100%;
+	}
+}
+
+[part="color-wrapper"],
+slot[name=swatch]::slotted(*),
+#swatch {
+	border-radius: inherit;
 }
 
 slot[name=swatch]::slotted(*),
@@ -74,22 +217,23 @@ slot[name=swatch]::slotted(*),
 	flex: 1;
 	background:
 		linear-gradient(var(--color) 0 100%),
-		var(--_transparency);
-	border-radius: .2rem;
+		var(--_transparency-grid);
 
 	&:is(:host([size="large"]) *) {
-		max-inline-size: 15em;
-		min-block-size: 6em;
+		min-block-size: 3em;
 	}
 
 	&:not(:host([size="large"]) *) {
 		display: flex;
 		min-inline-size: 2em;
+		min-block-size: 1em;
 		font-size: 65%;
 		flex: 1;
 	}
 }
 
-:host([swatch="none"]) #swatch {
-	display: none;
-}
+slot[name=swatch-content] {
+	/* See https://lea.verou.me/blog/2024/contrast-color/ */
+	--l: clamp(0, (var(--l-threshold, 0.7) / l - 1) * infinity, 1);
+	color: oklch(from var(--color) var(--l) 0 h);
+}