@mantine/core 8.1.2 → 8.2.0

package/lib/components/Checkbox/CheckboxIndicator/CheckboxIndicator.d.ts

@@ -5,15 +5,15 @@ export type CheckboxIndicatorCssVariables = {
     indicator: '--checkbox-size' | '--checkbox-radius' | '--checkbox-color' | '--checkbox-icon-color';
 };
 export interface CheckboxIndicatorProps extends BoxProps, StylesApiProps<CheckboxIndicatorFactory>, ElementProps<'div'> {
-    /** Key of `theme.colors` or any valid CSS color to set input background color in checked state, `theme.primaryColor` by default */
+    /** Key of `theme.colors` or any valid CSS color to set input background color in checked state @default `theme.primaryColor` */
     color?: MantineColor;
-    /** Controls size of the component, `'sm'` by default */
+    /** Controls size of the component @default `'sm'` */
     size?: MantineSize | (string & {});
-    /** Key of `theme.radius` or any valid CSS value to set `border-radius,` `theme.defaultRadius` by default */
+    /** Key of `theme.radius` or any valid CSS value to set `border-radius` @default `theme.defaultRadius` */
     radius?: MantineRadius;
     /** Key of `theme.colors` or any valid CSS color to set icon color, by default value depends on `theme.autoContrast` */
     iconColor?: MantineColor;
-    /** Determines whether icon color with filled variant should depend on `background-color`. If luminosity of the `color` prop is less than `theme.luminosityThreshold`, then `theme.white` will be used for text color, otherwise `theme.black`. Overrides `theme.autoContrast`. */
+    /** If set, adjusts text color based on background color for `filled` variant */
     autoContrast?: boolean;
     /** Indeterminate state of the checkbox. If set, `checked` prop is ignored. */
     indeterminate?: boolean;

package/lib/components/Chip/Chip.d.ts

@@ -6,11 +6,11 @@ export type ChipCssVariables = {
     root: '--chip-fz' | '--chip-size' | '--chip-icon-size' | '--chip-padding' | '--chip-checked-padding' | '--chip-radius' | '--chip-bg' | '--chip-hover' | '--chip-color' | '--chip-bd' | '--chip-spacing';
 };
 export interface ChipProps extends BoxProps, StylesApiProps<ChipFactory>, ElementProps<'input', 'size' | 'onChange'> {
-    /** Key of `theme.radius` or any valid CSS value to set `border-radius`, `'xl'` by default */
+    /** Key of `theme.radius` or any valid CSS value to set `border-radius` @default `'xl'` */
     radius?: MantineRadius;
-    /** Controls various properties related to component size, `'sm'` by default */
+    /** Controls various properties related to component size @default `'sm'` */
     size?: MantineSize;
-    /** Chip input type, `'checkbox'` by default */
+    /** Chip input type @default `'checkbox'` */
     type?: 'radio' | 'checkbox';
     /** `label` element associated with the input */
     children: React.ReactNode;
@@ -20,9 +20,9 @@ export interface ChipProps extends BoxProps, StylesApiProps<ChipFactory>, Elemen
     defaultChecked?: boolean;
     /** Calls when checked state changes */
     onChange?: (checked: boolean) => void;
-    /** Controls components colors based on `variant` prop. Key of `theme.colors` or any valid CSS color. `theme.primaryColor` by default */
+    /** Controls components colors based on `variant` prop. Key of `theme.colors` or any valid CSS color. @default `theme.primaryColor` */
     color?: MantineColor;
-    /** Static id to connect input with the label, by default `id` is randomly generated */
+    /** Unique input id */
     id?: string;
     /** Props passed down to the root element */
     wrapperProps?: React.ComponentPropsWithoutRef<'div'> & DataAttributes;
@@ -30,7 +30,7 @@ export interface ChipProps extends BoxProps, StylesApiProps<ChipFactory>, Elemen
     icon?: React.ReactNode;
     /** Assigns ref of the root element */
     rootRef?: React.ForwardedRef<HTMLDivElement>;
-    /** Determines whether button text color with filled variant should depend on `background-color`. If luminosity of the `color` prop is less than `theme.luminosityThreshold`, then `theme.white` will be used for text color, otherwise `theme.black`. Overrides `theme.autoContrast`. */
+    /** If set, adjusts text color based on background color for `filled` variant */
     autoContrast?: boolean;
 }
 export type ChipFactory = Factory<{

package/lib/components/Chip/ChipGroup/ChipGroup.d.ts

@@ -1,5 +1,5 @@
 export interface ChipGroupProps<T extends boolean = false> {
-    /** Determines whether it is allowed to select multiple values, `false` by default */
+    /** If set, multiple values can be selected */
     multiple?: T;
     /** Controlled component value */
     value?: T extends true ? string[] : string | null;

package/lib/components/Chip/ChipGroup.context.d.ts

@@ -1,7 +1,7 @@
 interface ChipGroupContextValue {
     isChipSelected: (value: string) => boolean;
     onChange: (event: React.ChangeEvent<HTMLInputElement>) => void;
-    multiple: boolean;
+    multiple: boolean | undefined;
 }
 export declare const ChipGroupProvider: ({ children, value }: {
     value: ChipGroupContextValue;

package/lib/components/CloseButton/CloseButton.d.ts

@@ -6,17 +6,17 @@ export type CloseButtonCssVariables = {
 };
 export interface __CloseButtonProps {
     'data-disabled'?: boolean;
-    /** Controls width and height of the button. Numbers are converted to rem. `'md'` by default. */
+    /** Controls width and height of the button. Numbers are converted to rem. @default `'md'` */
     size?: MantineSize | (string & {}) | number;
-    /** Key of `theme.radius` or any valid CSS value to set border-radius. Numbers are converted to rem. `theme.defaultRadius` by default. */
+    /** Key of `theme.radius` or any valid CSS value to set border-radius. Numbers are converted to rem. @default `theme.defaultRadius` */
     radius?: MantineRadius;
-    /** Sets `disabled` and `data-disabled` attributes on the button element */
+    /** Sets `disabled` attribute, assigns disabled styles */
     disabled?: boolean;
-    /** `X` icon `width` and `height`, `80%` by default */
+    /** `X` icon `width` and `height` @default `80%` */
     iconSize?: number | string;
-    /** Content rendered inside the button, for example `VisuallyHidden` with label for screen readers */
+    /** Content rendered inside the button. For example `VisuallyHidden` with label for screen readers. */
     children?: React.ReactNode;
-    /** Replaces default close icon. If set, `iconSize` prop is ignored. */
+    /** React node to replace the default close icon. If set, `iconSize` prop is ignored. */
     icon?: React.ReactNode;
 }
 export interface CloseButtonProps extends __CloseButtonProps, BoxProps, StylesApiProps<CloseButtonFactory> {

package/lib/components/Code/Code.d.ts

@@ -4,9 +4,9 @@ export type CodeCssVariables = {
     root: '--code-bg';
 };
 export interface CodeProps extends BoxProps, StylesApiProps<CodeFactory>, ElementProps<'code'> {
-    /** Key of `theme.colors` or any valid CSS color, controls `background-color` of the code, by default value is calculated based on color scheme */
+    /** Key of `theme.colors` or any valid CSS color, controls `background-color` of the code. By default, calculated based on the color scheme. */
     color?: MantineColor;
-    /** If set code will be rendered inside `pre`, `false` by default */
+    /** If set, code is rendered in `pre` */
     block?: boolean;
 }
 export type CodeFactory = Factory<{

package/lib/components/Collapse/Collapse.d.ts

@@ -4,12 +4,14 @@ export interface CollapseProps extends BoxProps, Omit<React.ComponentPropsWithou
     in: boolean;
     /** Called each time transition ends */
     onTransitionEnd?: () => void;
-    /** Transition duration in ms, `200` by default */
+    /** Transition duration in ms @default `200` */
     transitionDuration?: number;
-    /** Transition timing function, default value is `ease` */
+    /** Transition timing function @default `ease` */
     transitionTimingFunction?: string;
-    /** Determines whether opacity should be animated, `true` by default */
+    /** Determines whether opacity should be animated @default `true` */
     animateOpacity?: boolean;
+    /** Keep element in DOM when collapsed, useful for nested collapses */
+    keepMounted?: boolean;
 }
 export type CollapseFactory = Factory<{
     props: CollapseProps;

package/lib/components/Collapse/use-collapse.d.ts

@@ -10,6 +10,7 @@ interface UseCollapse {
     transitionDuration?: number;
     transitionTimingFunction?: string;
     onTransitionEnd?: () => void;
+    keepMounted?: boolean;
 }
 interface GetCollapseProps {
     [key: string]: unknown;
@@ -18,5 +19,5 @@ interface GetCollapseProps {
     refKey?: string;
     ref?: React.ForwardedRef<HTMLDivElement>;
 }
-export declare function useCollapse({ transitionDuration, transitionTimingFunction, onTransitionEnd, opened, }: UseCollapse): (props: GetCollapseProps) => Record<string, any>;
+export declare function useCollapse({ transitionDuration, transitionTimingFunction, onTransitionEnd, opened, keepMounted, }: UseCollapse): (props: GetCollapseProps) => Record<string, any>;
 export {};

package/lib/components/ColorInput/ColorInput.d.ts

@@ -8,19 +8,19 @@ export type ColorInputCssVariables = {
     colorPreview: '--ci-preview-size';
 };
 export interface ColorInputProps extends BoxProps, __BaseInputProps, __ColorPickerProps, StylesApiProps<ColorInputFactory>, ElementProps<'input', 'size' | 'onChange' | 'value' | 'defaultValue'> {
-    /** If input is not allowed, the user can only pick value with color picker and swatches, `false` by default */
+    /** If input is not allowed, the user can only pick value with color picker and swatches */
     disallowInput?: boolean;
-    /** Determines whether the input value should be reset to the last known valid value when the input loses focus, `true` by default */
+    /** If set, the input value resets to the last known valid value when the input loses focus @default `true` */
     fixOnBlur?: boolean;
     /** Props passed down to the `Popover` component */
     popoverProps?: PopoverProps;
-    /** Determines whether the preview color swatch should be displayed in the left section of the input, `true` by default */
+    /** If set, the preview color swatch is displayed in the left section of the input @default `true` */
     withPreview?: boolean;
-    /** Determines whether eye dropper button should be displayed in the right section, `true` by default */
+    /** If set, the eye dropper button is displayed in the right section @default `true` */
     withEyeDropper?: boolean;
     /** An icon to replace the default eye dropper icon */
     eyeDropperIcon?: React.ReactNode;
-    /** Determines whether the dropdown should be closed when one of the color swatches is clicked, `false` by default */
+    /** If set, the dropdown is closed when one of the color swatches is clicked @default `false` */
     closeOnColorSwatchClick?: boolean;
     /** Props passed down to the eye dropper button */
     eyeDropperButtonProps?: Record<string, any>;

package/lib/components/ColorPicker/ColorPicker.d.ts

@@ -11,30 +11,30 @@ export interface __ColorPickerProps {
     defaultValue?: string;
     /** Called when value changes */
     onChange?: (value: string) => void;
-    /** Called when the user stops dragging one of the sliders or changes the value with arrow keys */
+    /** Called when the user stops dragging one of the sliders or changes the value with keyboard */
     onChangeEnd?: (value: string) => void;
-    /** Color format, `'hex'` by default */
+    /** Color format @default `'hex'` */
     format?: ColorFormat;
-    /** Determines whether the color picker should be displayed, `true` by default */
+    /** Determines whether the color picker should be displayed @default `true` */
     withPicker?: boolean;
-    /** An array of colors in one of the supported formats. Used to render swatches list below the color picker. */
+    /** A list of colors used to display swatches list below the color picker */
     swatches?: string[];
-    /** Number of swatches per row, `7` by default */
+    /** Number of swatches per row @default `7` */
     swatchesPerRow?: number;
-    /** Controls size of hue, alpha and saturation sliders, `'md'` by default */
+    /** Controls size of hue, alpha and saturation sliders @default `'md'` */
     size?: MantineSize | (string & {});
 }
 export interface ColorPickerProps extends BoxProps, __ColorPickerProps, StylesApiProps<ColorPickerFactory>, ElementProps<'div', 'onChange' | 'value' | 'defaultValue'> {
     __staticSelector?: string;
-    /** Determines whether the component should take 100% width of its container, `false` by default */
+    /** If set, the component takes 100% width of its container @default `false` */
     fullWidth?: boolean;
-    /** Determines whether interactive elements (sliders thumbs and swatches) should be focusable, `true` by default */
+    /** If set, interactive elements (sliders thumbs and swatches) are focusable with keyboard @default `true` */
     focusable?: boolean;
-    /** Saturation slider `aria-label` prop */
+    /** Saturation slider `aria-label` */
     saturationLabel?: string;
-    /** Hue slider `aria-label` prop */
+    /** Hue slider `aria-label` */
     hueLabel?: string;
-    /** Alpha slider `aria-label` prop */
+    /** Alpha slider `aria-label` */
     alphaLabel?: string;
     /** Called when one of the color swatches is clicked */
     onColorSwatchClick?: (color: string) => void;

package/lib/components/ColorSwatch/ColorSwatch.d.ts

@@ -4,15 +4,15 @@ export type ColorSwatchCssVariables = {
     root: '--cs-radius' | '--cs-size';
 };
 export interface ColorSwatchProps extends BoxProps, StylesApiProps<ColorSwatchFactory> {
-    /** Color to display, not related to `theme.colors` – supports only CSS color values */
+    /** Valid CSS color to display */
     color: string;
-    /** Controls `width` and `height` of the swatch, any valid CSS value, numbers are converted to rem */
+    /** Controls `width` and `height` of the swatch, any valid CSS value, numbers are converted to rem. @default `28` */
     size?: React.CSSProperties['width'];
-    /** Key of `theme.radius` or any valid CSS value to set `border-radius`, numbers are converted to rem */
+    /** Key of `theme.radius` or any valid CSS value to set `border-radius`, numbers are converted to rem. @default `1000` */
     radius?: MantineRadius;
-    /** Determines whether the swatch should have inner `box-shadow`, `true` by default */
+    /** Determines whether the swatch should have inner `box-shadow` @default `true` */
     withShadow?: boolean;
-    /** Content rendered inside the swatch */
+    /** Content displayed inside the swatch */
     children?: React.ReactNode;
 }
 export type ColorSwatchFactory = PolymorphicFactory<{

package/lib/components/Combobox/Combobox.d.ts

@@ -26,15 +26,15 @@ export interface ComboboxProps extends __PopoverProps, StylesApiProps<ComboboxFa
     children?: React.ReactNode;
     /** Combobox store, can be used to control combobox state */
     store?: ComboboxStore;
-    /** Called when item is selected with `Enter` key or by clicking it */
+    /** Called when item is selected with the `Enter` key or by clicking it */
     onOptionSubmit?: (value: string, optionProps: ComboboxOptionProps) => void;
-    /** Controls items `font-size` and `padding`, `'sm'` by default */
+    /** Controls items `font-size` and `padding` @default `'sm'` */
     size?: MantineSize | (string & {});
-    /** Controls `padding` of the dropdown, `4` by default */
+    /** Controls `padding` of the dropdown @default `4` */
     dropdownPadding?: React.CSSProperties['padding'];
-    /** Determines whether selection should be reset when option is hovered, `false` by default */
+    /** Determines whether selection should be reset when option is hovered @default `false` */
     resetSelectionOnOptionHover?: boolean;
-    /** Determines whether Combobox value can be changed */
+    /** Determines whether the `Combobox` value can be changed */
     readOnly?: boolean;
 }
 export type ComboboxFactory = Factory<{

package/lib/components/Combobox/Combobox.types.d.ts

@@ -30,7 +30,7 @@ export interface ComboboxLikeProps {
     onDropdownOpen?: () => void;
     /** Called when dropdown closes */
     onDropdownClose?: () => void;
-    /** Determines whether the first option should be selected when value changes, `false` by default */
+    /** If set, the first option is selected when value changes, `false` by default */
     selectFirstOptionOnChange?: boolean;
     /** Called when option is submitted from dropdown with mouse click or `Enter` key */
     onOptionSubmit?: (value: string) => void;

package/lib/components/Combobox/ComboboxEventsTarget/ComboboxEventsTarget.d.ts

@@ -2,17 +2,17 @@ import { Factory } from '../../../core';
 export interface ComboboxEventsTargetProps {
     /** Target element */
     children: React.ReactNode;
-    /** Key of the prop that should be used to access element ref */
+    /** Key of the prop is used to access element ref */
     refProp?: string;
-    /** Determines whether component should respond to keyboard events, `true` by default */
+    /** If set, the component responds to the keyboard events @default `true` */
     withKeyboardNavigation?: boolean;
-    /** Determines whether the target should have `aria-` attributes, `true` by default */
+    /** If set, the target has `aria-` attributes @default `true` */
     withAriaAttributes?: boolean;
-    /** Determines whether the target should have `aria-expanded` attribute, `false` by default */
+    /** If set, the target has `aria-expanded` attribute @default `false` */
     withExpandedAttribute?: boolean;
     /** Determines which events should be handled by the target element.
      * `button` target type handles `Space` and `Enter` keys to toggle dropdown opened state.
-     * `input` by default.
+     * @default `input`
      * */
     targetType?: 'button' | 'input';
     /** Input autocomplete attribute */

package/lib/components/Combobox/ComboboxHiddenInput/ComboboxHiddenInput.d.ts

@@ -1,7 +1,7 @@
 export interface ComboboxHiddenInputProps extends Omit<React.ComponentPropsWithoutRef<'input'>, 'value'> {
     /** Input value */
     value: string | string[] | null;
-    /** Divider character that is used to transform array values to string, `','` by default */
+    /** Divider character to join array values into string @default `','` */
     valuesDivider?: string;
 }
 export declare function ComboboxHiddenInput({ value, valuesDivider, ...others }: ComboboxHiddenInputProps): import("react/jsx-runtime").JSX.Element;

package/lib/components/Combobox/ComboboxOption/ComboboxOption.d.ts

@@ -3,11 +3,11 @@ export type ComboboxOptionStylesNames = 'option';
 export interface ComboboxOptionProps extends BoxProps, CompoundStylesApiProps<ComboboxOptionFactory>, ElementProps<'div'> {
     /** Option value */
     value: string;
-    /** Determines whether the option is selected */
+    /** Current active state */
     active?: boolean;
-    /** Determines whether the option can be selected */
+    /** Disabled state */
     disabled?: boolean;
-    /** Determines whether item is selected, useful for virtualized comboboxes */
+    /** Current selected state */
     selected?: boolean;
 }
 export type ComboboxOptionFactory = Factory<{

package/lib/components/Combobox/ComboboxOptions/ComboboxOptions.d.ts

@@ -1,7 +1,7 @@
 import { BoxProps, CompoundStylesApiProps, ElementProps, Factory } from '../../../core';
 export type ComboboxOptionsStylesNames = 'options';
 export interface ComboboxOptionsProps extends BoxProps, CompoundStylesApiProps<ComboboxOptionsFactory>, ElementProps<'div'> {
-    /** Id of the element that should label the options list */
+    /** Id of the element that labels the options list */
     labelledBy?: string;
 }
 export type ComboboxOptionsFactory = Factory<{

package/lib/components/Combobox/ComboboxSearch/ComboboxSearch.d.ts

@@ -2,9 +2,9 @@ import { ElementProps, Factory } from '../../../core';
 import { InputProps, InputStylesNames } from '../../Input/Input';
 export type ComboboxSearchStylesNames = InputStylesNames;
 export interface ComboboxSearchProps extends InputProps, ElementProps<'input', 'size'> {
-    /** Determines whether the search input should have `aria-` attribute, `true` by default */
+    /** if set, the search input has `aria-` attribute @default `true` */
     withAriaAttributes?: boolean;
-    /** Determines whether the search input should handle keyboard navigation, `true` by default */
+    /** if set, the search input handles keyboard navigation @default `true` */
     withKeyboardNavigation?: boolean;
 }
 export type ComboboxSearchFactory = Factory<{

package/lib/components/Combobox/ComboboxTarget/ComboboxTarget.d.ts

@@ -2,17 +2,17 @@ import { Factory } from '../../../core';
 export interface ComboboxTargetProps {
     /** Target element */
     children: React.ReactNode;
-    /** Key of the prop that should be used to access element ref */
+    /** Key of the prop that is used to access element ref */
     refProp?: string;
-    /** Determines whether component should respond to keyboard events, `true` by default */
+    /** If set, the component responds to keyboard events @default `true` */
     withKeyboardNavigation?: boolean;
-    /** Determines whether the target should have `aria-` attributes, `true` by default */
+    /** If set, the target has `aria-` attributes @default `true` */
     withAriaAttributes?: boolean;
-    /** Determines whether the target should have `aria-expanded` attribute, `false` by default */
+    /** If set, the target has `aria-expanded` attribute @default `false` */
     withExpandedAttribute?: boolean;
-    /** Determines which events should be handled by the target element.
+    /** Determines which events is handled by the target element.
      * `button` target type handles `Space` and `Enter` keys to toggle dropdown opened state.
-     * `input` by default.
+     * @default `input`
      * */
     targetType?: 'button' | 'input';
     /** Input autocomplete attribute */

package/lib/components/Combobox/use-combobox-target-props/use-combobox-target-props.d.ts

@@ -9,7 +9,7 @@ interface UseComboboxTargetPropsInput {
 export declare function useComboboxTargetProps({ onKeyDown, withKeyboardNavigation, withAriaAttributes, withExpandedAttribute, targetType, autoComplete, }: UseComboboxTargetPropsInput): {
     onKeyDown: (event: React.KeyboardEvent<HTMLInputElement>) => void;
     'aria-haspopup': "listbox";
-    'aria-expanded': true | undefined;
+    'aria-expanded': boolean | undefined;
     'aria-controls': string | undefined;
     'aria-activedescendant': string | undefined;
     autoComplete: string | undefined;

package/lib/components/Container/Container.d.ts

@@ -4,10 +4,12 @@ export type ContainerCssVariables = {
     root: '--container-size';
 };
 export interface ContainerProps extends BoxProps, StylesApiProps<ContainerFactory>, ElementProps<'div'> {
-    /** Sets `max-width` of the container, value is not responsive – it is the same for all screen sizes. Numbers are converted to rem. Ignored when `fluid` prop is set. `'md'` by default */
+    /** `max-width` of the container, value is not responsive – it is the same for all screen sizes. Numbers are converted to rem. Ignored when `fluid` prop is set. @default `'md'` */
     size?: MantineSize | (string & {}) | number;
-    /** Determines whether the container should take 100% of its parent width. If set, `size` prop is ignored. `false` by default. */
+    /** If set, the container takes 100% width of its parent and `size` prop is ignored. @default `false` */
     fluid?: boolean;
+    /** Centering strategy @default `'block'` */
+    strategy?: 'block' | 'grid';
 }
 export type ContainerFactory = Factory<{
     props: ContainerProps;

package/lib/components/CopyButton/CopyButton.d.ts

@@ -4,9 +4,9 @@ export interface CopyButtonProps {
         copied: boolean;
         copy: () => void;
     }) => React.ReactNode;
-    /** Value that will be copied to the clipboard when the button is clicked */
+    /** Value that is copied to the clipboard when the button is clicked */
     value: string;
-    /** Copied status timeout in ms, `1000` by default */
+    /** Copied status timeout in ms @default `1000` */
     timeout?: number;
 }
 export declare function CopyButton(props: CopyButtonProps): import("react/jsx-runtime").JSX.Element;

package/lib/components/Dialog/Dialog.d.ts

@@ -7,9 +7,9 @@ export type DialogCssVariables = {
     root: '--dialog-size';
 };
 export interface DialogProps extends BoxProps, AffixBaseProps, PaperBaseProps, StylesApiProps<DialogFactory>, ElementProps<'div'> {
-    /** If set dialog will not be unmounted from the DOM when it is hidden, display: none styles will be added instead */
+    /** If set, dialog is not unmounted from the DOM when hidden, `display: none` styles are applied instead */
     keepMounted?: boolean;
-    /** Determines whether the close button should be displayed, `true` by default */
+    /** If set, the close button is displayed @default `true` */
     withCloseButton?: boolean;
     /** Called when the close button is clicked */
     onClose?: () => void;
@@ -17,9 +17,9 @@ export interface DialogProps extends BoxProps, AffixBaseProps, PaperBaseProps, S
     children?: React.ReactNode;
     /** Opened state */
     opened: boolean;
-    /** Overrides default transition, `{ transition: 'pop-top-right', duration: 200 }` by default */
+    /** Props passed down to the underlying `Transition` component @default `{ transition: 'pop-top-right', duration: 200 }` */
     transitionProps?: TransitionOverride;
-    /** Controls `width` of the dialog, `'md'` by default */
+    /** Controls `width` of the dialog @default `'md'` */
     size?: MantineSize | (string & {}) | number;
 }
 export type DialogFactory = Factory<{

package/lib/components/Divider/Divider.d.ts

@@ -7,13 +7,13 @@ export type DividerCssVariables = {
 export interface DividerProps extends BoxProps, StylesApiProps<DividerFactory>, ElementProps<'div'> {
     /** Key of `theme.colors` or any valid CSS color value, by default value depends on color scheme */
     color?: MantineColor;
-    /** Controls width/height (depends on orientation), `'xs'` by default */
+    /** Controls width/height (depends on orientation) @default `'xs'` */
     size?: MantineSize | number | (string & {});
     /** Divider label, visible only when `orientation` is `horizontal` */
     label?: React.ReactNode;
-    /** Controls label position, `'center'` by default */
+    /** Controls label position @default `'center'` */
     labelPosition?: 'left' | 'center' | 'right';
-    /** Controls orientation, `'horizontal'` by default */
+    /** Controls orientation @default `'horizontal'` */
     orientation?: 'horizontal' | 'vertical';
 }
 export type DividerFactory = Factory<{

package/lib/components/Drawer/Drawer.d.ts

@@ -13,13 +13,13 @@ export type DrawerCssVariables = DrawerRootCssVariables;
 export interface DrawerProps extends DrawerRootProps {
     /** Drawer title */
     title?: React.ReactNode;
-    /** Determines whether the overlay should be rendered, `true` by default */
+    /** If set, the overlay is displayed @default `true` */
     withOverlay?: boolean;
     /** Props passed down to the `Overlay` component, can be used to configure opacity, `background-color`, styles and other properties */
     overlayProps?: ModalBaseOverlayProps;
     /** Drawer content */
     children?: React.ReactNode;
-    /** Determines whether the close button should be rendered, `true` by default */
+    /** If set, the close button is displayed @default `true` */
     withCloseButton?: boolean;
     /** Props passed down to the close button */
     closeButtonProps?: ModalBaseCloseButtonProps;

package/lib/components/Drawer/DrawerRoot.d.ts

@@ -7,13 +7,13 @@ export type DrawerRootCssVariables = {
     root: '--drawer-size' | '--drawer-flex' | '--drawer-height' | '--drawer-align' | '--drawer-justify' | '--drawer-offset';
 };
 export interface DrawerRootProps extends StylesApiProps<DrawerRootFactory>, ModalBaseProps {
-    /** Scroll area component, native `div` element by default */
+    /** Scroll area component @default `'div'` */
     scrollAreaComponent?: ScrollAreaComponent;
-    /** Side of the screen on which drawer will be opened, `'left'` by default */
+    /** Side of the screen on which drawer will be opened @default `'left'` */
     position?: DrawerPosition;
-    /** Key of `theme.radius` or any valid CSS value to set `border-radius`, numbers are converted to rem, `0` by default */
+    /** Key of `theme.radius` or any valid CSS value to set `border-radius`, numbers are converted to rem @default `0` */
     radius?: MantineRadius;
-    /** Drawer container offset from the viewport end, `0` by default */
+    /** Drawer container offset from the viewport end @default `0` */
     offset?: number | string;
 }
 export type DrawerRootFactory = Factory<{

package/lib/components/Fieldset/Fieldset.d.ts

@@ -7,7 +7,7 @@ export type FieldsetCSSVariables = {
 export interface FieldsetProps extends BoxProps, StylesApiProps<FieldsetFactory>, ElementProps<'fieldset'> {
     /** Fieldset legend */
     legend?: React.ReactNode;
-    /** Key of `theme.radius` or any valid CSS value to set `border-radius`, `theme.defaultRadius` by default */
+    /** Key of `theme.radius` or any valid CSS value to set `border-radius` @default `theme.defaultRadius` */
     radius?: MantineRadius;
 }
 export type FieldsetFactory = Factory<{

package/lib/components/FileButton/FileButton.d.ts

@@ -5,7 +5,7 @@ export interface FileButtonProps<Multiple extends boolean = false> {
     children: (props: {
         onClick: () => void;
     }) => React.ReactNode;
-    /** Determines whether user can pick more than one file */
+    /** If set, user can pick more than one file */
     multiple?: Multiple;
     /** File input accept attribute, for example, `"image/png,image/jpeg"` */
     accept?: string;

package/lib/components/FileInput/FileInput.d.ts

@@ -8,7 +8,7 @@ export interface FileInputProps<Multiple = false> extends BoxProps, __BaseInputP
     value?: Multiple extends true ? File[] : File | null;
     /** Uncontrolled component default value */
     defaultValue?: Multiple extends true ? File[] : File | null;
-    /** Determines whether user can pick more than one file, `false` by default */
+    /** If set, user can pick more than one file @default `false` */
     multiple?: Multiple;
     /** File input accept attribute, for example, `"image/png,image/jpeg"` */
     accept?: string;
@@ -16,11 +16,11 @@ export interface FileInputProps<Multiple = false> extends BoxProps, __BaseInputP
     name?: string;
     /** Input form attribute */
     form?: string;
-    /** Value renderer. By default, file name is displayed. */
+    /** Value renderer. By default, displays file name. */
     valueComponent?: React.FC<{
         value: null | File | File[];
     }>;
-    /** Determines whether clear button should be displayed in the right section, `false` by default */
+    /** If set, the clear button is displayed in the right section @default `false` */
     clearable?: boolean;
     /** Props passed down to the clear button */
     clearButtonProps?: React.ComponentPropsWithoutRef<'button'>;

package/lib/components/FloatingIndicator/FloatingIndicator.d.ts

@@ -4,13 +4,15 @@ export type FloatingIndicatorCssVariables = {
     root: '--transition-duration';
 };
 export interface FloatingIndicatorProps extends BoxProps, StylesApiProps<FloatingIndicatorFactory>, ElementProps<'div'> {
-    /** Target element over which indicator should be displayed */
+    /** Target element over which indicator is displayed */
     target: HTMLElement | null | undefined;
-    /** Parent element with relative position based on which indicator position should be calculated */
+    /** Parent element with relative position based on which indicator position is calculated */
     parent: HTMLElement | null | undefined;
-    /** Transition duration in ms, `150` by default */
+    /** Transition duration in ms @default `150` */
     transitionDuration?: number | string;
-    /** Determines whether indicator should be displayed after transition ends, should be set if used inside a container that has `transform: scale(n)` styles */
+    /** If set, the indicator is displayed after transition ends.
+     * Should be set if the component is used inside a container that has `transform: scale(n)` styles.
+     * */
     displayAfterTransitionEnd?: boolean;
 }
 export type FloatingIndicatorFactory = Factory<{

package/lib/components/FocusTrap/FocusTrap.d.ts

@@ -1,11 +1,11 @@
 export interface FocusTrapProps {
-    /** Element at which focus should be trapped, should support ref prop */
+    /** Element to trap focus at, must support ref prop */
     children: any;
-    /** Determines whether focus should be trapped within child element */
+    /** If set to `false`, disables focus trap */
     active?: boolean;
-    /** Prop that should be used to access component ref */
+    /** Prop that is used to access element ref @default `'ref'` */
     refProp?: string;
-    /** Assigns element `ref` */
+    /** Ref to combine with the focus trap ref */
     innerRef?: React.ForwardedRef<any>;
 }
 export declare function FocusTrap({ children, active, refProp, innerRef, }: FocusTrapProps): React.ReactElement;