@spectrum-web-components/color-area 0.0.0-20241209155954

package/README.md

@@ -0,0 +1,77 @@
+## Description
+
+An `<sp-color-area>` allows users to visually select two properties of a color simultaneously. It's commonly used together with a color slider or color wheel.
+
+### Usage
+
+[![See it on NPM!](https://img.shields.io/npm/v/@spectrum-web-components/color-area?style=for-the-badge)](https://www.npmjs.com/package/@spectrum-web-components/color-area)
+[![How big is this package in your project?](https://img.shields.io/bundlephobia/minzip/@spectrum-web-components/color-area?style=for-the-badge)](https://bundlephobia.com/result?p=@spectrum-web-components/color-area)
+[![Try it on webcomponents.dev](https://img.shields.io/badge/Try%20it%20on-webcomponents.dev-green?style=for-the-badge)](https://webcomponents.dev/edit/collection/fO75441E1Q5ZlI0e9pgq/crxLSSCXLFPpmUsM6GJQ/src/index.ts)
+
+```
+yarn add @spectrum-web-components/color-area
+```
+
+Import the side effectful registration of `<sp-color-area>` via:
+
+```
+import '@spectrum-web-components/color-area/sp-color-area.js';
+```
+
+When looking to leverage the `ColorArea` base class as a type and/or for extension purposes, do so via:
+
+```
+import { ColorArea } from '@spectrum-web-components/color-area';
+```
+
+## Color Formatting
+
+When using the color elements, use `el.color` to access the `color` property, which should manage itself in the colour format supplied. For example, If you supply a color in `rgb()` format, `el.color` should return the color in `rgb()` format, as well. In ColorArea, colours are formatted as hex values.
+
+The current color formats supported are as follows:
+
+-   Hex3, Hex4, Hex6, Hex8
+-   HSV, HSVA
+-   HSL, HSLA
+-   RGB, RGBA
+-   Strings (eg "red", "blue")
+
+## Standard
+
+```html
+<sp-color-area></sp-color-area>
+```
+
+## Variants
+
+### Disabled
+
+An `<sp-color-area>` in a disabled state shows that an input exists, but is not available in that circumstance. This can be used to maintain layout continuity and communicate that the area may become available later.
+
+```html
+<sp-color-area disabled></sp-color-area>
+```
+
+### Sized
+
+An `<sp-color-area>`’s height and width can be customized appropriately for its context.
+
+```html
+<sp-color-area
+    style="
+        width: 72px; 
+        height: 72px"
+></sp-color-area>
+```
+
+## Labels
+
+An `<sp-color-area>` renders accessible labels for each axis: _"saturation"_ and _"luminosity"_.
+Specify `label-x` and `label-y` attributes to override these defaults.
+
+```html
+<sp-color-area
+    label-x="Color intensity"
+    label-y="Color brightness"
+></sp-color-area>
+```

package/package.json

@@ -0,0 +1,81 @@
+{
+    "name": "@spectrum-web-components/color-area",
+    "version": "0.0.0-20241209155954",
+    "publishConfig": {
+        "access": "public"
+    },
+    "description": "",
+    "license": "Apache-2.0",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/adobe/spectrum-web-components.git",
+        "directory": "packages/color-area"
+    },
+    "author": "",
+    "homepage": "https://opensource.adobe.com/spectrum-web-components/components/color-area",
+    "bugs": {
+        "url": "https://github.com/adobe/spectrum-web-components/issues"
+    },
+    "main": "src/index.js",
+    "module": "src/index.js",
+    "type": "module",
+    "exports": {
+        ".": {
+            "development": "./src/index.dev.js",
+            "default": "./src/index.js"
+        },
+        "./package.json": "./package.json",
+        "./src/ColorArea.js": {
+            "development": "./src/ColorArea.dev.js",
+            "default": "./src/ColorArea.js"
+        },
+        "./src/color-area-overrides.css.js": "./src/color-area-overrides.css.js",
+        "./src/color-area.css.js": "./src/color-area.css.js",
+        "./src/index.js": {
+            "development": "./src/index.dev.js",
+            "default": "./src/index.js"
+        },
+        "./src/types.js": {
+            "development": "./src/types.dev.js",
+            "default": "./src/types.js"
+        },
+        "./sp-color-area.js": {
+            "development": "./sp-color-area.dev.js",
+            "default": "./sp-color-area.js"
+        }
+    },
+    "scripts": {
+        "test": "echo \"Error: run tests from mono-repo root.\" && exit 1"
+    },
+    "files": [
+        "**/*.d.ts",
+        "**/*.js",
+        "**/*.js.map",
+        "custom-elements.json",
+        "!stories/",
+        "!test/"
+    ],
+    "keywords": [
+        "spectrum css",
+        "web components",
+        "lit-element",
+        "lit-html"
+    ],
+    "dependencies": {
+        "@ctrl/tinycolor": "^4.0.3",
+        "@spectrum-web-components/base": "0.0.0-20241209155954",
+        "@spectrum-web-components/color-handle": "0.0.0-20241209155954",
+        "@spectrum-web-components/opacity-checkerboard": "0.0.0-20241209155954",
+        "@spectrum-web-components/reactive-controllers": "0.0.0-20241209155954",
+        "@spectrum-web-components/shared": "0.0.0-20241209155954"
+    },
+    "devDependencies": {
+        "@spectrum-css/colorarea": "^6.0.0-s2-foundations.15"
+    },
+    "types": "./src/index.d.ts",
+    "customElements": "custom-elements.json",
+    "sideEffects": [
+        "./sp-*.js",
+        "./**/*.dev.js"
+    ]
+}

package/sp-color-area.d.ts

@@ -0,0 +1,6 @@
+import { ColorArea } from './src/ColorArea.js';
+declare global {
+    interface HTMLElementTagNameMap {
+        'sp-color-area': ColorArea;
+    }
+}

package/sp-color-area.dev.js

@@ -0,0 +1,5 @@
+"use strict";
+import { ColorArea } from "./src/ColorArea.dev.js";
+import { defineElement } from "@spectrum-web-components/base/src/define-element.js";
+defineElement("sp-color-area", ColorArea);
+//# sourceMappingURL=sp-color-area.dev.js.map

package/sp-color-area.dev.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["sp-color-area.ts"],
+  "sourcesContent": ["/*\nCopyright 2020 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\n\nimport { ColorArea } from './src/ColorArea.dev.js'\nimport { defineElement } from '@spectrum-web-components/base/src/define-element.js';\n\ndefineElement('sp-color-area', ColorArea);\n\ndeclare global {\n    interface HTMLElementTagNameMap {\n        'sp-color-area': ColorArea;\n    }\n}\n"],
+  "mappings": ";AAYA,SAAS,iBAAiB;AAC1B,SAAS,qBAAqB;AAE9B,cAAc,iBAAiB,SAAS;",
+  "names": []
+}

package/sp-color-area.js

@@ -0,0 +1,2 @@
+"use strict";import{ColorArea as e}from"./src/ColorArea.js";import{defineElement as r}from"@spectrum-web-components/base/src/define-element.js";r("sp-color-area",e);
+//# sourceMappingURL=sp-color-area.js.map

package/sp-color-area.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["sp-color-area.ts"],
+  "sourcesContent": ["/*\nCopyright 2020 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\n\nimport { ColorArea } from './src/ColorArea.js';\nimport { defineElement } from '@spectrum-web-components/base/src/define-element.js';\n\ndefineElement('sp-color-area', ColorArea);\n\ndeclare global {\n    interface HTMLElementTagNameMap {\n        'sp-color-area': ColorArea;\n    }\n}\n"],
+  "mappings": "aAYA,OAAS,aAAAA,MAAiB,qBAC1B,OAAS,iBAAAC,MAAqB,sDAE9BA,EAAc,gBAAiBD,CAAS",
+  "names": ["ColorArea", "defineElement"]
+}

package/src/ColorArea.d.ts

@@ -0,0 +1,65 @@
+import { CSSResultArray, PropertyValues, SpectrumElement, TemplateResult } from '@spectrum-web-components/base';
+import '@spectrum-web-components/color-handle/sp-color-handle.js';
+import { ColorValue } from '@spectrum-web-components/reactive-controllers/src/Color.js';
+/**
+ * @element sp-color-area
+ * @slot gradient - a custom gradient visually outlining the available color values
+ * @fires input - The value of the Color Area has changed.
+ * @fires change - An alteration to the value of the Color Area has been committed by the user.
+ */
+export declare class ColorArea extends SpectrumElement {
+    static get styles(): CSSResultArray;
+    dir: 'ltr' | 'rtl';
+    disabled: boolean;
+    focused: boolean;
+    labelX: string;
+    labelY: string;
+    private handle;
+    private languageResolver;
+    private colorController;
+    get hue(): number;
+    set hue(value: number);
+    get value(): ColorValue;
+    get color(): ColorValue;
+    set color(color: ColorValue);
+    private activeAxis;
+    get x(): number;
+    set x(x: number);
+    private _x;
+    get y(): number;
+    set y(y: number);
+    private _y;
+    step: number;
+    inputX: HTMLInputElement;
+    inputY: HTMLInputElement;
+    private altered;
+    private activeKeys;
+    private _valueChanged;
+    focus(focusOptions?: FocusOptions): void;
+    private forwardFocus;
+    private handleFocus;
+    handleBlur(): void;
+    private handleKeydown;
+    private handleKeypress;
+    private handleKeyup;
+    private handleInput;
+    private handleChange;
+    private boundingClientRect;
+    _pointerDown: boolean;
+    private handlePointerdown;
+    private handlePointermove;
+    private handlePointerup;
+    /**
+     * Returns the value under the cursor
+     * @param: PointerEvent on slider
+     * @return: Slider value that correlates to the position under the pointer
+     */
+    private calculateHandlePosition;
+    private handleAreaPointerdown;
+    protected render(): TemplateResult;
+    protected firstUpdated(changed: PropertyValues): void;
+    protected updated(changed: PropertyValues): void;
+    private observer?;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+}