@nvidia-elements/core 2.19.1 → 2.20.0

package/dist/joystick/index.d.ts

@@ -0,0 +1 @@
+export * from './joystick.js';

package/dist/joystick/index.js

@@ -0,0 +1,2 @@
+import { Joystick as e } from "./joystick2.js";
+export { e as Joystick };

package/dist/joystick/joystick.d.ts

@@ -0,0 +1,126 @@
+import { LitElement, type PropertyValues } from 'lit';
+import { type Size } from '@nvidia-elements/core/internal';
+export interface JoystickValue {
+    readonly x: number;
+    readonly y: number;
+}
+export type JoystickConstraint = 'circle' | 'square' | 'horizontal' | 'vertical';
+export type JoystickRelease = 'center' | 'hold';
+export interface JoystickInteractionStart {
+    readonly source: 'pointer' | 'keyboard';
+}
+export interface JoystickInteractionEnd extends JoystickInteractionStart {
+    readonly reason: 'release' | 'escape' | 'pointer-cancel' | 'lost-capture' | 'blur' | 'hidden' | 'disabled' | 'readonly' | 'configuration-change' | 'reset' | 'disconnect';
+}
+declare const Joystick_base: import("@nvidia-elements/forms/mixins").FormControlMixinReturn<typeof LitElement, JoystickValue>;
+/**
+ * @element nve-joystick
+ * @description A joystick selects a normalized two-axis vector with pointer or keyboard input.
+ * Applications own physical units, coordinate frames, input shaping, publishing cadence, recording clocks,
+ * command-outcome feedback, and alternative controls when needed.
+ *
+ * Give each joystick an accessible name with a label, aria-label, or aria-labelledby.
+ * Editable controls use the application role to receive two-axis keyboard input.
+ * The default accessible description includes both normalized coordinates, keyboard instructions, and release behavior.
+ * A locked axis stays at zero; an absent value reads "No position." Disabled and read-only controls omit instructions.
+ * Coordinates use up to six decimal places and the document language for number formatting.
+ * An explicit aria-description or aria-describedby replaces the default focus description through standard ARIA precedence;
+ * it does not disable live announcements.
+ * @documentation https://nvidia.github.io/elements/docs/elements/joystick/
+ * @since 0.0.0
+ * @entrypoint \@nvidia-elements/core/joystick
+ * @property {JoystickValue | undefined} value - The normalized vector: positive x points right and positive y points down, independent of text direction. Assign a complete finite object within the selected constraint. Invalid vectors throw TypeError without replacing the previous value. Programmatic writes do not dispatch input or change events. Use undefined for an absent sample and a zero vector for recorded neutral input. Set readOnly before assigning replay ownership. User input can replace external writes during an interaction.
+ * @attribute {string} value - A JSON object containing normalized x and y coordinates.
+ * @event input - Dispatched after user input changes the vector, including a return to neutral. Read .value for the current vector. A held position does not generate repeated events. Publish commands at an application-controlled cadence.
+ * @event change - Dispatched after a normal interaction completes and produces input. Cancellation sends any necessary neutral input without change.
+ * @event interaction-start - Dispatched with the pointer or keyboard source after setting :state(active), including engagement at neutral.
+ * @event interaction-end - Dispatched with the source and terminal reason after clearing :state(active). Interruption first sends any necessary neutral input. Reset restores the declared default without value events. Detached events cannot bubble to former ancestors.
+ * @cssprop --width
+ * @cssprop --height
+ * @cssprop --background
+ * @cssprop --opacity - Background opacity when the opacity flag is present. Defaults to 0.6. The border, crosshair, thumb, and focus indicator keep their opacity.
+ * @cssprop --border
+ * @cssprop --thumb-width
+ * @cssprop --thumb-height
+ * @cssprop --thumb-background
+ * @cssprop --thumb-border
+ * @stable false
+ */
+export declare class Joystick extends Joystick_base {
+    #private;
+    static styles: import("lit").CSSResult[];
+    static readonly metadata: {
+        tag: string;
+        version: string;
+        valueSchema: {
+            type: 'object';
+            properties: {
+                x: {
+                    type: 'number';
+                    minimum: number;
+                    maximum: number;
+                };
+                y: {
+                    type: 'number';
+                    minimum: number;
+                    maximum: number;
+                };
+            };
+            required: string[];
+            additionalProperties: boolean;
+        };
+    };
+    /**
+     * Constrains the movement region or selects one axis. Circle limits vector magnitude to one;
+     * square permits both axes at full scale and a magnitude of up to Math.SQRT2.
+     * With equally scaled planar velocity axes, square corners allow about 41% greater speed.
+     * Mixed forward-velocity and turning-rate axes have no common physical magnitude.
+     * Changing the constraint projects the current value silently and cancels an active interaction.
+     */
+    constraint: JoystickConstraint;
+    /** Sets surface and thumb size. At the default font size, sm is 104px, md is 130px, and lg is 156px. */
+    size: Size;
+    /** Enables background transparency using the --opacity CSS custom property. */
+    opacity: boolean;
+    /**
+     * Determines whether normal release returns to center or holds the final vector.
+     * Interrupted interactions return to neutral in either mode. Form reset restores the declared default instead.
+     */
+    release: JoystickRelease;
+    /**
+     * Sets the normalized increment for each arrow key press. Repeated presses continue adjusting;
+     * releasing the final arrow applies the release behavior. Escape cancels the interaction.
+     * Invalid steps fall back to 0.1. Modifier shortcuts and locked-axis directions remain available to the browser.
+     */
+    keyboardStep: number;
+    /**
+     * Controls automatic position announcements. Focused user input produces polite announcements at most every 500 ms.
+     * A quick tap in center mode reports the input coordinates and the return to center.
+     * Escape announces the resulting coordinates without a separate cancellation message.
+     * Programmatic writes and read-only playback update the description without live announcements.
+     * Set off when the application supplies spoken output, the position description on focus remains available.
+     */
+    announce: 'polite' | 'off';
+    /** Enables updating internal string values for internationalization. */
+    i18n: Partial<import("@nvidia-elements/core/internal").I18nStrings & {
+        __set: boolean;
+    }>;
+    static get observedAttributes(): string[];
+    attributeChangedCallback(name: string, oldValue: string | null, newValue: string | null): void;
+    get disabled(): boolean;
+    set disabled(value: boolean | unknown);
+    get readOnly(): boolean;
+    set readOnly(value: boolean | unknown);
+    constructor();
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    firstUpdated(): void;
+    willUpdate(changes: PropertyValues<this>): void;
+    updated(): void;
+    render(): import("lit-html").TemplateResult<1>;
+    updateValue(value: JoystickValue): void;
+    reset(): void;
+    formStateRestoreCallback(state: unknown, _reason?: string): void;
+    _updateFormState(): void;
+}
+export {};

