@vertigis/react-ui 16.2.0 → 16.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -12,13 +12,21 @@ export interface IconMenuClasses {
12
12
  }
13
13
  export type IconMenuClassKey = keyof IconMenuClasses;
14
14
  export interface IconMenuProps extends BoxProps {
15
- /** Additional CSS classes to be applied to the component. */
15
+ /**
16
+ * Additional CSS classes to be applied to the component.
17
+ */
16
18
  classes?: Partial<IconMenuClasses>;
17
- /** Whether the icon button should be disabled. */
19
+ /**
20
+ * Whether the icon button should be disabled.
21
+ */
18
22
  disabled?: boolean;
19
- /** The icon to show. */
23
+ /**
24
+ * The icon to show.
25
+ */
20
26
  icon: ReactNode;
21
- /** A ref for the menu element */
27
+ /**
28
+ * A ref for the menu element
29
+ */
22
30
  menuRef?: React.MutableRefObject<HTMLDivElement>;
23
31
  /**
24
32
  * A 'virtual anchor' that can be provided to override the default behavior.
@@ -26,9 +34,13 @@ export interface IconMenuProps extends BoxProps {
26
34
  * open.
27
35
  */
28
36
  virtualAnchor?: DOMRect;
29
- /** Attributes applied to the `IconButton` component. */
37
+ /**
38
+ * Attributes applied to the `IconButton` component.
39
+ */
30
40
  IconButtonProps?: Partial<IconButtonProps>;
31
- /** Attributes applied to the `Menu` component. */
41
+ /**
42
+ * Attributes applied to the `Menu` component.
43
+ */
32
44
  MenuProps?: Partial<MenuProps>;
33
45
  }
34
46
  declare const IconMenu: import("react").ForwardRefExoticComponent<Omit<IconMenuProps, "ref"> & import("react").RefAttributes<HTMLDivElement>>;
@@ -1,11 +1,17 @@
1
1
  import { type AlertProps } from "@mui/material";
2
2
  import type { FC } from "react";
3
3
  import type { SnackbarProps } from "../Snackbar";
4
- /** Properties for the Notification component. */
4
+ /**
5
+ * Properties for the Notification component.
6
+ */
5
7
  export interface NotificationProperties extends SnackbarProps {
6
- /** The title for the close button. */
8
+ /**
9
+ * The title for the close button.
10
+ */
7
11
  closeButtonTitle: string;
8
- /** Optional alert properties. */
12
+ /**
13
+ * Optional alert properties.
14
+ */
9
15
  alertProps?: AlertProps;
10
16
  }
11
17
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vertigis/react-ui",
3
- "version": "16.2.0",
3
+ "version": "16.2.1",
4
4
  "description": "Utilities and React components used in VertiGIS applications.",
5
5
  "keywords": [
6
6
  "vertigis",
@@ -158,7 +158,9 @@ const defaultDenseOptions = {
158
158
  },
159
159
  },
160
160
  };
161
- /** Common style overrides for both Select and NativeSelect. */
161
+ /**
162
+ * Common style overrides for both Select and NativeSelect.
163
+ */
162
164
  const getSelectStyles = (theme) => ({
163
165
  borderRadius: theme.shape.borderRadius,
164
166
  "&:focus": {
@@ -172,7 +174,9 @@ const getFocusHighlightStyles = ({ palette }) => ({
172
174
  0 0 0 3px ${palette.common.white} inset,
173
175
  0 0 0 5px ${palette.grey[600]} inset`,
174
176
  });
175
- /** Common style overrides for both MenuItem and ListItemButton. */
177
+ /**
178
+ * Common style overrides for both MenuItem and ListItemButton.
179
+ */
176
180
  const getMenuItemStyles = ({ palette, transitions }) => ({
177
181
  overflow: "hidden",
178
182
  "&:hover": {
@@ -1089,7 +1093,9 @@ export default createTheme;
1089
1093
  export function overrideTheme(theme, overrides) {
1090
1094
  return deepAssign({}, theme, overrides);
1091
1095
  }
1092
- /** A recursive version of Object.assign(). */
1096
+ /**
1097
+ * A recursive version of Object.assign().
1098
+ */
1093
1099
  function deepAssign(target, ...sources) {
1094
1100
  if (target === null || target === undefined) {
1095
1101
  throw new TypeError("Cannot convert undefined or null to object.");