@react-md/core 1.0.0-next.12 → 1.0.0-next.13

package/src/form/sliderUtils.ts

@@ -14,7 +14,7 @@ import { getPercentage } from "../utils/getPercentage.js";
 import { getRangeSteps } from "../utils/getRangeSteps.js";
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 interface JumpOptions {
@@ -25,7 +25,7 @@ interface JumpOptions {
 }
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export const getJumpValue = (options: JumpOptions): number => {
@@ -41,7 +41,7 @@ export const getJumpValue = (options: JumpOptions): number => {
 };
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 type RequiredThumbProps = Pick<
@@ -52,7 +52,7 @@ type RequiredThumbProps = Pick<
 > & { ref: RefObject<HTMLSpanElement> };
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export type ClosestThumbEventHandlersOptions = RenameKeysWithPrefix<
@@ -67,7 +67,7 @@ export type ClosestThumbEventHandlersOptions = RenameKeysWithPrefix<
 /**
  * NOTE: I do not need the mousemove events for this one to work.
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export const getClosestThumbEventHandlers = (
@@ -156,7 +156,7 @@ export const getClosestThumbEventHandlers = (
 
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export function getThumbOffset(
   offset: number | undefined,
@@ -174,7 +174,7 @@ export function getThumbOffset(
 }
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export interface ThumbOffsetsOptions {
@@ -190,7 +190,7 @@ export interface ThumbOffsetsOptions {
 }
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 interface ThumbOffsets {
@@ -199,7 +199,7 @@ interface ThumbOffsets {
 }
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export const getThumbOffsets = (options: ThumbOffsetsOptions): ThumbOffsets => {

package/src/form/switchStyles.ts

@@ -11,7 +11,7 @@ declare module "react" {
 const styles = bem("rmd-switch");
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface SwitchClassNameOptions {
   className?: string;
@@ -20,7 +20,7 @@ export interface SwitchClassNameOptions {
 }
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export function switchStyles(options: SwitchClassNameOptions = {}): string {
   const { className, clickable, currentColor } = options;

package/src/form/textAreaStyles.ts

@@ -17,7 +17,7 @@ const styles = bem("rmd-textarea");
 const containerStyles = bem("rmd-textarea-container");
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface TextareaClassNameOptions extends TextFieldClassNameOptions {
   className?: string;
@@ -45,7 +45,7 @@ export interface TextareaClassNameOptions extends TextFieldClassNameOptions {
 }
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export function textArea(options: TextareaClassNameOptions = {}): string {
   const {
@@ -70,7 +70,7 @@ export function textArea(options: TextareaClassNameOptions = {}): string {
 }
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface TextareaContainerClassNameOptions {
   className?: string;
@@ -81,7 +81,7 @@ export interface TextareaContainerClassNameOptions {
 }
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export function textAreaContainer(
   options: TextareaContainerClassNameOptions = {}

package/src/form/textFieldContainerStyles.ts

@@ -19,7 +19,7 @@ declare module "react" {
 
 const styles = bem("rmd-text-field-container");
 
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface TextFieldContainerClassNameOptions
   extends FormThemeOptions,
     FormComponentStates {
@@ -45,7 +45,7 @@ export interface TextFieldContainerClassNameOptions
 }
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export function textFieldContainer(
   options: TextFieldContainerClassNameOptions = {}

package/src/form/textFieldStyles.ts

@@ -3,7 +3,7 @@ import { bem } from "../utils/bem.js";
 
 const styles = bem("rmd-text-field");
 
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface TextFieldClassNameOptions {
   className?: string;
 
@@ -19,7 +19,7 @@ export interface TextFieldClassNameOptions {
 }
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export function textField(options: TextFieldClassNameOptions = {}): string {
   const { className, placeholderHidden = false } = options;

package/src/form/types.ts

@@ -53,7 +53,7 @@ export interface FormThemeOptions {
 }
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface FormConfiguration extends Required<FormThemeOptions> {
   /**
@@ -86,7 +86,7 @@ export interface FormComponentStates {
 }
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @see https://html.spec.whatwg.org/multipage/forms.html#autofill
  * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete#values
  */
@@ -147,7 +147,7 @@ export type AutocompleteValue =
   | "photo";
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface UserAgentAutocompleteProps {
   /**
@@ -284,7 +284,7 @@ export interface FormMessageProps
  *
  * Note: this should not be used alongside form-level messages.
  *
- * @remarks \@since 2.9.0 Renamed from `FormMessageCounterProps` to
+ * @since 2.9.0 Renamed from `FormMessageCounterProps` to
  * `FormMessageInputLengthCounterProps` since a `FormMessageCounter` component
  * was added
  */
@@ -315,7 +315,7 @@ export interface FormMessageWithCounterProps
     FormMessageInputLengthCounterProps {}
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface FormMessageWithoutCounterProps extends FormMessageProps {
   length?: never;
@@ -348,7 +348,7 @@ export interface FormMessageContainerExtension {
   >;
 }
 
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface LabelClassNameOptions {
   className?: string;
 
@@ -437,7 +437,7 @@ export interface LabelProps
     LabelClassNameOptions {}
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface ConfigurableTextFieldAddonProps
   extends HTMLAttributes<HTMLSpanElement> {
@@ -451,7 +451,7 @@ export interface ConfigurableTextFieldAddonProps
 }
 
 /**
- * @remarks \@since 6.0.0 Added support for `leftAddonProps` and
+ * @since 6.0.0 Added support for `leftAddonProps` and
  * `rightAddonProps`.
  */
 export interface TextFieldContainerOptions
@@ -489,7 +489,7 @@ export interface TextFieldContainerOptions
   /**
    * Any additional props to pass to the `<span>` surrounding the {@link leftAddon}.
    *
-   * @remarks \@since 6.0.0
+   * @since 6.0.0
    */
   leftAddonProps?: PropsWithRef<
     ConfigurableTextFieldAddonProps,
@@ -512,7 +512,7 @@ export interface TextFieldContainerOptions
   /**
    * Any additional props to pass to the `<span>` surrounding the {@link rightAddon}.
    *
-   * @remarks \@since 6.0.0
+   * @since 6.0.0
    */
   rightAddonProps?: PropsWithRef<
     ConfigurableTextFieldAddonProps,

package/src/form/useCheckboxGroup.ts

@@ -4,7 +4,7 @@ import { type UseStateInitializer, type UseStateSetter } from "../types.js";
 
 const EMPTY_LIST = [] as const;
 
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface CheckboxGroupOptions<V> {
   /**
    * A `name` to apply to all the checkboxes within the group. This is required
@@ -27,8 +27,7 @@ export interface CheckboxGroupOptions<V> {
    * checkbox is checked and determine if all the checkboxes have manually be
    * selected.
    *
-   * @example
-   * Indeterminate Behavior
+   * @example Indeterminate Behavior
    * ```tsx
    * const OPTIONS = [
    *   { label: "First", value: "a" },
@@ -54,7 +53,7 @@ export interface CheckboxGroupOptions<V> {
   defaultCheckedValues?: UseStateInitializer<readonly V[]>;
 }
 
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface CheckboxGroupImplementation<V extends string> {
   reset(): void;
   checkedValues: ReadonlySet<V>;
@@ -67,7 +66,7 @@ export interface CheckboxGroupImplementation<V extends string> {
   };
 }
 
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface IndeterminateCheckboxGroupImplementation<V extends string>
   extends CheckboxGroupImplementation<V> {
   getIndeterminateProps(): {
@@ -79,7 +78,7 @@ export interface IndeterminateCheckboxGroupImplementation<V extends string>
   };
 }
 
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface MenuItemCheckboxGroupImplementation<V extends string> {
   reset(): void;
   checkedValues: ReadonlySet<V>;
@@ -90,7 +89,7 @@ export interface MenuItemCheckboxGroupImplementation<V extends string> {
   };
 }
 
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface IndeterminateMenuItemCheckboxGroupImplementation<
   V extends string,
 > extends MenuItemCheckboxGroupImplementation<V> {
@@ -102,7 +101,7 @@ export interface IndeterminateMenuItemCheckboxGroupImplementation<
   };
 }
 
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface CombinedCheckboxGroupReturnValue<V extends string> {
   reset(): void;
   checkedValues: ReadonlySet<V>;
@@ -125,8 +124,7 @@ export interface CombinedCheckboxGroupReturnValue<V extends string> {
 }
 
 /**
- * @example
- * Checkbox Group
+ * @example Checkbox Group
  * ```tsx
  * const { getCheckboxProps, checkedValues } = useCheckboxGroup({ name: "example" });
  *
@@ -145,7 +143,7 @@ export interface CombinedCheckboxGroupReturnValue<V extends string> {
  * );
  * ```
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export function useCheckboxGroup<V extends string>(
   options: CheckboxGroupOptions<V> & {
@@ -155,8 +153,7 @@ export function useCheckboxGroup<V extends string>(
   }
 ): CheckboxGroupImplementation<V>;
 /**
- * @example
- * Indeterminate Checkbox Group
+ * @example Indeterminate Checkbox Group
  * ```tsx
  * const OPTIONS = [
  *   { label: "First", value: "a" },
@@ -184,7 +181,7 @@ export function useCheckboxGroup<V extends string>(
  * );
  * ```
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export function useCheckboxGroup<V extends string>(
   options: CheckboxGroupOptions<V> & {
@@ -194,8 +191,7 @@ export function useCheckboxGroup<V extends string>(
   }
 ): IndeterminateCheckboxGroupImplementation<V>;
 /**
- * @example
- * MenuItemCheckbox Group
+ * @example MenuItemCheckbox Group
  * ```tsx
  * const { getCheckboxProps, checkedValues } = useCheckboxGroup({ menu: true });
  *
@@ -214,7 +210,7 @@ export function useCheckboxGroup<V extends string>(
  * );
  * ```
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export function useCheckboxGroup<V extends string>(
   options: CheckboxGroupOptions<V> & {
@@ -224,8 +220,7 @@ export function useCheckboxGroup<V extends string>(
   }
 ): MenuItemCheckboxGroupImplementation<V>;
 /**
- * @example
- * Indeterminate MenuItemCheckbox Group
+ * @example Indeterminate MenuItemCheckbox Group
  * ```tsx
  * const OPTIONS = [
  *   { label: "First", value: "a" },
@@ -253,7 +248,7 @@ export function useCheckboxGroup<V extends string>(
  * );
  * ```
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export function useCheckboxGroup<V extends string>(
   options: CheckboxGroupOptions<V> & {

package/src/form/useCombobox.ts

@@ -2,6 +2,8 @@
 import {
   useRef,
   type FocusEventHandler,
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  type InputHTMLAttributes,
   type KeyboardEventHandler,
   type MouseEventHandler,
   type Ref,
@@ -44,7 +46,7 @@ const noop = (): void => {
 };
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export const getNonDisabledOptions = (
   container: HTMLElement
@@ -55,12 +57,12 @@ export const getNonDisabledOptions = (
 ];
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export type SupportedComboboxPopup = "listbox" | "grid" | "dialog";
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface ComboboxKeyboardMovementData<
   E extends HTMLElement = HTMLInputElement,
@@ -72,14 +74,14 @@ export interface ComboboxKeyboardMovementData<
 }
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export type ExtendComboboxKeyDown<E extends HTMLElement = HTMLInputElement> = (
   movementData: ComboboxKeyboardMovementData<E>
 ) => void;
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export type ComboboxKeyboardMovementOptions<
   ComboboxEl extends HTMLElement = HTMLInputElement,
@@ -96,7 +98,7 @@ export type ComboboxKeyboardMovementOptions<
 >;
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface BaseComboboxOptions<
   ComboboxEl extends HTMLElement = HTMLInputElement,
@@ -141,7 +143,7 @@ export interface BaseComboboxOptions<
 }
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface ComboboxOptions<
   ComboboxEl extends HTMLElement = HTMLInputElement,
@@ -155,7 +157,7 @@ export interface ComboboxOptions<
 }
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface ComboboxWidgetProps<
   ComboboxEl extends HTMLElement = HTMLInputElement,
@@ -173,7 +175,7 @@ export interface ComboboxWidgetProps<
 }
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface ComboboxWidgetPopupProps<
   PopupEl extends HTMLElement = HTMLElement,
@@ -184,7 +186,7 @@ export interface ComboboxWidgetPopupProps<
 }
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export type ComboboxTransitionCallbacks = Pick<
   TransitionCallbacks,
@@ -192,14 +194,14 @@ export type ComboboxTransitionCallbacks = Pick<
 >;
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface ComboboxTransitionOptions extends ComboboxTransitionCallbacks {
   disableTransition?: boolean;
 }
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export type ConfigurableComboboxMenuProps = Partial<
   Omit<
@@ -209,7 +211,7 @@ export type ConfigurableComboboxMenuProps = Partial<
 >;
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface ProvidedComboboxMenuProps<
   ComboboxEl extends HTMLElement = HTMLInputElement,
@@ -232,7 +234,7 @@ export interface ProvidedComboboxMenuProps<
 }
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface ComboboxMenuProps<
   ComboboxEl extends HTMLElement = HTMLInputElement,
@@ -253,7 +255,7 @@ export type ComboboxGetMenuProps<
 ) => ComboboxMenuProps<ComboboxEl, PopupEl>;
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface ComboboxImplementation<
   ComboboxEl extends HTMLElement = HTMLInputElement,
@@ -276,7 +278,7 @@ export interface ComboboxImplementation<
 }
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export function useCombobox<
   ComboboxEl extends HTMLElement = HTMLInputElement,

package/src/form/useEditableCombobox.ts

@@ -9,7 +9,7 @@ import {
 import { isChangeableHTMLElement, triggerManualChangeEvent } from "./utils.js";
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface EditableComboboxOptions<
   ComboboxEl extends HTMLElement = HTMLInputElement,
@@ -17,7 +17,7 @@ export interface EditableComboboxOptions<
 > extends BaseComboboxOptions<ComboboxEl, PopupEl> {}
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface EditableComboboxImplementation<
   ComboboxEl extends HTMLElement = HTMLInputElement,
@@ -25,7 +25,7 @@ export interface EditableComboboxImplementation<
 > extends ComboboxImplementation<ComboboxEl, PopupEl> {}
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export function useEditableCombobox<
   ComboboxEl extends HTMLElement = HTMLInputElement,

package/src/form/useFileUpload.ts

@@ -31,7 +31,7 @@ const noop = (): void => {
  *
  * @typeParam CustomError - An optional error type that gets returned from the
  * {@link FilesValidator}.
- * @remarks \@since 2.9.0
+ * @since 2.9.0
  */
 export interface FileUploadState<CustomError = never> {
   /**
@@ -60,7 +60,7 @@ export interface FileUploadState<CustomError = never> {
  *
  * @typeParam CustomError - An optional error type that gets returned from the
  * {@link FilesValidator}.
- * @remarks \@since 2.9.0
+ * @since 2.9.0
  * @internal
  */
 export interface FileUploadHookState<CustomError = never>
@@ -79,7 +79,7 @@ export interface FileUploadHookState<CustomError = never>
  * {@link FileUploadHandlers}.
  * @typeParam CustomError - An optional error type that gets returned from the
  * {@link FilesValidator}.
- * @remarks \@since 2.9.0
+ * @since 2.9.0
  */
 export interface FileUploadOptions<E extends HTMLElement, CustomError = never>
   extends FileUploadHandlers<E>,
@@ -114,7 +114,7 @@ type Action<E = never> =
   | { type: "complete"; key: string; result: FileReaderResult }
   | { type: "clearErrors" };
 
-/** @remarks \@since 2.9.0 */
+/** @since 2.9.0 */
 export interface FileUploadActions {
   /**
    * Reset everything related to uploads ensuring that all file readers have
@@ -144,7 +144,7 @@ export interface FileUploadActions {
  * {@link FileUploadHandlers}.
  * @typeParam CustomError - An optional error type that gets returned from the
  * {@link FilesValidator}.
- * @remarks \@since 2.9.0
+ * @since 2.9.0
  */
 export interface FileUploadHookReturnValue<
   E extends HTMLElement = HTMLElement,
@@ -177,8 +177,7 @@ export interface FileUploadHookReturnValue<
    * when the {@link FileValidationOptions.extensions} list has been provided to
    * limit which files the OS will _attempt_ to allow access to.
    *
-   * @example
-   * Simple example
+   * @example Simple example
    * ```ts
    * const extensions = ['pdf', 'docx', 'ppt'];
    * const { accept } = useFileUpload({ extensions, ...others });
@@ -211,7 +210,7 @@ const EMPTY_OBJECT = {} as const;
  * {@link FilesValidator}.
  * @param options - All the {@link FileUploadOptions}
  * @returns the {@link FileUploadHookReturnValue}
- * @remarks \@since 2.9.0
+ * @since 2.9.0
  */
 export function useFileUpload<E extends HTMLElement, CustomError = never>({
   maxFiles = -1,

package/src/form/useFormReset.ts

@@ -6,7 +6,7 @@ import {
 } from "./utils.js";
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export interface FormResetOptions {
@@ -16,7 +16,7 @@ export interface FormResetOptions {
 }
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export function useFormReset(options: FormResetOptions): void {

package/src/form/useListboxProvider.ts

@@ -4,7 +4,7 @@ import { type ChangeableHTMLElement } from "./utils.js";
 
 /**
  * @internal
- * \@remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface ListboxContext {
   /**
@@ -28,13 +28,13 @@ const context = createContext<ListboxContext | null>(null);
  * **Client Component**
  *
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export const { Provider: ListboxProvider } = context;
 
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export function useListboxContext(): ListboxContext {
   const value = useContext(context);