@muraldevkit/ui-toolkit 4.47.2 → 4.47.4

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.
@@ -55,7 +55,6 @@ export interface MrlAvatarButtonPropTypes extends MrlAvatarPropTypes, React.HTML
55
55
  }
56
56
  /**
57
57
  * Renders an avatar button
58
- *
59
58
  * @param {MrlAvatarButtonPropTypes} props the props for your MrlAvatarButton
60
59
  * @returns {React.ReactElement} an avatar button containing the props you pass
61
60
  */
@@ -19,7 +19,6 @@ export interface MrlBadgeProps extends Omit<MrlComponentProps, 'style' | 'attrs'
19
19
  /**
20
20
  * Badges are a common user interface element that
21
21
  * can be used to draw attention to content.
22
- *
23
22
  * @param props - component props
24
23
  * @returns a MrlBadge React component.
25
24
  */
@@ -18,7 +18,6 @@ export interface MrlBadgeNotificationProps extends Omit<MrlComponentProps, 'styl
18
18
  /**
19
19
  * Badge notifications are a common user interface element that can be used to
20
20
  * draw attention to new or unread content, alerts, or updates.
21
- *
22
21
  * @param props - component props
23
22
  * @returns a MrlBadgeNotification React component.
24
23
  */
@@ -1,7 +1,6 @@
1
1
  /// <reference types="react" />
2
2
  /**
3
3
  * MrlBreadcrumbSeparator component.
4
- *
5
4
  * @returns The MrlBreadcrumbSeparator component.
6
5
  */
7
6
  export declare function MrlBreadcrumbSeparator(): JSX.Element;
@@ -22,7 +22,6 @@ export interface MrlBreadcrumbsProps extends React.ComponentPropsWithRef<'nav'>
22
22
  }
23
23
  /**
24
24
  * MrlBreadcrumbs component.
25
- *
26
25
  * @param props The MrlBreadcrumbs component properties.
27
26
  * @returns The MrlBreadcrumbs component.
28
27
  */
@@ -1,7 +1,6 @@
1
1
  import { GroupBase, StylesConfig } from 'react-select';
2
2
  /**
3
3
  * MrlSelect styles object for the default kind
4
- *
5
4
  * @returns a styles object
6
5
  */
7
6
  export declare function defaultStyles<T, IsMulti extends boolean = false, Group extends GroupBase<T> = GroupBase<T>>(): StylesConfig<T, IsMulti, Group>;