package/dist/joystick/joystick.examples.js

@@ -0,0 +1,6 @@
+//#region src/joystick/joystick.examples.ts
+var e = "";
+//#endregion
+export { e as default };
+
+//# sourceMappingURL=joystick.examples.js.map

package/dist/joystick/joystick.examples.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"joystick.examples.js","names":[],"sources":["../../src/joystick/joystick.examples.ts"],"sourcesContent":["// SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n// SPDX-License-Identifier: Apache-2.0\n\nimport { html } from 'lit';\nimport '@nvidia-elements/core/joystick/define.js';\nimport '@nvidia-elements/core/button/define.js';\nimport '@nvidia-elements/core/range/define.js';\n\nexport default { title: 'Elements/Joystick', component: 'nve-joystick' };\n\n/**\n * @summary Select a direction and intensity with a circular movement region. Release the pointer or arrow keys to return to center.\n * @description Both axes use normalized values from -1 to 1. Applications can derive length with Math.hypot(x, y) and angle with Math.atan2(-y, x). This angle uses radians from the rightward direction with counterclockwise positive rotation. Use undefined at neutral. Keep these derived quantities outside the writable value. The angle does not describe the robot's heading.\n */\nexport const Default = {\n  render: () => html`<nve-joystick aria-label=\"Movement\"></nve-joystick>`\n};\n\n/**\n * @summary Choose small, medium, or large controls to fit the available space. Each size scales the movement surface and thumb together.\n */\nexport const Size = {\n  render: () => html`\n    <div nve-layout=\"row gap:lg align:wrap\">\n      <nve-joystick aria-label=\"Small movement\" size=\"sm\"></nve-joystick>\n      <nve-joystick aria-label=\"Medium movement\" size=\"md\"></nve-joystick>\n      <nve-joystick aria-label=\"Large movement\" size=\"lg\"></nve-joystick>\n    </div>\n  `\n};\n\n/**\n * @summary Overlay a joystick with a translucent background on a checkered scene. Keep the border and thumb at full opacity for contrast.\n * @tags theme\n */\nexport const Opacity = {\n  render: () => html`\n    <div\n      nve-layout=\"row align:center pad:lg\"\n      style=\"\n        width: 100%;\n        min-height: 16rem;\n        background: repeating-conic-gradient(\n            var(--nve-sys-layer-container-background) 0% 25%,\n            var(--nve-sys-layer-canvas-background) 0% 50%\n          )\n          center / 2rem 2rem;\n      \"\n    >\n      <nve-joystick aria-label=\"Movement\" opacity></nve-joystick>\n    </div>\n  `\n};\n\n/**\n * @summary Compare circular, square, and single-axis movement regions. Choose a constraint that matches the available commands.\n * @description Circle bounds normalized magnitude to one. Square allows independent full-scale axes and a magnitude of up to Math.SQRT2. Use circle for planar direction and intensity, or square for independent limits such as forward velocity and turning rate. Equally scaled planar velocity axes can produce about 41% greater diagonal speed with square input.\n */\nexport const Constraints = {\n  render: () => html`\n    <div nve-layout=\"row gap:lg align:wrap\">\n      <nve-joystick aria-label=\"Circular movement\"></nve-joystick>\n      <nve-joystick aria-label=\"Independent axes\" constraint=\"square\"></nve-joystick>\n      <nve-joystick aria-label=\"Turn\" constraint=\"horizontal\"></nve-joystick>\n      <nve-joystick aria-label=\"Vertical movement\" constraint=\"vertical\"></nve-joystick>\n    </div>\n  `\n};\n\n/**\n * @summary Keep the last position after release for persistent target selection. Press Escape during an interaction to return to center.\n */\nexport const Hold = {\n  render: () => html`<nve-joystick aria-label=\"Persistent target\" release=\"hold\"></nve-joystick>`\n};\n\n/**\n * @summary Display recorded input without generating control events. Use read-only state for inspection and disabled state for unavailable controls.\n * @description Set readOnly to true before assigning recorded vectors through .value. Use undefined for an absent sample and a zero vector for recorded neutral input. The recording layer captures source, sample time, engagement transitions, and mapping configuration. Preserve its clock during replay and avoid applying input shaping to recorded samples again.\n */\nexport const States = {\n  render: () => html`\n    <div nve-layout=\"row gap:lg align:wrap\">\n      <nve-joystick aria-label=\"Recorded input\" readonly value='{\"x\":0.4,\"y\":-0.6}'></nve-joystick>\n      <nve-joystick aria-label=\"Unavailable control\" disabled></nve-joystick>\n    </div>\n  `\n};\n\n/**\n * @summary Map travel and turn input to body-frame velocities in meters and radians per second. Engage either joystick to update its command axes.\n * @description Input maps to ROS body axes: x-forward, y-left, z-up, with positive yaw counterclockwise. Travel uses square constraints for independent axis limits; use circle to bound normalized translation magnitude. The illustrative maxima are 1 m/s forward, 0.5 m/s lateral, and 1 rad/s yaw. Each control's :state(active) CSS custom state gates its displayed velocity. Interaction events refresh the readouts. The application chooses its limits and publishes the latest command at its own cadence, including while input remains stationary.\n */\nexport const TravelTurn = {\n  render: () => html`\n    <div id=\"joystick-travel-turn\" nve-layout=\"column gap:lg\">\n      <div nve-layout=\"row gap:lg align:wrap\">\n        <div nve-layout=\"column gap:sm\">\n          <label for=\"joystick-travel\">Travel</label>\n          <nve-joystick id=\"joystick-travel\" constraint=\"square\"></nve-joystick>\n          <output data-travel style=\"width: 170px\">Released: x 0.00, y 0.00</output>\n        </div>\n        <div nve-layout=\"column gap:sm\">\n          <label for=\"joystick-turn\">Turn</label>\n          <nve-joystick id=\"joystick-turn\" constraint=\"horizontal\"></nve-joystick>\n          <output data-turn>Released: x 0.00, y 0.00</output>\n        </div>\n      </div>\n      <output data-command>vx 0.00 m/s, vy 0.00 m/s, wz 0.00 rad/s</output>\n    </div>\n    <script type=\"module\">\n      const group = document.querySelector('#joystick-travel-turn');\n      const travel = group.querySelector('#joystick-travel');\n      const turn = group.querySelector('#joystick-turn');\n      const maxForwardMps = 1;\n      const maxLateralMps = 0.5;\n      const maxYawRadps = 1;\n\n      function describe(control) {\n        const value = control.value;\n        const state = control.matches(':state(active)') ? 'Engaged' : 'Released';\n        return state + ': ' + (value ? 'x ' + value.x.toFixed(2) + ', y ' + value.y.toFixed(2) : 'No sample');\n      }\n\n      function update() {\n        group.querySelector('[data-travel]').textContent = describe(travel);\n        group.querySelector('[data-turn]').textContent = describe(turn);\n        const translation = travel.matches(':state(active)') ? travel.value : undefined;\n        const rotation = turn.matches(':state(active)') ? turn.value : undefined;\n        const command = {\n          vx: -(translation?.y ?? 0) * maxForwardMps,\n          vy: -(translation?.x ?? 0) * maxLateralMps,\n          wz: -(rotation?.x ?? 0) * maxYawRadps\n        };\n        group.querySelector('[data-command]').textContent =\n          'vx ' + command.vx.toFixed(2) + ' m/s, vy ' + command.vy.toFixed(2) + ' m/s, wz ' + command.wz.toFixed(2) + ' rad/s';\n      }\n\n      for (const type of ['input', 'interaction-start', 'interaction-end']) group.addEventListener(type, update);\n      await customElements.whenDefined('nve-joystick');\n      update();\n    </script>\n  `\n};\n\n/**\n * @summary Adjust a radial dead zone and response curve before mapping input to commands. Compare the shaped vector with the unchanged joystick value.\n * @description A dead zone of zero and response exponent of one leave circular input unchanged. The dead zone makes neutral easier to select; a larger exponent provides finer control near neutral. The remaining range scales back to full output at the boundary and preserves direction. Shaping produces a separate command vector without rewriting .value. Map it to physical units afterward. Apply filtering in one input layer to avoid processing hardware or recorded samples twice. [ROS joystick parameters](https://github.com/ros-drivers/joystick_drivers/blob/ros2/joy/README.md)\n */\nexport const InputShaping = {\n  render: () => html`\n    <div id=\"joystick-shaping\" nve-layout=\"column gap:md\">\n      <nve-joystick aria-label=\"Movement\" constraint=\"circle\"></nve-joystick>\n      <nve-range>\n        <label for=\"joystick-deadzone\">Dead zone</label>\n        <input id=\"joystick-deadzone\" type=\"range\" min=\"0\" max=\"0.5\" step=\"0.01\" value=\"0\" />\n      </nve-range>\n      <nve-range>\n        <label for=\"joystick-response\">Response exponent</label>\n        <input id=\"joystick-response\" type=\"range\" min=\"1\" max=\"3\" step=\"0.1\" value=\"1\" />\n      </nve-range>\n      <output data-settings>Dead zone 0.00, response 1.0</output>\n      <output data-raw>Raw: x 0.00, y 0.00</output>\n      <output data-shaped>Shaped: x 0.00, y 0.00</output>\n    </div>\n    <script type=\"module\">\n      const group = document.querySelector('#joystick-shaping');\n      const joystick = group.querySelector('nve-joystick');\n      const deadzone = group.querySelector('#joystick-deadzone');\n      const response = group.querySelector('#joystick-response');\n\n      function shape(value, deadzone, exponent) {\n        const magnitude = Math.hypot(value.x, value.y);\n        if (magnitude <= deadzone) return { x: 0, y: 0 };\n        const strength = ((magnitude - deadzone) / (1 - deadzone)) ** exponent;\n        return { x: value.x / magnitude * strength, y: value.y / magnitude * strength };\n      }\n\n      function update() {\n        const raw = joystick.value ?? { x: 0, y: 0 };\n        const shaped = shape(raw, deadzone.valueAsNumber, response.valueAsNumber);\n        group.querySelector('[data-settings]').textContent =\n          'Dead zone ' + deadzone.valueAsNumber.toFixed(2) + ', response ' + response.valueAsNumber.toFixed(1);\n        group.querySelector('[data-raw]').textContent = 'Raw: x ' + raw.x.toFixed(2) + ', y ' + raw.y.toFixed(2);\n        group.querySelector('[data-shaped]').textContent = 'Shaped: x ' + shaped.x.toFixed(2) + ', y ' + shaped.y.toFixed(2);\n      }\n\n      group.addEventListener('input', update);\n      await customElements.whenDefined('nve-joystick');\n      update();\n    </script>\n  `\n};\n\n/**\n * @summary Submit both axes as separate named fields and restore the declared position with form reset. Use held values when selecting persistent form targets.\n */\nexport const Form = {\n  render: () => html`\n    <form nve-layout=\"column gap:md\">\n      <label for=\"joystick-form\">Target</label>\n      <nve-joystick id=\"joystick-form\" name=\"target\" release=\"hold\" value='{\"x\":0.2,\"y\":-0.3}'></nve-joystick>\n      <nve-button type=\"reset\">Reset target</nve-button>\n    </form>\n  `\n};\n\n/**\n * @summary Override joystickPosition through i18n to localize spoken coordinates while keeping built-in position announcements.\n */\nexport const AccessibleFeedback = {\n  render: () => html`\n    <nve-joystick aria-label=\"Movement\" i18n='{\"joystickPosition\":\"Horizontal {x}, vertical {y}.\"}'></nve-joystick>\n  `\n};\n\n/**\n * @summary Supply application announcements with a labeled output. Disable built-in announcements to avoid duplicate feedback.\n */\nexport const ExternalFeedback = {\n  render: () => html`\n    <div id=\"joystick-external-feedback\" nve-layout=\"column gap:md\">\n      <nve-joystick aria-label=\"Target\" announce=\"off\" release=\"hold\"></nve-joystick>\n      <output aria-live=\"polite\" aria-atomic=\"true\">Target: X 0, Y 0</output>\n    </div>\n    <script type=\"module\">\n      const root = document.querySelector('#joystick-external-feedback');\n      const joystick = root.querySelector('nve-joystick');\n      const output = root.querySelector('output');\n      joystick.addEventListener('change', () => {\n        const value = joystick.value;\n        output.textContent = value ? 'Target: X ' + value.x + ', Y ' + value.y : 'No target';\n      });\n    </script>\n  `\n};\n"],"mappings":";AAGA,IAAA,IAAS"}

