🤖 Merge PR #68863 [@uswds/uswds]: Fix inaccurate typings for optional…

… elements, add new components by @aduth
DefinitelyTyped · Mar 1, 2024 · 792195d · 792195d
1 parent 1e70b91
commit 792195d
Show file tree

Hide file tree

Showing 26 changed files with 175 additions and 72 deletions.
diff --git a/types/uswds__uswds/js/_usa-password/index.d.ts b/types/uswds__uswds/js/_usa-password/index.d.ts
@@ -1,6 +1,6 @@
 interface Password {
-    on(el: HTMLElement): void;
-    off(el: HTMLElement): void;
+    on(el?: HTMLElement): void;
+    off(el?: HTMLElement): void;
 }
 
 declare const password: Password;

diff --git a/types/uswds__uswds/js/index.d.ts b/types/uswds__uswds/js/index.d.ts
@@ -1,6 +1,7 @@
 import password from "./_usa-password";
 import accordion from "./usa-accordion";
 import banner from "./usa-banner";
+import button from "./usa-button";
 import characterCount from "./usa-character-count";
 import comboBox from "./usa-combo-box";
 import datePicker from "./usa-date-picker";
@@ -13,6 +14,7 @@ import inputMask from "./usa-input-mask";
 import inputPrefixSuffix from "./usa-input-prefix-suffix";
 import languageSelector from "./usa-language-selector";
 import modal from "./usa-modal";
+import range from "./usa-range";
 import search from "./usa-search";
 import skipnav from "./usa-skipnav";
 import table from "./usa-table";