@@ -17,7 +17,6 @@ export interface MrlMenuProps {
17
17
  * Private closeParent prop for use with MrlMenuItem
18
18
  *
19
19
  * !!! Please do not use this prop directly, it is only used internally by MrlMenuItem !!!
20
- *
21
20
  * @private
22
21
  */
23
22
  closeParent?: () => void;
@@ -32,7 +31,6 @@ export interface MrlMenuProps {
32
31
  disableArrowOpen?: boolean;
33
32
  /**
34
33
  * Disable flipping of the menu when it goes off the screen
35
- *
36
34
  * @default false
37
35
  */
38
36
  disableFlipping?: boolean;
@@ -43,7 +41,6 @@ export interface MrlMenuProps {
43
41
  * Removes the following styles:
44
42
  * - padding on the menu
45
43
  * - drop shadow and border
46
- *
47
44
  * @default false
48
45
  */
49
46
  isInternal?: boolean;
@@ -51,20 +48,17 @@ export interface MrlMenuProps {
51
48
  * Private isSubMenu prop for use with MrlMenuItem
52
49
  *
53
50
  * !!! Please do not use this prop directly, it is only used internally by MrlMenuItem !!!
54
- *
55
51
  * @private
56
52
  */
57
53
  isSubMenu?: boolean;
58
54
  /**
59
55
  * spacing of menu
60
56
  * - compact has less padding
61
- *
62
57
  * @default 'default'
63
58
  */
64
59
  spacing?: 'default' | 'compact';
65
60
  /**
66
61
  * Offset of the menu from the trigger element in pixels
67
- *
68
62
  * @default 10px
69
63
  */
70
64
  menuOffset?: number;
@@ -77,13 +71,11 @@ export interface MrlMenuProps {
77
71
  * - position 'left', 'right', 'top', 'bottom' position relative to the trigger
78
72
  * - position 'static' renders the menu in place, not using the portal
79
73
  * - position 'ignore' will not position the menu, allowing you to use the customPosition prop to position the element
80
- *
81
74
  * @default 'bottom'
82
75
  */
83
76
  position?: MenuPosition;
84
77
  /**
85
78
  * Set initial state of menu
86
- *
87
79
  * @default { actionType: null, isOpen: false }
88
80
  */
89
81
  actionState?: ActionState;
@@ -96,7 +88,6 @@ export interface MrlMenuProps {
96
88
  *
97
89
  * In some instances we may want the trigger element to stop propogation to the
98
90
  * rest of the DOM. Use this flag to enable and disable it.
99
- *
100
91
  * @default false
101
92
  */
102
93
  triggerStopPropagation?: boolean;
@@ -111,7 +102,6 @@ export interface MrlMenuProps {
111
102
  alignment?: MenuAlignment;
112
103
  /**
113
104
  * Callback to be called when the menu is closed
114
- *
115
105
  * @param type - type of close event
116
106
  */
117
107
  onClose?: (type?: string) => void;
@@ -120,7 +110,6 @@ export interface MrlMenuProps {
120
110
  * MrlMenu component
121
111
  *
122
112
  * Renders a menu component with alignment relative to a trigger element
123
- *
124
113
  * @param {MrlMenuProps} props - The props for the MrlMenu component
125
114
  * @returns {Element} - rendered MrlMenu component
126
115
  */
@@ -12,6 +12,7 @@ type UseMrlPopoverEventHandlersOptions = {
12
12
  state: ActionState;
13
13
  setState: React.Dispatch<React.SetStateAction<ActionState>>;
14
14
  triggerRef: MrlPopoverProps['triggerRef'];
15
+ isTriggerDisabled: () => boolean;
15
16
  };
16
17
  type UseMrlPopoverEventHandlersReturn = {
17
18
  handleClose: (e: React.KeyboardEvent<HTMLButtonElement>) => void;
@@ -28,5 +29,5 @@ type UseMrlPopoverEventHandlersReturn = {
28
29
  * @param options configuration options
29
30
  * @returns all of the required event handlers
30
31
  */
31
- export declare const useMrlPopoverEventHandlers: ({ closeMenu, isSubMenu, disableFocusTrap, disableClickToOpen, hasCloseButton, interactiveElements, menuRef, state, setState, triggerRef }: UseMrlPopoverEventHandlersOptions) => UseMrlPopoverEventHandlersReturn;
32
+ export declare const useMrlPopoverEventHandlers: ({ closeMenu, isSubMenu, disableFocusTrap, disableClickToOpen, hasCloseButton, interactiveElements, menuRef, state, setState, triggerRef, isTriggerDisabled }: UseMrlPopoverEventHandlersOptions) => UseMrlPopoverEventHandlersReturn;
32
33
  export {};
@@ -13,6 +13,8 @@ interface PopoverWithTriggerProps {
13
13
  disableFocusTrap?: boolean;
14
14
  scrolling?: boolean;
15
15
  position?: MenuPosition;
16
+ disableTrigger?: boolean;
17
+ ariaDisabled?: boolean;
16
18
  }
17
19
  /**
18
20
  * Demo of a menu with a trigger for stories and testing
@@ -20,5 +22,5 @@ interface PopoverWithTriggerProps {
20
22
  * @param {PopoverWithTriggerProps} props - The props for the menu with trigger
21
23
  * @returns {Element} The menu with trigger demo
22
24
  */
23
- export declare const PopoverWithTrigger: ({ menuAlign, alignment, actionState, onClose, triggerAlignment, spacing, kind, point, hasCloseButton, disableFocusTrap, scrolling }: PopoverWithTriggerProps) => JSX.Element;
25
+ export declare const PopoverWithTrigger: ({ menuAlign, alignment, actionState, onClose, triggerAlignment, spacing, kind, point, hasCloseButton, disableFocusTrap, disableTrigger, scrolling, ariaDisabled }: PopoverWithTriggerProps) => JSX.Element;
24
26
  export {};