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

package/src/form/NativeSelect.tsx

@@ -19,7 +19,7 @@ import {
 } from "./types.js";
 
 /**
- * @remarks \@since 6.0.0 Added support for {@link UserAgentAutocompleteProps}
+ * @since 6.0.0 Added support for {@link UserAgentAutocompleteProps}
  */
 export interface NativeSelectProps
   extends Omit<SelectHTMLAttributes<HTMLSelectElement>, "autoComplete">,
@@ -71,8 +71,7 @@ export interface NativeSelectProps
  * same theming as `TextField` and `TextArea` components. This component might
  * not be used much since the `Select` offers more styling options.
  *
- * @example
- * Simple Example
+ * @example Simple Example
  * ```tsx
  * <NativeSelect label="Label">
  *   <option value="a">Value 1</option>
@@ -82,8 +81,7 @@ export interface NativeSelectProps
  * </NativeSelect>
  * ```
  *
- * @example
- * Required Value Example
+ * @example Required Value Example
  * ```tsx
  * function Example(): ReactElement {
  *   // using `defaultValue=""` makes it so the first option selected by default

package/src/form/OptGroup.tsx

@@ -9,7 +9,7 @@ import { MenuItemGroup } from "../menu/MenuItemGroup.js";
 import { type PropsWithRef } from "../types.js";
 import { useEnsuredId } from "../useEnsuredId.js";
 
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface OptGroupProps extends Omit<ListProps, "role"> {
   /**
    * This is really the `children` to display in a `ListSubheader` that
@@ -42,8 +42,7 @@ export interface OptGroupProps extends Omit<ListProps, "role"> {
  * correct accessibility when creating an `<optgroup>` with the `Select`
  * component.
  *
- * @example
- * Simple Example
+ * @example Simple Example
  * ```tsx
  * import { Select, OptGroup, Option } from "@react-md/core";
  * import FavoriteIcon from "@react-md/material-icons/FavoriteIcon";