@@ -23,6 +25,7 @@ import validator from "./usa-validation";
 export {
     accordion,
     banner,
+    button,
     characterCount,
     comboBox,
     datePicker,
@@ -36,6 +39,7 @@ export {
     modal,
     navigation,
     password,
+    range,
     search,
     skipnav,
     table,

diff --git a/types/uswds__uswds/js/usa-accordion/index.d.ts b/types/uswds__uswds/js/usa-accordion/index.d.ts
@@ -1,9 +1,9 @@
 interface Accordion {
     ACCORDION: string;
     BUTTON: string;
-    init(root: HTMLElement | Document): void;
-    on(el: HTMLElement): void;
-    off(el: HTMLElement): void;
+    init(root?: HTMLElement | Document): void;
+    on(el?: HTMLElement): void;
+    off(el?: HTMLElement): void;
     show(button: HTMLButtonElement): boolean;
     hide(button: HTMLButtonElement): boolean;
     /**

diff --git a/types/uswds__uswds/js/usa-banner/index.d.ts b/types/uswds__uswds/js/usa-banner/index.d.ts
@@ -1,6 +1,6 @@
 interface Banner {
-    on(el: HTMLElement): void;
-    off(el: HTMLElement): void;
+    on(el?: HTMLElement): void;
+    off(el?: HTMLElement): void;
 }
 
 declare const banner: Banner;

diff --git a/types/uswds__uswds/js/usa-button/index.d.ts b/types/uswds__uswds/js/usa-button/index.d.ts
@@ -0,0 +1,8 @@
+interface Button {
+    on(el?: HTMLElement): void;
+    off(el?: HTMLElement): void;
+}
+
+declare const button: Button;
+
+export default button;
diff --git a/types/uswds__uswds/js/usa-character-count/index.d.ts b/types/uswds__uswds/js/usa-character-count/index.d.ts
@@ -1,12 +1,12 @@
 interface CharacterCount {
-    init(root: HTMLElement | Document): void;
+    init(root?: HTMLElement | Document): void;
     MESSAGE_INVALID_CLASS: string;
     VALIDATION_MESSAGE: string;
     STATUS_MESSAGE_CLASS: string;
     STATUS_MESSAGE_SR_ONLY_CLASS: string;
     DEFAULT_STATUS_LABEL: string;
-    on(el: HTMLElement): void;
-    off(el: HTMLElement): void;
+    on(el?: HTMLElement): void;
+    off(el?: HTMLElement): void;
     /**
      * Create and append status messages for visual and screen readers
      */

diff --git a/types/uswds__uswds/js/usa-combo-box/index.d.ts b/types/uswds__uswds/js/usa-combo-box/index.d.ts
@@ -13,10 +13,10 @@ interface ComboBoxContext {
 }
 
 interface ComboBox {
-    init(root: HTMLElement | Document): void;
+    init(root?: HTMLElement | Document): void;
     COMBO_BOX_CLASS: string;
-    on(el: HTMLElement): void;
-    off(el: HTMLElement): void;
+    on(el?: HTMLElement): void;
+    off(el?: HTMLElement): void;
     /**
      * Get an object of elements belonging directly to the given
      * combo box component.

diff --git a/types/uswds__uswds/js/usa-date-picker/index.d.ts b/types/uswds__uswds/js/usa-date-picker/index.d.ts
@@ -14,9 +14,9 @@ interface DatePickerContext {
 }
 
 interface DatePicker {
-    init(root: HTMLElement | Document): void;
-    on(el: HTMLElement): void;
-    off(el: HTMLElement): void;
+    init(root?: HTMLElement | Document): void;
+    on(el?: HTMLElement): void;
+    off(el?: HTMLElement): void;
     /**
      * Get an object of the properties and elements belonging directly to the given
      * date picker component.

diff --git a/types/uswds__uswds/js/usa-date-range-picker/index.d.ts b/types/uswds__uswds/js/usa-date-range-picker/index.d.ts
@@ -1,7 +1,7 @@
 interface DateRangePicker {
-    init(root: HTMLElement | Document): void;
-    on(el: HTMLElement): void;
-    off(el: HTMLElement): void;
+    init(root?: HTMLElement | Document): void;
+    on(el?: HTMLElement): void;
+    off(el?: HTMLElement): void;
 }
 
 declare const dateRangePicker: DateRangePicker;

diff --git a/types/uswds__uswds/js/usa-file-input/index.d.ts b/types/uswds__uswds/js/usa-file-input/index.d.ts
@@ -4,10 +4,10 @@ interface FileInputContext {
 }
 
 interface FileInput {
-    init(root: HTMLElement | Document): void;
-    teardown(root: HTMLElement | Document): void;
-    on(el: HTMLElement): void;
-    off(el: HTMLElement): void;
+    init(root?: HTMLElement | Document): void;
+    teardown(root?: HTMLElement | Document): void;
+    on(el?: HTMLElement): void;
+    off(el?: HTMLElement): void;
     /**
      * Get an object of the properties and elements belonging directly to the given
      * file input component.

diff --git a/types/uswds__uswds/js/usa-footer/index.d.ts b/types/uswds__uswds/js/usa-footer/index.d.ts
@@ -2,8 +2,8 @@ interface Footer {
     HIDE_MAX_WIDTH: number;
     init(): void;
     teardown(): void;
-    on(el: HTMLElement): void;
-    off(el: HTMLElement): void;
+    on(el?: HTMLElement): void;
+    off(el?: HTMLElement): void;
 }
 
 declare const footer: Footer;

diff --git a/types/uswds__uswds/js/usa-header/index.d.ts b/types/uswds__uswds/js/usa-header/index.d.ts
@@ -1,9 +1,9 @@
 interface Navigation {
     focusTrap: null;
-    init(root: HTMLElement | Document): void;
+    init(root?: HTMLElement | Document): void;
     teardown(): void;
-    on(el: HTMLElement): void;
-    off(el: HTMLElement): void;
+    on(el?: HTMLElement): void;
+    off(el?: HTMLElement): void;
     toggleNav(active: boolean): boolean;
 }
 

diff --git a/types/uswds__uswds/js/usa-in-page-navigation/index.d.ts b/types/uswds__uswds/js/usa-in-page-navigation/index.d.ts
@@ -1,7 +1,7 @@
 interface InPageNavigation {
-    init(root: HTMLElement | Document): void;
-    on(root: HTMLElement | Document): void;
-    off(root: HTMLElement | Document): void;
+    init(root?: HTMLElement | Document): void;
+    on(root?: HTMLElement | Document): void;
+    off(root?: HTMLElement | Document): void;
 }
 
 declare const inPageNavigation: InPageNavigation;

diff --git a/types/uswds__uswds/js/usa-input-mask/index.d.ts b/types/uswds__uswds/js/usa-input-mask/index.d.ts
@@ -1,7 +1,7 @@
 interface InputMask {
-    init(root: HTMLElement | Document): void;
-    on(root: HTMLElement | Document): void;
-    off(root: HTMLElement | Document): void;
+    init(root?: HTMLElement | Document): void;
+    on(root?: HTMLElement | Document): void;
+    off(root?: HTMLElement | Document): void;
 }
 
 declare const inputMask: InputMask;

diff --git a/types/uswds__uswds/js/usa-input-prefix-suffix/index.d.ts b/types/uswds__uswds/js/usa-input-prefix-suffix/index.d.ts
@@ -1,7 +1,7 @@
 interface InputPrefixSuffix {
-    init(root: HTMLElement | Document): void;
-    on(el: HTMLElement): void;
-    off(el: HTMLElement): void;
+    init(root?: HTMLElement | Document): void;
+    on(el?: HTMLElement): void;
+    off(el?: HTMLElement): void;
 }
 
 declare const inputPrefixSuffix: InputPrefixSuffix;

diff --git a/types/uswds__uswds/js/usa-language-selector/index.d.ts b/types/uswds__uswds/js/usa-language-selector/index.d.ts
@@ -1,9 +1,9 @@
 interface LanguageSelector {
     focusTrap: null;
-    init(root: HTMLElement | Document): void;
+    init(root?: HTMLElement | Document): void;
     teardown(): void;
-    on(root: HTMLElement | Document): void;
-    off(root: HTMLElement | Document): void;
+    on(root?: HTMLElement | Document): void;
+    off(root?: HTMLElement | Document): void;
 }
 
 declare const languageSelector: LanguageSelector;

diff --git a/types/uswds__uswds/js/usa-modal/index.d.ts b/types/uswds__uswds/js/usa-modal/index.d.ts
@@ -1,9 +1,9 @@
 interface Modal {
     focusTrap: null;
-    init(root: HTMLElement | Document): void;
-    teardown(root: HTMLElement | Document): void;
-    on(root: HTMLElement | Document): void;
-    off(root: HTMLElement | Document): void;
+    init(root?: HTMLElement | Document): void;
+    teardown(root?: HTMLElement | Document): void;
+    on(root?: HTMLElement | Document): void;
+    off(root?: HTMLElement | Document): void;
     /**
      *  Toggle the visibility of a modal window
      */

diff --git a/types/uswds__uswds/js/usa-range/index.d.ts b/types/uswds__uswds/js/usa-range/index.d.ts
@@ -0,0 +1,10 @@
+interface Range {
+    on(el?: HTMLElement): void;
+    off(el?: HTMLElement): void;
+    init(root?: HTMLElement): void;
+    updateCallout(targetRange: HTMLInputElement): void;
+}
+
+declare const range: Range;
+
+export default range;
diff --git a/types/uswds__uswds/js/usa-search/index.d.ts b/types/uswds__uswds/js/usa-search/index.d.ts
@@ -1,8 +1,8 @@
 interface Search {
-    init(target: HTMLElement | Document): void;
+    init(target?: HTMLElement | Document): void;
     teardown(): void;
-    on(el: HTMLElement): void;
-    off(el: HTMLElement): void;
+    on(el?: HTMLElement): void;
+    off(el?: HTMLElement): void;
 }
 
 declare const search: Search;

diff --git a/types/uswds__uswds/js/usa-skipnav/index.d.ts b/types/uswds__uswds/js/usa-skipnav/index.d.ts
@@ -1,6 +1,6 @@
 interface Skipnav {
-    on(el: HTMLElement): void;
-    off(el: HTMLElement): void;
+    on(el?: HTMLElement): void;
+    off(el?: HTMLElement): void;
 }
 
 declare const skipnav: Skipnav;

diff --git a/types/uswds__uswds/js/usa-table/index.d.ts b/types/uswds__uswds/js/usa-table/index.d.ts
@@ -2,9 +2,9 @@ interface Table {
     TABLE: string;
     SORTABLE_HEADER: string;
     SORT_BUTTON: string;
-    init(root: HTMLElement | Document): void;
-    on(el: HTMLElement): void;
-    off(el: HTMLElement): void;
+    init(root?: HTMLElement | Document): void;
+    on(el?: HTMLElement): void;
+    off(el?: HTMLElement): void;
 }
 
 declare const table: Table;

diff --git a/types/uswds__uswds/js/usa-time-picker/index.d.ts b/types/uswds__uswds/js/usa-time-picker/index.d.ts
@@ -5,9 +5,9 @@ interface TimePicker {
         hourQueryFilter: string;
         minuteQueryFilter: string;
     };
-    init(root: HTMLElement | Document): void;
-    on(el: HTMLElement): void;
-    off(el: HTMLElement): void;
+    init(root?: HTMLElement | Document): void;
+    on(el?: HTMLElement): void;
+    off(el?: HTMLElement): void;
 }
 
 declare const timePicker: TimePicker;

diff --git a/types/uswds__uswds/js/usa-tooltip/index.d.ts b/types/uswds__uswds/js/usa-tooltip/index.d.ts
@@ -1,3 +1,5 @@
+type TooltipPosition = "top" | "right" | "bottom" | "left";
+
 interface TooltipContext {
     tooltipBody: HTMLSpanElement;
     position: string;
@@ -6,9 +8,9 @@ interface TooltipContext {
 }
 
 interface Tooltip {
-    init(root: HTMLElement | Document): void;
-    on(el: HTMLElement): void;
-    off(el: HTMLElement): void;
+    init(root?: HTMLElement | Document): void;
+    on(el?: HTMLElement): void;
+    off(el?: HTMLElement): void;
     /**
      * Setup the tooltip component
      */
@@ -19,14 +21,14 @@ interface Tooltip {
         wrapper: HTMLSpanElement;
     };
     getTooltipElements(trigger: Element): {
-        trigger: Element;
+        trigger: HTMLElement;
         wrapper: HTMLElement;
         body: HTMLElement;
     };
     /**
      * Shows the tooltip
      */
-    show(tooltipTrigger: HTMLElement): void;
+    show(tooltipBody: HTMLElement, tooltipTrigger: HTMLElement, position: TooltipPosition): void;
     /**
      * Removes all the properties to show and position the tooltip,
      * and resets the tooltip position to the original intention

diff --git a/types/uswds__uswds/js/usa-validation/index.d.ts b/types/uswds__uswds/js/usa-validation/index.d.ts
@@ -1,7 +1,7 @@
 interface Validator {
-    init(root: HTMLElement | Document): void;
-    on(el: HTMLElement): void;
-    off(el: HTMLElement): void;
+    init(root?: HTMLElement | Document): void;
+    on(el?: HTMLElement): void;
+    off(el?: HTMLElement): void;
 }
 
 declare const validator: Validator;

diff --git a/types/uswds__uswds/package.json b/types/uswds__uswds/package.json
@@ -1,7 +1,7 @@
 {
     "private": true,
     "name": "@types/uswds__uswds",
-    "version": "3.3.9999",
+    "version": "3.7.9999",
     "projects": [
         "https://github.com/uswds/uswds"
     ],
@@ -12,6 +12,10 @@
         {
             "name": "Morgan Spencer",
             "githubUsername": "morganmspencer"
+        },
+        {
+            "name": "Andrew Duthie",
+            "githubUsername": "aduth"
         }
     ]
 }