package/dist/joystick/joystick.examples.json

@@ -0,0 +1,107 @@
+{
+  "element": "nve-joystick",
+  "entrypoint": "@nvidia-elements/core/joystick/joystick.examples.json",
+  "items": [
+    {
+      "id": "joystick",
+      "name": "Default",
+      "template": "<nve-joystick aria-label=\"Movement\"></nve-joystick>\n",
+      "summary": "Select a direction and intensity with a circular movement region. Release the pointer or arrow keys to return to center.",
+      "description": "Both axes use normalized values from -1 to 1. Applications can derive length with Math.hypot(x, y) and angle with Math.atan2(-y, x). This angle uses radians from the rightward direction with counterclockwise positive rotation. Use undefined at neutral. Keep these derived quantities outside the writable value. The angle does not describe the robot's heading.",
+      "composition": false,
+      "tags": []
+    },
+    {
+      "id": "joystick-size",
+      "name": "Size",
+      "template": "<div nve-layout=\"row gap:lg align:wrap\">\n  <nve-joystick aria-label=\"Small movement\" size=\"sm\"></nve-joystick>\n  <nve-joystick aria-label=\"Medium movement\" size=\"md\"></nve-joystick>\n  <nve-joystick aria-label=\"Large movement\" size=\"lg\"></nve-joystick>\n</div>\n",
+      "summary": "Choose small, medium, or large controls to fit the available space. Each size scales the movement surface and thumb together.",
+      "description": "",
+      "composition": false,
+      "tags": []
+    },
+    {
+      "id": "joystick-opacity",
+      "name": "Opacity",
+      "template": "<div\n  nve-layout=\"row align:center pad:lg\"\n  style=\"width: 100%; min-height: 16rem; background: repeating-conic-gradient(var(--nve-sys-layer-container-background) 0% 25%, var(--nve-sys-layer-canvas-background) 0% 50%) center / 2rem 2rem\"\n>\n  <nve-joystick aria-label=\"Movement\" opacity></nve-joystick>\n</div>\n",
+      "summary": "Overlay a joystick with a translucent background on a checkered scene. Keep the border and thumb at full opacity for contrast.",
+      "description": "",
+      "composition": false,
+      "tags": [
+        "theme"
+      ]
+    },
+    {
+      "id": "joystick-constraints",
+      "name": "Constraints",
+      "template": "<div nve-layout=\"row gap:lg align:wrap\">\n  <nve-joystick aria-label=\"Circular movement\"></nve-joystick>\n  <nve-joystick aria-label=\"Independent axes\" constraint=\"square\"></nve-joystick>\n  <nve-joystick aria-label=\"Turn\" constraint=\"horizontal\"></nve-joystick>\n  <nve-joystick aria-label=\"Vertical movement\" constraint=\"vertical\"></nve-joystick>\n</div>\n",
+      "summary": "Compare circular, square, and single-axis movement regions. Choose a constraint that matches the available commands.",
+      "description": "Circle bounds normalized magnitude to one. Square allows independent full-scale axes and a magnitude of up to Math.SQRT2. Use circle for planar direction and intensity, or square for independent limits such as forward velocity and turning rate. Equally scaled planar velocity axes can produce about 41% greater diagonal speed with square input.",
+      "composition": false,
+      "tags": []
+    },
+    {
+      "id": "joystick-hold",
+      "name": "Hold",
+      "template": "<nve-joystick aria-label=\"Persistent target\" release=\"hold\"></nve-joystick>\n",
+      "summary": "Keep the last position after release for persistent target selection. Press Escape during an interaction to return to center.",
+      "description": "",
+      "composition": false,
+      "tags": []
+    },
+    {
+      "id": "joystick-states",
+      "name": "States",
+      "template": "<div nve-layout=\"row gap:lg align:wrap\">\n  <nve-joystick aria-label=\"Recorded input\" readonly value='{\"x\":0.4,\"y\":-0.6}'></nve-joystick>\n  <nve-joystick aria-label=\"Unavailable control\" disabled></nve-joystick>\n</div>\n",
+      "summary": "Display recorded input without generating control events. Use read-only state for inspection and disabled state for unavailable controls.",
+      "description": "Set readOnly to true before assigning recorded vectors through .value. Use undefined for an absent sample and a zero vector for recorded neutral input. The recording layer captures source, sample time, engagement transitions, and mapping configuration. Preserve its clock during replay and avoid applying input shaping to recorded samples again.",
+      "composition": false,
+      "tags": []
+    },
+    {
+      "id": "joystick-travel-turn",
+      "name": "TravelTurn",
+      "template": "<div id=\"joystick-travel-turn\" nve-layout=\"column gap:lg\">\n  <div nve-layout=\"row gap:lg align:wrap\">\n    <div nve-layout=\"column gap:sm\">\n      <label for=\"joystick-travel\">Travel</label>\n      <nve-joystick id=\"joystick-travel\" constraint=\"square\"></nve-joystick>\n      <output data-travel style=\"width: 170px\">Released: x 0.00, y 0.00</output>\n    </div>\n    <div nve-layout=\"column gap:sm\">\n      <label for=\"joystick-turn\">Turn</label>\n      <nve-joystick id=\"joystick-turn\" constraint=\"horizontal\"></nve-joystick>\n      <output data-turn>Released: x 0.00, y 0.00</output>\n    </div>\n  </div>\n  <output data-command>vx 0.00 m/s, vy 0.00 m/s, wz 0.00 rad/s</output>\n</div>\n<script type=\"module\">\n  const group = document.querySelector(\"#joystick-travel-turn\");\n  const travel = group.querySelector(\"#joystick-travel\");\n  const turn = group.querySelector(\"#joystick-turn\");\n  const maxForwardMps = 1;\n  const maxLateralMps = 0.5;\n  const maxYawRadps = 1;\n\n  function describe(control) {\n    const value = control.value;\n    const state = control.matches(\":state(active)\") ? \"Engaged\" : \"Released\";\n    return state + \": \" + (value ? \"x \" + value.x.toFixed(2) + \", y \" + value.y.toFixed(2) : \"No sample\");\n  }\n\n  function update() {\n    group.querySelector(\"[data-travel]\").textContent = describe(travel);\n    group.querySelector(\"[data-turn]\").textContent = describe(turn);\n    const translation = travel.matches(\":state(active)\") ? travel.value : undefined;\n    const rotation = turn.matches(\":state(active)\") ? turn.value : undefined;\n    const command = {\n      vx: -(translation?.y ?? 0) * maxForwardMps,\n      vy: -(translation?.x ?? 0) * maxLateralMps,\n      wz: -(rotation?.x ?? 0) * maxYawRadps,\n    };\n    group.querySelector(\"[data-command]\").textContent = \"vx \" + command.vx.toFixed(2) + \" m/s, vy \" + command.vy.toFixed(2) + \" m/s, wz \" + command.wz.toFixed(2) + \" rad/s\";\n  }\n\n  for (const type of [\"input\", \"interaction-start\", \"interaction-end\"]) group.addEventListener(type, update);\n  await customElements.whenDefined(\"nve-joystick\");\n  update();\n</script>\n",
+      "summary": "Map travel and turn input to body-frame velocities in meters and radians per second. Engage either joystick to update its command axes.",
+      "description": "Input maps to ROS body axes: x-forward, y-left, z-up, with positive yaw counterclockwise. Travel uses square constraints for independent axis limits; use circle to bound normalized translation magnitude. The illustrative maxima are 1 m/s forward, 0.5 m/s lateral, and 1 rad/s yaw. Each control's :state(active) CSS custom state gates its displayed velocity. Interaction events refresh the readouts. The application chooses its limits and publishes the latest command at its own cadence, including while input remains stationary.",
+      "composition": false,
+      "tags": []
+    },
+    {
+      "id": "joystick-input-shaping",
+      "name": "InputShaping",
+      "template": "<div id=\"joystick-shaping\" nve-layout=\"column gap:md\">\n  <nve-joystick aria-label=\"Movement\" constraint=\"circle\"></nve-joystick>\n  <nve-range>\n    <label for=\"joystick-deadzone\">Dead zone</label>\n    <input id=\"joystick-deadzone\" type=\"range\" min=\"0\" max=\"0.5\" step=\"0.01\" value=\"0\" />\n  </nve-range>\n  <nve-range>\n    <label for=\"joystick-response\">Response exponent</label>\n    <input id=\"joystick-response\" type=\"range\" min=\"1\" max=\"3\" step=\"0.1\" value=\"1\" />\n  </nve-range>\n  <output data-settings>Dead zone 0.00, response 1.0</output>\n  <output data-raw>Raw: x 0.00, y 0.00</output>\n  <output data-shaped>Shaped: x 0.00, y 0.00</output>\n</div>\n<script type=\"module\">\n  const group = document.querySelector(\"#joystick-shaping\");\n  const joystick = group.querySelector(\"nve-joystick\");\n  const deadzone = group.querySelector(\"#joystick-deadzone\");\n  const response = group.querySelector(\"#joystick-response\");\n\n  function shape(value, deadzone, exponent) {\n    const magnitude = Math.hypot(value.x, value.y);\n    if (magnitude <= deadzone) return { x: 0, y: 0 };\n    const strength = ((magnitude - deadzone) / (1 - deadzone)) ** exponent;\n    return { x: (value.x / magnitude) * strength, y: (value.y / magnitude) * strength };\n  }\n\n  function update() {\n    const raw = joystick.value ?? { x: 0, y: 0 };\n    const shaped = shape(raw, deadzone.valueAsNumber, response.valueAsNumber);\n    group.querySelector(\"[data-settings]\").textContent = \"Dead zone \" + deadzone.valueAsNumber.toFixed(2) + \", response \" + response.valueAsNumber.toFixed(1);\n    group.querySelector(\"[data-raw]\").textContent = \"Raw: x \" + raw.x.toFixed(2) + \", y \" + raw.y.toFixed(2);\n    group.querySelector(\"[data-shaped]\").textContent = \"Shaped: x \" + shaped.x.toFixed(2) + \", y \" + shaped.y.toFixed(2);\n  }\n\n  group.addEventListener(\"input\", update);\n  await customElements.whenDefined(\"nve-joystick\");\n  update();\n</script>\n",
+      "summary": "Adjust a radial dead zone and response curve before mapping input to commands. Compare the shaped vector with the unchanged joystick value.",
+      "description": "A dead zone of zero and response exponent of one leave circular input unchanged. The dead zone makes neutral easier to select; a larger exponent provides finer control near neutral. The remaining range scales back to full output at the boundary and preserves direction. Shaping produces a separate command vector without rewriting .value. Map it to physical units afterward. Apply filtering in one input layer to avoid processing hardware or recorded samples twice. [ROS joystick parameters](https://github.com/ros-drivers/joystick_drivers/blob/ros2/joy/README.md)",
+      "composition": false,
+      "tags": []
+    },
+    {
+      "id": "joystick-form",
+      "name": "Form",
+      "template": "<form nve-layout=\"column gap:md\">\n  <label for=\"joystick-form\">Target</label>\n  <nve-joystick id=\"joystick-form\" name=\"target\" release=\"hold\" value='{\"x\":0.2,\"y\":-0.3}'></nve-joystick>\n  <nve-button type=\"reset\">Reset target</nve-button>\n</form>\n",
+      "summary": "Submit both axes as separate named fields and restore the declared position with form reset. Use held values when selecting persistent form targets.",
+      "description": "",
+      "composition": false,
+      "tags": []
+    },
+    {
+      "id": "joystick-accessible-feedback",
+      "name": "AccessibleFeedback",
+      "template": "<nve-joystick aria-label=\"Movement\" i18n='{\"joystickPosition\":\"Horizontal {x}, vertical {y}.\"}'></nve-joystick>\n",
+      "summary": "Override joystickPosition through i18n to localize spoken coordinates while keeping built-in position announcements.",
+      "description": "",
+      "composition": false,
+      "tags": []
+    },
+    {
+      "id": "joystick-external-feedback",
+      "name": "ExternalFeedback",
+      "template": "<div id=\"joystick-external-feedback\" nve-layout=\"column gap:md\">\n  <nve-joystick aria-label=\"Target\" announce=\"off\" release=\"hold\"></nve-joystick>\n  <output aria-live=\"polite\" aria-atomic=\"true\">Target: X 0, Y 0</output>\n</div>\n<script type=\"module\">\n  const root = document.querySelector(\"#joystick-external-feedback\");\n  const joystick = root.querySelector(\"nve-joystick\");\n  const output = root.querySelector(\"output\");\n  joystick.addEventListener(\"change\", () => {\n    const value = joystick.value;\n    output.textContent = value ? \"Target: X \" + value.x + \", Y \" + value.y : \"No target\";\n  });\n</script>\n",
+      "summary": "Supply application announcements with a labeled output. Disable built-in announcements to avoid duplicate feedback.",
+      "description": "",
+      "composition": false,
+      "tags": []
+    }
+  ]
+}