@@ -67,7 +66,7 @@ export interface OptGroupProps extends Omit<ListProps, "role"> {
  * }
  * ```
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export const OptGroup = forwardRef<ListElement, OptGroupProps>(
   function OptGroup(props, ref) {

package/src/form/Option.tsx

@@ -23,16 +23,15 @@ const noop = (): void => {
  * This icon is used while the option is unselected so that the selected and
  * unselected options have the same alignment.
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export const DEFAULT_OPTION_UNSELECTED_ICON = (
   <span className={icon({ type: "svg" })} />
 );
 
 /**
- * @remarks
- * \@since 6.0.0 removed the `selected` and `focused` props.
- * \@since 6.0.0 Added the `value`, `selectedIcon`, `unselectedIcon`,
+ * @since 6.0.0 removed the `selected` and `focused` props.
+ * @since 6.0.0 Added the `value`, `selectedIcon`, `unselectedIcon`,
  * `selectedIconAfter`, and `iconSpacingProps` props.
  */
 export interface OptionProps extends MenuItemProps {
@@ -92,9 +91,8 @@ export interface OptionProps extends MenuItemProps {
  * This component is a wrapper around the {@link MenuItem} to implement custom
  * select option behavior.
  *
- * @remarks
- * \@since 6.0.0 removed the `selected` and `focused` props.
- * \@since 6.0.0 Added the `value`, `selectedIcon`, `unselectedIcon`,
+ * @since 6.0.0 removed the `selected` and `focused` props.
+ * @since 6.0.0 Added the `value`, `selectedIcon`, `unselectedIcon`,
  * `selectedIconAfter`, and `iconSpacingProps` props.
  */
 export const Option = forwardRef<HTMLLIElement, OptionProps>(

package/src/form/Password.tsx

@@ -13,8 +13,7 @@ import {
 import { TextField, type TextFieldProps } from "./TextField.js";
 
 /**
- * @example
- * Simple Example
+ * @example Simple Example
  * ```tsx
  * const getVisibilityIcon: GetPasswordVisibilityIcon = (isPasswordVisible) => {
  *   if (isPasswordVisible) {
@@ -34,8 +33,7 @@ export type GetPasswordVisibilityIcon = (
 ) => ReactNode;
 
 /**
- * @example
- * Simple Example
+ * @example Simple Example
  * ```tsx
  * const visibilityIcon: ConfigurableVisibilityIcon = {
  *   visible: <SecurityIcon />,
@@ -60,13 +58,12 @@ export interface PasswordProps
   extends Omit<TextFieldProps, "type" | "rightAddon"> {
   /**
    * @defaultValue `"password"`
-   * @remarks \@since 6.0.0 Defaults to `"password"`
+   * @since 6.0.0 Defaults to `"password"`
    */
   name?: string;
 
   /**
-   * @example
-   * Configurable Visibility Icon Object
+   * @example Configurable Visibility Icon Object
    * ```tsx
    * <Password
    *   {...props}
@@ -77,8 +74,7 @@ export interface PasswordProps
    * />
    * ```
    *
-   * @example
-   * Get Password Visibility Icon Function
+   * @example Get Password Visibility Icon Function
    * ```tsx
    * <Password
    *   {...props}
@@ -92,8 +88,7 @@ export interface PasswordProps
    * />
    * ```
    *
-   * @example
-   * Custom Icon
+   * @example Custom Icon
    * ```tsx
    * <Password
    *   {...props}
@@ -124,8 +119,7 @@ export interface PasswordProps
 /**
  * **Client Component**
  *
- * @example
- * Simple Example
+ * @example Simple Example
  * ```tsx
  * import { Password } from "@react-md/core";
  *

package/src/form/Radio.tsx

@@ -8,8 +8,7 @@ import { InputToggle, type RadioProps } from "./InputToggle.js";
  * You'll generally want to use the `useRadioGroup` hook along with this
  * component.
  *
- * @example
- * Simple Example
+ * @example Simple Example
  * ```tsx
  * const { value, getRadioProps } = useRadioGroup({ name: "group" });
  *

package/src/form/ResizingTextAreaWrapper.tsx

@@ -9,7 +9,7 @@ import {
 import { textArea } from "./textAreaStyles.js";
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export interface ResizingTextAreaWrapperProps
@@ -24,7 +24,7 @@ export interface ResizingTextAreaWrapperProps
 }
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export const ResizingTextAreaWrapper = forwardRef<

package/src/form/Select.tsx

@@ -52,8 +52,7 @@ const noop = (): void => {
  * invalid value. This also does not work for numbers, so you will need to
  * implement that yourself.
  *
- * @example
- * Simple Usage
+ * @example Simple Usage
  * ```tsx
  * import type { SelectedChangeEvent } from "@react-md/core";
  * import { Select, Option } from "@react-md/core";
@@ -84,13 +83,13 @@ const noop = (): void => {
  *   );
  * }
  * ```
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export type SelectChangeEvent<Value extends string> =
   ChangeEvent<HTMLInputElement> & { currentTarget: { value: Value } };
 
 /**
- * @remarks \@since 6.0.0 Rewritten with a new API.
+ * @since 6.0.0 Rewritten with a new API.
  */
 export interface SelectProps<Value extends string>
   extends Omit<TextFieldContainerProps, "label">,
@@ -212,8 +211,7 @@ export interface SelectProps<Value extends string>
 /**
  * **Client Component**
  *
- * @example
- * Simple Example
+ * @example Simple Example
  * ```tsx
  * import { Select, Option } from "react-md";
  * import { useState, type ReactElement } from "react";
@@ -237,8 +235,7 @@ export interface SelectProps<Value extends string>
  * }
  * ```
  *
- * @example
- * Testing
+ * @example Testing
  * ```tsx
  * rmdRender(
  *   <Select label="Select" selectedOptionProps={{ "data-testid": "selected" }}>
@@ -263,7 +260,7 @@ export interface SelectProps<Value extends string>
  * expect(selectInput).toHaveValue("b");
  * ```
  *
- * @remarks \@since 6.0.0 Rewritten with a new API.
+ * @since 6.0.0 Rewritten with a new API.
  */
 export function Select<Value extends string>(
   props: RequireAtLeastOne<SelectProps<Value>, "label" | keyof LabelA11y>

package/src/form/SelectedOption.tsx

@@ -6,7 +6,7 @@ import { type OptionProps } from "./Option.js";
 import { textField } from "./textFieldStyles.js";
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export interface SelectedOptionProps extends BoxProps {
@@ -20,7 +20,7 @@ export interface SelectedOptionProps extends BoxProps {
  *
  * This component is used to render the current option.
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export function SelectedOption(props: SelectedOptionProps): ReactElement {

package/src/form/Slider.tsx

@@ -55,7 +55,7 @@ const noop = (): void => {
 };
 
 /**
- * @remarks \@since 2.5.0
+ * @since 2.5.0
  */
 export interface BaseSliderProps
   extends HTMLAttributes<HTMLDivElement>,
@@ -104,11 +104,10 @@ export interface BaseSliderProps
 }
 
 /**
- * @remarks
- * \@since 2.5.0
- * \@since 6.0.0 Only requires `value` and `setValue` props instead of all the
+ * @since 2.5.0
+ * @since 6.0.0 Only requires `value` and `setValue` props instead of all the
  * slider controls.
- * \@since 6.0.0 The `thumbLabel` and `thumbLabelledBy` props were removed. Use
+ * @since 6.0.0 The `thumbLabel` and `thumbLabelledBy` props were removed. Use
  * the `aria-label` or `aria-labelledby` props instead.
  */
 export interface SliderProps extends BaseSliderProps, SliderState {
@@ -121,8 +120,7 @@ export interface SliderProps extends BaseSliderProps, SliderState {
   /**
    * This can be used to update the discrete slider's tooltip props.
    *
-   * @example
-   * Custom Styles
+   * @example Custom Styles
    * ```tsx
    * <Slider
    *   {...slider}
@@ -140,8 +138,7 @@ export interface SliderProps extends BaseSliderProps, SliderState {
   /**
    * This can be used to update the discrete slider's value tooltip.
    *
-   * @example
-   * More Value Information
+   * @example More Value Information
    * ```tsx
    * <Slider
    *   {...slider}
@@ -162,11 +159,10 @@ export interface SliderProps extends BaseSliderProps, SliderState {
 }
 
 /**
- * @remarks
- * \@since 2.5.0
- * \@since 6.0.0 Only requires `rangeValue` and `setRangeValue` props instead of
+ * @since 2.5.0
+ * @since 6.0.0 Only requires `rangeValue` and `setRangeValue` props instead of
  * all the slider controls.
- * \@since 6.0.0 The `thumb1Label`, `thumb1LabelledBy`, `thumb1Props`,
+ * @since 6.0.0 The `thumb1Label`, `thumb1LabelledBy`, `thumb1Props`,
  * `thumb2Label`, `thumb2LabelledBy` and `thumb2Props` were renamed to
  * `minThumbLabel`, `minThumbLabelledBy`, `minThumbProps`, `maxThumbLabel`,
  * `maxThumbLabelledBy`, and `maxThumbProps` respectively.
@@ -223,8 +219,7 @@ export interface RangeSliderProps extends BaseSliderProps, RangeSliderState {
   /**
    * This can be used to update the discrete slider's tooltip props.
    *
-   * @example
-   * Custom Styles
+   * @example Custom Styles
    * ```tsx
    * <Slider
    *   {...slider}
@@ -242,8 +237,7 @@ export interface RangeSliderProps extends BaseSliderProps, RangeSliderState {
   /**
    * This can be used to update the discrete slider's value tooltip.
    *
-   * @example
-   * More Value Information
+   * @example More Value Information
    * ```tsx
    * <Slider
    *   {...rangeSlider}
@@ -269,8 +263,7 @@ export interface RangeSliderProps extends BaseSliderProps, RangeSliderState {
 /**
  * **Client Component**
  *
- * @example
- * Simple Example
+ * @example Simple Example
  * ```tsx
  * import { Form, Slider, useSlider } from "@react-md/core";
  * import type { ReactElement } from "react";
@@ -296,8 +289,7 @@ export interface RangeSliderProps extends BaseSliderProps, RangeSliderState {
  * }
  * ```
  *
- * @example
- * Range Slider Example
+ * @example Range Slider Example
  * ```tsx
  * import { Fieldset, Form, Legend, Slider, useRangeSlider } from "@react-md/core";
  * import type { ReactElement } from "react";
@@ -328,11 +320,10 @@ export interface RangeSliderProps extends BaseSliderProps, RangeSliderState {
  * }
  * ```
  *
- * @remarks
- * \@since 2.5.0
- * \@since 6.0.0 The `Slider` and `RangeSlider` have been combined into the
+ * @since 2.5.0
+ * @since 6.0.0 The `Slider` and `RangeSlider` have been combined into the
  * single `Slider` component and removed the `label` support.
- * \@since 6.0.0 Each thumb includes an invisible `<input type="range">` instead
+ * @since 6.0.0 Each thumb includes an invisible `<input type="range">` instead
  * of an `<input type="hidden">`.
  */
 export function Slider(props: LabelRequiredForA11y<SliderProps>): ReactElement;

package/src/form/SliderContainer.tsx

@@ -5,9 +5,8 @@ import { bem } from "../utils/bem.js";
 const styles = bem("rmd-slider-container");
 
 /**
- * @remarks
- * \@since 2.5.0
- * \@since 6.0.0 Renamed from `SliderAddons` to `SliderContainerAddonProps`
+ * @since 2.5.0
+ * @since 6.0.0 Renamed from `SliderAddons` to `SliderContainerAddonProps`
  */
 export interface SliderAddonProps {
   /**
@@ -30,9 +29,8 @@ export interface SliderAddonProps {
 
 /**
  * @internal
- * @remarks
- * \@since 2.5.0
- * \@since 6.0.0 Removed the `label` support since you'll generally want to use
+ * @since 2.5.0
+ * @since 6.0.0 Removed the `label` support since you'll generally want to use
  * a `Fieldset` instead.
  */
 export interface SliderContainerProps
@@ -50,9 +48,8 @@ export interface SliderContainerProps
  * bottom or top instead.
  *
  * @internal
- * @remarks
- * \@since 2.5.0
- * \@since 6.0.0 Removed the `label` support since you'll generally want to use
+ * @since 2.5.0
+ * @since 6.0.0 Removed the `label` support since you'll generally want to use
  * a `Fieldset` instead.
  */
 export const SliderContainer = forwardRef<HTMLDivElement, SliderContainerProps>(

package/src/form/SliderMark.tsx

@@ -6,7 +6,7 @@ const styles = bem("rmd-slider-mark");
 
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface SliderMarkProps extends HTMLAttributes<HTMLSpanElement> {
   active: boolean;
@@ -18,7 +18,7 @@ export interface SliderMarkProps extends HTMLAttributes<HTMLSpanElement> {
  * **Server Component**
  *
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export function SliderMark(props: SliderMarkProps): ReactElement {
   const { active, offset, vertical, style, className, ...remaining } = props;

package/src/form/SliderMarkLabel.tsx

@@ -11,7 +11,7 @@ import { bem } from "../utils/bem.js";
 const styles = bem("rmd-slider-mark-label");
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface CustomizableSliderMarkLabelProps extends TypographyProps {
   /** @defaultValue `"span"` */
@@ -23,7 +23,7 @@ export interface CustomizableSliderMarkLabelProps extends TypographyProps {
 
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface SliderMarkLabelProps extends CustomizableSliderMarkLabelProps {
   offset: string;
@@ -34,7 +34,7 @@ export interface SliderMarkLabelProps extends CustomizableSliderMarkLabelProps {
  * **Server Component**
  *
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export function SliderMarkLabel(props: SliderMarkLabelProps): ReactElement {
   const {

package/src/form/SliderThumb.tsx

@@ -23,7 +23,7 @@ const noop = (): void => {
 
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 interface SliderThumbClassNameOptions {
   className?: string;
@@ -38,7 +38,7 @@ interface SliderThumbClassNameOptions {
 
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 function sliderThumb(options: SliderThumbClassNameOptions): string {
   const { className, mask, index, active, animate, disabled, vertical } =
@@ -67,12 +67,12 @@ function sliderThumb(options: SliderThumbClassNameOptions): string {
 }
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export type SliderTooltipVisibility = "auto" | "hover" | "always";
 
 /**
- * @remarks \@since 2.5.0
+ * @since 2.5.0
  */
 export interface SliderThumbPresentation {
   /**
@@ -128,9 +128,8 @@ export interface SliderThumbPresentation {
 
 /**
  * @internal
- * @remarks
- * \@since 2.5.0
- * \@since 6.0.0 Internal only component.
+ * @since 2.5.0
+ * @since 6.0.0 Internal only component.
  */
 export interface SliderThumbProps
   extends Omit<HTMLAttributes<HTMLSpanElement>, "onChange">,
@@ -157,9 +156,8 @@ export interface SliderThumbProps
  * **Client Component**
  *
  * @internal
- * @remarks
- * \@since 2.5.0
- * \@since 6.0.0 Internal only component.
+ * @since 2.5.0
+ * @since 6.0.0 Internal only component.
  */
 export const SliderThumb = forwardRef<
   HTMLSpanElement,

package/src/form/SliderTrack.tsx

@@ -12,9 +12,8 @@ const styles = bem("rmd-slider-track");
 
 /**
  * @internal
- * @remarks
- * \@since 2.5.0
- * \@since 6.0.0 Updated to be internal only.
+ * @since 2.5.0
+ * @since 6.0.0 Updated to be internal only.
  */
 export interface SliderTrackProps
   extends HTMLAttributes<HTMLSpanElement>,
@@ -28,9 +27,8 @@ export interface SliderTrackProps
  * **Server Component**
  *
  * @internal
- * @remarks
- * \@since 2.5.0
- * \@since 6.0.0 Updated to be internal only.
+ * @since 2.5.0
+ * @since 6.0.0 Updated to be internal only.
  */
 export const SliderTrack = forwardRef<HTMLSpanElement, SliderTrackProps>(
   function SliderTrack(props, ref) {

package/src/form/SliderValueMarks.tsx

@@ -16,7 +16,7 @@ import {
 } from "./SliderMarkLabel.js";
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface SliderValueMark {
   /**
@@ -33,7 +33,7 @@ export interface SliderValueMark {
 }
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface SliderValueMarkState {
   /** The {@link SliderValueMark.value} */
@@ -54,7 +54,7 @@ export interface SliderValueMarkState {
 }
 
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface SliderMarksOptions {
   /**
@@ -63,8 +63,7 @@ export interface SliderMarksOptions {
    * {@link getMarkLabelProps} to customize the styles or display a label for
    * the mark.
    *
-   * @example
-   * Custom Marks
+   * @example Custom Marks
    * ```tsx
    * const slider = useSlider({ step: 10 });
    *
@@ -99,8 +98,7 @@ export interface SliderMarksOptions {
    * This can be used to override any styles for a specific mark's label or
    * display a label dynamically.
    *
-   * @example
-   * Dynamic Labels
+   * @example Dynamic Labels
    * ```tsx
    * <Slider
    *   {...slider}
@@ -125,7 +123,7 @@ export interface SliderMarksOptions {
 
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface SliderValueMarksProps
   extends RangeStepsOptions,
@@ -140,7 +138,7 @@ export interface SliderValueMarksProps
  * **Server Component**
  *
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export function SliderValueMarks(props: SliderValueMarksProps): ReactElement {
   const {

package/src/form/SliderValueTooltip.tsx

@@ -23,9 +23,8 @@ const VERTICAL_CLASS_NAMES: CSSTransitionClassNames = {
 
 /**
  * @internal
- * @remarks
- * \@since 2.5.0
- * \@since 6.0.0 Renamed from `SliderValueProps` to `SliderValueTooltipProps`.
+ * @since 2.5.0
+ * @since 6.0.0 Renamed from `SliderValueProps` to `SliderValueTooltipProps`.
  */
 export interface SliderValueTooltipProps extends TooltipProps {
   index: 1 | 2;
@@ -41,9 +40,8 @@ export interface SliderValueTooltipProps extends TooltipProps {
  * tooltip when needed.
  *
  * @internal
- * @remarks
- * \@since 2.5.0
- * \@since 6.0.0 Renamed from `SliderValue` to `SliderValueTooltip`.
+ * @since 2.5.0
+ * @since 6.0.0 Renamed from `SliderValue` to `SliderValueTooltip`.
  */
 export function SliderValueTooltip(
   props: SliderValueTooltipProps

package/src/form/Switch.tsx

@@ -19,7 +19,7 @@ import {
 } from "./types.js";
 
 /**
- * @remarks \@since 6.0.0 Added `containerProps` and support for the
+ * @since 6.0.0 Added `containerProps` and support for the
  * `FormMessage` behavior.
  */
 export interface SwitchProps
@@ -40,8 +40,7 @@ export interface SwitchProps
 /**
  * **Server Component**
  *
- * @example
- * Simple Example
+ * @example Simple Example
  * ```tsx
  * import { Form, Switch } from "@react-md/core";
  * import type { ReactElement } from "react";
@@ -63,7 +62,7 @@ export interface SwitchProps
  * }
  * ```
  *
- * @remarks \@since 6.0.0 Added support for `FormMessage` behavior.
+ * @since 6.0.0 Added support for `FormMessage` behavior.
  */
 export const Switch = forwardRef<HTMLInputElement, SwitchProps>(
   function Switch(props, ref) {

package/src/form/TextArea.tsx

@@ -21,7 +21,7 @@ import {
 } from "./useResizingTextArea.js";
 
 /**
- * @remarks \@since 6.0.0 Added `containerProps`.
+ * @since 6.0.0 Added `containerProps`.
  */
 export interface TextAreaProps
   extends FormFieldOptions,
@@ -99,8 +99,7 @@ export interface TextAreaProps
 /**
  * **Client Component**
  *
- * @example
- * Simple Example
+ * @example Simple Example
  * ```tsx
  * import { TextArea } from "@react-md/core";
  * import type { ReactElement } from "react";