@react-md/core 6.1.0 → 6.2.0

package/src/tree/TreeItem.tsx

@@ -48,12 +48,12 @@ export interface TreeItemProps
    * element. The top-level props are passed to the `<span>` or `<a>` element
    * instead.
    */
-  liProps?: PropsWithRef<HTMLAttributes<HTMLLIElement>, HTMLLIElement>;
+  liProps?: PropsWithRef<HTMLAttributes<HTMLLIElement>>;
 
   /**
    * Any additional props to pass to the `TreeGroup` component.
    */
-  groupProps?: PropsWithRef<OverridableTreeGroupProps, HTMLUListElement>;
+  groupProps?: PropsWithRef<OverridableTreeGroupProps>;
 
   /**
    * This should normally be the text/content to display within the tree item

package/src/types.ts

@@ -1,12 +1,25 @@
-import type { Dispatch, ReactElement, Ref, SetStateAction } from "react";
+import {
+  type Dispatch,
+  type HTMLAttributes,
+  type ReactElement,
+  type Ref,
+  type SetStateAction,
+} from "react";
 
 /**
  * A helper type that allows an optional `ref` to also be applied with a props
  * object even though a `ref` isn't a real prop.
+ *
+ * @since 6.2.0 Automatically infer the `Element` type param from the provided
+ * props.
  */
 export type PropsWithRef<
   Props extends object,
-  Element extends HTMLElement,
+  Element extends HTMLElement = Props extends HTMLAttributes<infer E>
+    ? E extends HTMLElement
+      ? E
+      : never
+    : never,
 > = Props & {
   /**
    * An optional ref that can be applied.
@@ -104,6 +117,18 @@ export type HtmlTagName = keyof JSX.IntrinsicElements;
  */
 export type TextExtractor<T> = (item: T) => string;
 
+/**
+ * - `"some value"` -&gt; `"some value"`
+ * - `{ label: "Hello, world", value: 300 }` -&gt; `"Hello, world!"`
+ * - `{ name: "Hello, world", value: 300 }` -&gt; `"Hello, world!"`
+ *
+ * @since 6.2.0
+ */
+export type AutomaticTextExtraction =
+  | string
+  | { label: string }
+  | { name: string };
+
 /**
  * @since 6.0.0
  * @internal
@@ -201,3 +226,20 @@ export interface ElementSize {
   height: number;
   width: number;
 }
+
+/**
+ * @since 6.2.0
+ */
+export type OverridableStringUnion<
+  Defaults extends string,
+  Overrides extends Partial<Record<string, boolean>>,
+> =
+  | Exclude<Defaults, { [K in keyof Overrides]: K }[keyof Overrides]>
+  | {
+      [K in keyof Overrides]: Overrides[K] extends false ? never : K;
+    }[keyof Overrides];
+
+/**
+ * @since 6.2.0
+ */
+export type IsEmptyObject<T> = keyof T extends never ? true : false;

package/src/utils/alphaNumericSort.ts

@@ -1,5 +1,11 @@
 import { defaultExtractor } from "../searching/utils.js";
-import { type TextExtractor } from "../types.js";
+import { type AutomaticTextExtraction, type TextExtractor } from "../types.js";
+
+/**
+ * @since 6.2.0
+ * @internal
+ */
+const DEFAULT_EXTRACTOR = defaultExtractor("alphaNumericSort");
 
 /** @since 6.0.0 */
 export const DEFAULT_COLLATOR_OPTIONS = {
@@ -26,13 +32,13 @@ export interface AlphaNumericSortOptions<T> {
    * @example Simple Example
    * ```ts
    * interface Item {
-   *   name: string;
+   *   nameField: string;
    * }
    *
-   * const items: Item[] = [{ name: 'Hello' }, { name: 'World' }];
+   * const items: Item[] = [{ nameField: 'Hello' }, { nameField: 'World' }];
    *
    * alphaNumericSort(items, {
-   *   extractor: (item) => item.name,
+   *   extractor: (item) => item.nameField,
    * });
    * ```
    *
@@ -87,23 +93,23 @@ export interface AlphaNumericSortOptions<T> {
  * @param list - The list of strings to sort
  * @returns a new sorted list
  */
-export function alphaNumericSort<T extends string>(
+export function alphaNumericSort<T extends AutomaticTextExtraction>(
   list: readonly T[],
-  options?: Omit<AlphaNumericSortOptions<T>, "extractor">
+  options?: AlphaNumericSortOptions<T>
 ): readonly T[];
 /**
  * @example Simple Example
  * ```ts
  * interface Item {
- *   name: string;
+ *   nameField: string;
  * }
  *
- * const items: Item[] = [{ name: "World" }, { name: "Hello" }];
+ * const items: Item[] = [{ nameField: "World" }, { nameField: "Hello" }];
  *
  * const sorted = alphaNumericSort(items, {
- *   extractor: (item) => item.name,
+ *   extractor: (item) => item.nameField,
  * });
- * // sorted == [{ name: "Hello" }, { name: "World" }]
+ * // sorted == [{ nameField: "Hello" }, { nameField: "World" }]
  * ```
  *
  * @param list - The list of items to sort
@@ -119,7 +125,7 @@ export function alphaNumericSort<T>(
 ): readonly T[] {
   const {
     compare = DEFAULT_COLLATOR.compare,
-    extractor = defaultExtractor("alphaNumericSort"),
+    extractor = DEFAULT_EXTRACTOR,
     descending = false,
   } = options;