package/dist/joystick/joystick.js

@@ -0,0 +1,6 @@
+//#region src/joystick/joystick.css?inline
+var e = ":host{--_size-scale: 1;--width: calc(8.125rem * var(--_size-scale));--height: calc(8.125rem * var(--_size-scale));--background: var(--nve-sys-interaction-background);--opacity: .6;--border: var(--nve-ref-border-width-sm) solid var(--nve-ref-border-color);--thumb-width: calc(var(--nve-ref-size-600) * var(--_size-scale));--thumb-height: calc(var(--nve-ref-size-600) * var(--_size-scale));--thumb-background: var(--nve-sys-text-muted-color);--thumb-border: var(--nve-ref-border-width-sm) solid var(--nve-sys-layer-canvas-background);--_axis-size: calc(3rem * var(--_size-scale));display:inline-block;width:var(--width);height:var(--height);user-select:none}[internal-host]{position:relative;box-sizing:border-box;width:100%;height:100%;border:var(--border);border-radius:50%;cursor:grab}.background{position:absolute;inset:0;z-index:0;border-radius:inherit;background:var(--background);pointer-events:none}:host([opacity]) .background{opacity:var(--opacity)}[internal-host]:before,[internal-host]:after{content:\"\";position:absolute;z-index:1}[internal-host]:before{left:50%;top:0;bottom:0;border-left:var(--nve-ref-border-width-sm) solid var(--nve-ref-border-color)}[internal-host]:after{top:50%;left:0;right:0;border-top:var(--nve-ref-border-width-sm) solid var(--nve-ref-border-color)}.travel{position:absolute;inset:calc(var(--thumb-height) / 2) calc(var(--thumb-width) / 2);z-index:2}.thumb{position:absolute;box-sizing:border-box;width:var(--thumb-width);height:var(--thumb-height);border:var(--thumb-border);border-radius:50%;background:var(--thumb-background);transform:translate(-50%,-50%)}:host([constraint=\"square\"]) [internal-host]{border-radius:var(--nve-ref-border-radius-md)}:host([size=\"sm\"]){--_size-scale: .8}:host([size=\"lg\"]){--_size-scale: 1.2}:host([constraint=\"horizontal\"]){--height: var(--_axis-size)}:host([constraint=\"vertical\"]){--width: var(--_axis-size)}:host([constraint=\"horizontal\"]) [internal-host],:host([constraint=\"vertical\"]) [internal-host]{border-radius:var(--nve-ref-border-radius-md)}:host(:focus-visible){outline:none}:host(:focus-visible) [internal-host]{outline:var(--nve-ref-border-width-md) solid var(--nve-sys-accent-secondary-background);outline-offset:var(--nve-ref-space-xs)}:host(:state(active)){--thumb-background: var(--nve-sys-accent-secondary-background)}:host(:state(active)) [internal-host]{cursor:grabbing}:host([disabled]){--background: var(--nve-sys-interaction-disabled-background);--thumb-background: var(--nve-sys-interaction-disabled-color)}:host([disabled]) [internal-host],:host([readonly]) [internal-host]{cursor:default}.announcement{position:absolute;width:1px;height:1px;padding:0;margin:0;overflow:hidden;clip-path:inset(50%);white-space:nowrap;border:0}";
+//#endregion
+export { e as default };
+
+//# sourceMappingURL=joystick.js.map

package/dist/joystick/joystick.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"joystick.js","names":[],"sources":["../../src/joystick/joystick.css?inline"],"sourcesContent":["/* SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. */\n/* SPDX-License-Identifier: Apache-2.0 */\n\n:host {\n  --_size-scale: 1;\n  --width: calc(8.125rem * var(--_size-scale));\n  --height: calc(8.125rem * var(--_size-scale));\n  --background: var(--nve-sys-interaction-background);\n  --opacity: 0.6;\n  --border: var(--nve-ref-border-width-sm) solid var(--nve-ref-border-color);\n  --thumb-width: calc(var(--nve-ref-size-600) * var(--_size-scale));\n  --thumb-height: calc(var(--nve-ref-size-600) * var(--_size-scale));\n  --thumb-background: var(--nve-sys-text-muted-color);\n  --thumb-border: var(--nve-ref-border-width-sm) solid var(--nve-sys-layer-canvas-background);\n  --_axis-size: calc(3rem * var(--_size-scale));\n  display: inline-block;\n  width: var(--width);\n  height: var(--height);\n  user-select: none;\n}\n\n[internal-host] {\n  position: relative;\n  box-sizing: border-box;\n  width: 100%;\n  height: 100%;\n  border: var(--border);\n  border-radius: 50%;\n  cursor: grab;\n}\n\n.background {\n  position: absolute;\n  inset: 0;\n  z-index: 0;\n  border-radius: inherit;\n  background: var(--background);\n  pointer-events: none;\n}\n\n:host([opacity]) .background {\n  opacity: var(--opacity);\n}\n\n[internal-host]::before,\n[internal-host]::after {\n  content: '';\n  position: absolute;\n  z-index: 1;\n}\n\n[internal-host]::before {\n  left: 50%;\n  top: 0;\n  bottom: 0;\n  border-left: var(--nve-ref-border-width-sm) solid var(--nve-ref-border-color);\n}\n\n[internal-host]::after {\n  top: 50%;\n  left: 0;\n  right: 0;\n  border-top: var(--nve-ref-border-width-sm) solid var(--nve-ref-border-color);\n}\n\n.travel {\n  position: absolute;\n  inset: calc(var(--thumb-height) / 2) calc(var(--thumb-width) / 2);\n  z-index: 2;\n}\n\n.thumb {\n  position: absolute;\n  box-sizing: border-box;\n  width: var(--thumb-width);\n  height: var(--thumb-height);\n  border: var(--thumb-border);\n  border-radius: 50%;\n  background: var(--thumb-background);\n  transform: translate(-50%, -50%);\n}\n\n:host([constraint='square']) [internal-host] {\n  border-radius: var(--nve-ref-border-radius-md);\n}\n\n:host([size='sm']) {\n  --_size-scale: 0.8;\n}\n\n:host([size='lg']) {\n  --_size-scale: 1.2;\n}\n\n:host([constraint='horizontal']) {\n  --height: var(--_axis-size);\n}\n\n:host([constraint='vertical']) {\n  --width: var(--_axis-size);\n}\n\n:host([constraint='horizontal']) [internal-host],\n:host([constraint='vertical']) [internal-host] {\n  border-radius: var(--nve-ref-border-radius-md);\n}\n\n:host(:focus-visible) {\n  outline: none;\n}\n\n:host(:focus-visible) [internal-host] {\n  outline: var(--nve-ref-border-width-md) solid var(--nve-sys-accent-secondary-background);\n  outline-offset: var(--nve-ref-space-xs);\n}\n\n:host(:state(active)) {\n  --thumb-background: var(--nve-sys-accent-secondary-background);\n}\n\n:host(:state(active)) [internal-host] {\n  cursor: grabbing;\n}\n\n:host([disabled]) {\n  --background: var(--nve-sys-interaction-disabled-background);\n  --thumb-background: var(--nve-sys-interaction-disabled-color);\n}\n\n:host([disabled]) [internal-host],\n:host([readonly]) [internal-host] {\n  cursor: default;\n}\n\n.announcement {\n  position: absolute;\n  width: 1px;\n  height: 1px;\n  padding: 0;\n  margin: 0;\n  overflow: hidden;\n  clip-path: inset(50%);\n  white-space: nowrap;\n  border: 0;\n}\n"],"mappings":""}