@huin-core/react-menu 1.0.2 → 1.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (7) hide show
  1. package/dist/index.d.mts +179 -0
  2. package/dist/index.d.ts +179 -0
  3. package/dist/index.js +901 -0
  4. package/dist/index.js.map +7 -0
  5. package/dist/index.mjs +869 -0
  6. package/dist/index.mjs.map +7 -0
  7. package/package.json +1 -1
package/dist/index.d.mts ADDED
@@ -0,0 +1,179 @@
1
+ import * as React from 'react';
2
+ import { DismissableLayer } from '@huin-core/react-dismissable-layer';
3
+ import { FocusScope } from '@huin-core/react-focus-scope';
4
+ import * as PopperPrimitive from '@huin-core/react-popper';
5
+ import { Portal as Portal$1 } from '@huin-core/react-portal';
6
+ import { Primitive } from '@huin-core/react-primitive';
7
+ import * as RovingFocusGroup from '@huin-core/react-roving-focus';
8
+
9
+ type Scope<C = any> = {
10
+ [scopeName: string]: React.Context<C>[];
11
+ } | undefined;
12
+ type ScopeHook = (scope: Scope) => {
13
+ [__scopeProp: string]: Scope;
14
+ };
15
+ interface CreateScope {
16
+ scopeName: string;
17
+ (): ScopeHook;
18
+ }
19
+
20
+ type Direction = 'ltr' | 'rtl';
21
+ declare const createMenuScope: CreateScope;
22
+ interface MenuProps {
23
+ children?: React.ReactNode;
24
+ open?: boolean;
25
+ onOpenChange?(open: boolean): void;
26
+ dir?: Direction;
27
+ modal?: boolean;
28
+ }
29
+ declare const Menu: React.FC<MenuProps>;
30
+ type PopperAnchorProps = React.ComponentPropsWithoutRef<typeof PopperPrimitive.Anchor>;
31
+ interface MenuAnchorProps extends PopperAnchorProps {
32
+ }
33
+ declare const MenuAnchor: React.ForwardRefExoticComponent<MenuAnchorProps & React.RefAttributes<HTMLDivElement>>;
34
+ type PortalProps = React.ComponentPropsWithoutRef<typeof Portal$1>;
35
+ interface MenuPortalProps {
36
+ children?: React.ReactNode;
37
+ /**
38
+ * Specify a container element to portal the content into.
39
+ */
40
+ container?: PortalProps['container'];
41
+ /**
42
+ * Used to force mounting when more control is needed. Useful when
43
+ * controlling animation with React animation libraries.
44
+ */
45
+ forceMount?: true;
46
+ }
47
+ declare const MenuPortal: React.FC<MenuPortalProps>;
48
+ /**
49
+ * We purposefully don't union MenuRootContent and MenuSubContent props here because
50
+ * they have conflicting prop types. We agreed that we would allow MenuSubContent to
51
+ * accept props that it would just ignore.
52
+ */
53
+ interface MenuContentProps extends MenuRootContentTypeProps {
54
+ /**
55
+ * Used to force mounting when more control is needed. Useful when
56
+ * controlling animation with React animation libraries.
57
+ */
58
+ forceMount?: true;
59
+ }
60
+ declare const MenuContent: React.ForwardRefExoticComponent<MenuContentProps & React.RefAttributes<HTMLDivElement>>;
61
+ interface MenuRootContentTypeProps extends Omit<MenuContentImplProps, keyof MenuContentImplPrivateProps> {
62
+ }
63
+ type FocusScopeProps = React.ComponentPropsWithoutRef<typeof FocusScope>;
64
+ type DismissableLayerProps = React.ComponentPropsWithoutRef<typeof DismissableLayer>;
65
+ type RovingFocusGroupProps = React.ComponentPropsWithoutRef<typeof RovingFocusGroup.Root>;
66
+ type PopperContentProps = React.ComponentPropsWithoutRef<typeof PopperPrimitive.Content>;
67
+ type MenuContentImplPrivateProps = {
68
+ onOpenAutoFocus?: FocusScopeProps['onMountAutoFocus'];
69
+ onDismiss?: DismissableLayerProps['onDismiss'];
70
+ disableOutsidePointerEvents?: DismissableLayerProps['disableOutsidePointerEvents'];
71
+ /**
72
+ * Whether scrolling outside the `MenuContent` should be prevented
73
+ * (default: `false`)
74
+ */
75
+ disableOutsideScroll?: boolean;
76
+ /**
77
+ * Whether focus should be trapped within the `MenuContent`
78
+ * (default: false)
79
+ */
80
+ trapFocus?: FocusScopeProps['trapped'];
81
+ };
82
+ interface MenuContentImplProps extends MenuContentImplPrivateProps, Omit<PopperContentProps, 'dir' | 'onPlaced'> {
83
+ /**
84
+ * Event handler called when auto-focusing on close.
85
+ * Can be prevented.
86
+ */
87
+ onCloseAutoFocus?: FocusScopeProps['onUnmountAutoFocus'];
88
+ /**
89
+ * Whether keyboard navigation should loop around
90
+ * @defaultValue false
91
+ */
92
+ loop?: RovingFocusGroupProps['loop'];
93
+ onEntryFocus?: RovingFocusGroupProps['onEntryFocus'];
94
+ onEscapeKeyDown?: DismissableLayerProps['onEscapeKeyDown'];
95
+ onPointerDownOutside?: DismissableLayerProps['onPointerDownOutside'];
96
+ onFocusOutside?: DismissableLayerProps['onFocusOutside'];
97
+ onInteractOutside?: DismissableLayerProps['onInteractOutside'];
98
+ }
99
+ type PrimitiveDivProps = React.ComponentPropsWithoutRef<typeof Primitive.div>;
100
+ interface MenuGroupProps extends PrimitiveDivProps {
101
+ }
102
+ declare const MenuGroup: React.ForwardRefExoticComponent<MenuGroupProps & React.RefAttributes<HTMLDivElement>>;
103
+ interface MenuLabelProps extends PrimitiveDivProps {
104
+ }
105
+ declare const MenuLabel: React.ForwardRefExoticComponent<MenuLabelProps & React.RefAttributes<HTMLDivElement>>;
106
+ interface MenuItemProps extends Omit<MenuItemImplProps, 'onSelect'> {
107
+ onSelect?: (event: Event) => void;
108
+ }
109
+ declare const MenuItem: React.ForwardRefExoticComponent<MenuItemProps & React.RefAttributes<HTMLDivElement>>;
110
+ interface MenuItemImplProps extends PrimitiveDivProps {
111
+ disabled?: boolean;
112
+ textValue?: string;
113
+ }
114
+ type CheckedState = boolean | 'indeterminate';
115
+ interface MenuCheckboxItemProps extends MenuItemProps {
116
+ checked?: CheckedState;
117
+ onCheckedChange?: (checked: boolean) => void;
118
+ }
119
+ declare const MenuCheckboxItem: React.ForwardRefExoticComponent<MenuCheckboxItemProps & React.RefAttributes<HTMLDivElement>>;
120
+ interface MenuRadioGroupProps extends MenuGroupProps {
121
+ value?: string;
122
+ onValueChange?: (value: string) => void;
123
+ }
124
+ declare const MenuRadioGroup: React.ForwardRefExoticComponent<MenuRadioGroupProps & React.RefAttributes<HTMLDivElement>>;
125
+ interface MenuRadioItemProps extends MenuItemProps {
126
+ value: string;
127
+ }
128
+ declare const MenuRadioItem: React.ForwardRefExoticComponent<MenuRadioItemProps & React.RefAttributes<HTMLDivElement>>;
129
+ type PrimitiveSpanProps = React.ComponentPropsWithoutRef<typeof Primitive.span>;
130
+ interface MenuItemIndicatorProps extends PrimitiveSpanProps {
131
+ /**
132
+ * Used to force mounting when more control is needed. Useful when
133
+ * controlling animation with React animation libraries.
134
+ */
135
+ forceMount?: true;
136
+ }
137
+ declare const MenuItemIndicator: React.ForwardRefExoticComponent<MenuItemIndicatorProps & React.RefAttributes<HTMLSpanElement>>;
138
+ interface MenuSeparatorProps extends PrimitiveDivProps {
139
+ }
140
+ declare const MenuSeparator: React.ForwardRefExoticComponent<MenuSeparatorProps & React.RefAttributes<HTMLDivElement>>;
141
+ type PopperArrowProps = React.ComponentPropsWithoutRef<typeof PopperPrimitive.Arrow>;
142
+ interface MenuArrowProps extends PopperArrowProps {
143
+ }
144
+ declare const MenuArrow: React.ForwardRefExoticComponent<MenuArrowProps & React.RefAttributes<SVGSVGElement>>;
145
+ interface MenuSubProps {
146
+ children?: React.ReactNode;
147
+ open?: boolean;
148
+ onOpenChange?(open: boolean): void;
149
+ }
150
+ declare const MenuSub: React.FC<MenuSubProps>;
151
+ interface MenuSubTriggerProps extends MenuItemImplProps {
152
+ }
153
+ declare const MenuSubTrigger: React.ForwardRefExoticComponent<MenuSubTriggerProps & React.RefAttributes<HTMLDivElement>>;
154
+ interface MenuSubContentProps extends Omit<MenuContentImplProps, keyof MenuContentImplPrivateProps | 'onCloseAutoFocus' | 'onEntryFocus' | 'side' | 'align'> {
155
+ /**
156
+ * Used to force mounting when more control is needed. Useful when
157
+ * controlling animation with React animation libraries.
158
+ */
159
+ forceMount?: true;
160
+ }
161
+ declare const MenuSubContent: React.ForwardRefExoticComponent<MenuSubContentProps & React.RefAttributes<HTMLDivElement>>;
162
+ declare const Root: React.FC<MenuProps>;
163
+ declare const Anchor: React.ForwardRefExoticComponent<MenuAnchorProps & React.RefAttributes<HTMLDivElement>>;
164
+ declare const Portal: React.FC<MenuPortalProps>;
165
+ declare const Content: React.ForwardRefExoticComponent<MenuContentProps & React.RefAttributes<HTMLDivElement>>;
166
+ declare const Group: React.ForwardRefExoticComponent<MenuGroupProps & React.RefAttributes<HTMLDivElement>>;
167
+ declare const Label: React.ForwardRefExoticComponent<MenuLabelProps & React.RefAttributes<HTMLDivElement>>;
168
+ declare const Item: React.ForwardRefExoticComponent<MenuItemProps & React.RefAttributes<HTMLDivElement>>;
169
+ declare const CheckboxItem: React.ForwardRefExoticComponent<MenuCheckboxItemProps & React.RefAttributes<HTMLDivElement>>;
170
+ declare const RadioGroup: React.ForwardRefExoticComponent<MenuRadioGroupProps & React.RefAttributes<HTMLDivElement>>;
171
+ declare const RadioItem: React.ForwardRefExoticComponent<MenuRadioItemProps & React.RefAttributes<HTMLDivElement>>;
172
+ declare const ItemIndicator: React.ForwardRefExoticComponent<MenuItemIndicatorProps & React.RefAttributes<HTMLSpanElement>>;
173
+ declare const Separator: React.ForwardRefExoticComponent<MenuSeparatorProps & React.RefAttributes<HTMLDivElement>>;
174
+ declare const Arrow: React.ForwardRefExoticComponent<MenuArrowProps & React.RefAttributes<SVGSVGElement>>;
175
+ declare const Sub: React.FC<MenuSubProps>;
176
+ declare const SubTrigger: React.ForwardRefExoticComponent<MenuSubTriggerProps & React.RefAttributes<HTMLDivElement>>;
177
+ declare const SubContent: React.ForwardRefExoticComponent<MenuSubContentProps & React.RefAttributes<HTMLDivElement>>;
178
+
179
+ export { Anchor, Arrow, CheckboxItem, Content, Group, Item, ItemIndicator, Label, Menu, MenuAnchor, type MenuAnchorProps, MenuArrow, type MenuArrowProps, MenuCheckboxItem, type MenuCheckboxItemProps, MenuContent, type MenuContentProps, MenuGroup, type MenuGroupProps, MenuItem, MenuItemIndicator, type MenuItemIndicatorProps, type MenuItemProps, MenuLabel, type MenuLabelProps, MenuPortal, type MenuPortalProps, type MenuProps, MenuRadioGroup, type MenuRadioGroupProps, MenuRadioItem, type MenuRadioItemProps, MenuSeparator, type MenuSeparatorProps, MenuSub, MenuSubContent, type MenuSubContentProps, type MenuSubProps, MenuSubTrigger, type MenuSubTriggerProps, Portal, RadioGroup, RadioItem, Root, Separator, Sub, SubContent, SubTrigger, createMenuScope };
package/dist/index.d.ts ADDED
@@ -0,0 +1,179 @@
1
+ import * as React from 'react';
2
+ import { DismissableLayer } from '@huin-core/react-dismissable-layer';
3
+ import { FocusScope } from '@huin-core/react-focus-scope';
4
+ import * as PopperPrimitive from '@huin-core/react-popper';
5
+ import { Portal as Portal$1 } from '@huin-core/react-portal';
6
+ import { Primitive } from '@huin-core/react-primitive';
7
+ import * as RovingFocusGroup from '@huin-core/react-roving-focus';
8
+
9
+ type Scope<C = any> = {
10
+ [scopeName: string]: React.Context<C>[];
11
+ } | undefined;
12
+ type ScopeHook = (scope: Scope) => {
13
+ [__scopeProp: string]: Scope;
14
+ };
15
+ interface CreateScope {
16
+ scopeName: string;
17
+ (): ScopeHook;
18
+ }
19
+
20
+ type Direction = 'ltr' | 'rtl';
21
+ declare const createMenuScope: CreateScope;
22
+ interface MenuProps {
23
+ children?: React.ReactNode;
24
+ open?: boolean;
25
+ onOpenChange?(open: boolean): void;
26
+ dir?: Direction;
27
+ modal?: boolean;
28
+ }
29
+ declare const Menu: React.FC<MenuProps>;
30
+ type PopperAnchorProps = React.ComponentPropsWithoutRef<typeof PopperPrimitive.Anchor>;
31
+ interface MenuAnchorProps extends PopperAnchorProps {
32
+ }
33
+ declare const MenuAnchor: React.ForwardRefExoticComponent<MenuAnchorProps & React.RefAttributes<HTMLDivElement>>;
34
+ type PortalProps = React.ComponentPropsWithoutRef<typeof Portal$1>;
35
+ interface MenuPortalProps {
36
+ children?: React.ReactNode;
37
+ /**
38
+ * Specify a container element to portal the content into.
39
+ */
40
+ container?: PortalProps['container'];
41
+ /**
42
+ * Used to force mounting when more control is needed. Useful when
43
+ * controlling animation with React animation libraries.
44
+ */
45
+ forceMount?: true;
46
+ }
47
+ declare const MenuPortal: React.FC<MenuPortalProps>;
48
+ /**
49
+ * We purposefully don't union MenuRootContent and MenuSubContent props here because
50
+ * they have conflicting prop types. We agreed that we would allow MenuSubContent to
51
+ * accept props that it would just ignore.
52
+ */
53
+ interface MenuContentProps extends MenuRootContentTypeProps {
54
+ /**
55
+ * Used to force mounting when more control is needed. Useful when
56
+ * controlling animation with React animation libraries.
57
+ */
58
+ forceMount?: true;
59
+ }
60
+ declare const MenuContent: React.ForwardRefExoticComponent<MenuContentProps & React.RefAttributes<HTMLDivElement>>;
61
+ interface MenuRootContentTypeProps extends Omit<MenuContentImplProps, keyof MenuContentImplPrivateProps> {
62
+ }
63
+ type FocusScopeProps = React.ComponentPropsWithoutRef<typeof FocusScope>;
64
+ type DismissableLayerProps = React.ComponentPropsWithoutRef<typeof DismissableLayer>;
65
+ type RovingFocusGroupProps = React.ComponentPropsWithoutRef<typeof RovingFocusGroup.Root>;
66
+ type PopperContentProps = React.ComponentPropsWithoutRef<typeof PopperPrimitive.Content>;
67
+ type MenuContentImplPrivateProps = {
68
+ onOpenAutoFocus?: FocusScopeProps['onMountAutoFocus'];
69
+ onDismiss?: DismissableLayerProps['onDismiss'];
70
+ disableOutsidePointerEvents?: DismissableLayerProps['disableOutsidePointerEvents'];
71
+ /**
72
+ * Whether scrolling outside the `MenuContent` should be prevented
73
+ * (default: `false`)
74
+ */
75
+ disableOutsideScroll?: boolean;
76
+ /**
77
+ * Whether focus should be trapped within the `MenuContent`
78
+ * (default: false)
79
+ */
80
+ trapFocus?: FocusScopeProps['trapped'];
81
+ };
82
+ interface MenuContentImplProps extends MenuContentImplPrivateProps, Omit<PopperContentProps, 'dir' | 'onPlaced'> {
83
+ /**
84
+ * Event handler called when auto-focusing on close.
85
+ * Can be prevented.
86
+ */
87
+ onCloseAutoFocus?: FocusScopeProps['onUnmountAutoFocus'];
88
+ /**
89
+ * Whether keyboard navigation should loop around
90
+ * @defaultValue false
91
+ */
92
+ loop?: RovingFocusGroupProps['loop'];
93
+ onEntryFocus?: RovingFocusGroupProps['onEntryFocus'];
94
+ onEscapeKeyDown?: DismissableLayerProps['onEscapeKeyDown'];
95
+ onPointerDownOutside?: DismissableLayerProps['onPointerDownOutside'];
96
+ onFocusOutside?: DismissableLayerProps['onFocusOutside'];
97
+ onInteractOutside?: DismissableLayerProps['onInteractOutside'];
98
+ }
99
+ type PrimitiveDivProps = React.ComponentPropsWithoutRef<typeof Primitive.div>;
100
+ interface MenuGroupProps extends PrimitiveDivProps {
101
+ }
102
+ declare const MenuGroup: React.ForwardRefExoticComponent<MenuGroupProps & React.RefAttributes<HTMLDivElement>>;
103
+ interface MenuLabelProps extends PrimitiveDivProps {
104
+ }
105
+ declare const MenuLabel: React.ForwardRefExoticComponent<MenuLabelProps & React.RefAttributes<HTMLDivElement>>;
106
+ interface MenuItemProps extends Omit<MenuItemImplProps, 'onSelect'> {
107
+ onSelect?: (event: Event) => void;
108
+ }
109
+ declare const MenuItem: React.ForwardRefExoticComponent<MenuItemProps & React.RefAttributes<HTMLDivElement>>;
110
+ interface MenuItemImplProps extends PrimitiveDivProps {
111
+ disabled?: boolean;
112
+ textValue?: string;
113
+ }
114
+ type CheckedState = boolean | 'indeterminate';
115
+ interface MenuCheckboxItemProps extends MenuItemProps {
116
+ checked?: CheckedState;
117
+ onCheckedChange?: (checked: boolean) => void;
118
+ }
119
+ declare const MenuCheckboxItem: React.ForwardRefExoticComponent<MenuCheckboxItemProps & React.RefAttributes<HTMLDivElement>>;
120
+ interface MenuRadioGroupProps extends MenuGroupProps {
121
+ value?: string;
122
+ onValueChange?: (value: string) => void;
123
+ }
124
+ declare const MenuRadioGroup: React.ForwardRefExoticComponent<MenuRadioGroupProps & React.RefAttributes<HTMLDivElement>>;
125
+ interface MenuRadioItemProps extends MenuItemProps {
126
+ value: string;
127
+ }
128
+ declare const MenuRadioItem: React.ForwardRefExoticComponent<MenuRadioItemProps & React.RefAttributes<HTMLDivElement>>;
129
+ type PrimitiveSpanProps = React.ComponentPropsWithoutRef<typeof Primitive.span>;
130
+ interface MenuItemIndicatorProps extends PrimitiveSpanProps {
131
+ /**
132
+ * Used to force mounting when more control is needed. Useful when
133
+ * controlling animation with React animation libraries.
134
+ */
135
+ forceMount?: true;
136
+ }
137
+ declare const MenuItemIndicator: React.ForwardRefExoticComponent<MenuItemIndicatorProps & React.RefAttributes<HTMLSpanElement>>;
138
+ interface MenuSeparatorProps extends PrimitiveDivProps {
139
+ }
140
+ declare const MenuSeparator: React.ForwardRefExoticComponent<MenuSeparatorProps & React.RefAttributes<HTMLDivElement>>;
141
+ type PopperArrowProps = React.ComponentPropsWithoutRef<typeof PopperPrimitive.Arrow>;
142
+ interface MenuArrowProps extends PopperArrowProps {
143
+ }
144
+ declare const MenuArrow: React.ForwardRefExoticComponent<MenuArrowProps & React.RefAttributes<SVGSVGElement>>;
145
+ interface MenuSubProps {
146
+ children?: React.ReactNode;
147
+ open?: boolean;
148
+ onOpenChange?(open: boolean): void;
149
+ }
150
+ declare const MenuSub: React.FC<MenuSubProps>;
151
+ interface MenuSubTriggerProps extends MenuItemImplProps {
152
+ }
153
+ declare const MenuSubTrigger: React.ForwardRefExoticComponent<MenuSubTriggerProps & React.RefAttributes<HTMLDivElement>>;
154
+ interface MenuSubContentProps extends Omit<MenuContentImplProps, keyof MenuContentImplPrivateProps | 'onCloseAutoFocus' | 'onEntryFocus' | 'side' | 'align'> {
155
+ /**
156
+ * Used to force mounting when more control is needed. Useful when
157
+ * controlling animation with React animation libraries.
158
+ */
159
+ forceMount?: true;
160
+ }
161
+ declare const MenuSubContent: React.ForwardRefExoticComponent<MenuSubContentProps & React.RefAttributes<HTMLDivElement>>;
162
+ declare const Root: React.FC<MenuProps>;
163
+ declare const Anchor: React.ForwardRefExoticComponent<MenuAnchorProps & React.RefAttributes<HTMLDivElement>>;
164
+ declare const Portal: React.FC<MenuPortalProps>;
165
+ declare const Content: React.ForwardRefExoticComponent<MenuContentProps & React.RefAttributes<HTMLDivElement>>;
166
+ declare const Group: React.ForwardRefExoticComponent<MenuGroupProps & React.RefAttributes<HTMLDivElement>>;
167
+ declare const Label: React.ForwardRefExoticComponent<MenuLabelProps & React.RefAttributes<HTMLDivElement>>;
168
+ declare const Item: React.ForwardRefExoticComponent<MenuItemProps & React.RefAttributes<HTMLDivElement>>;
169
+ declare const CheckboxItem: React.ForwardRefExoticComponent<MenuCheckboxItemProps & React.RefAttributes<HTMLDivElement>>;
170
+ declare const RadioGroup: React.ForwardRefExoticComponent<MenuRadioGroupProps & React.RefAttributes<HTMLDivElement>>;
171
+ declare const RadioItem: React.ForwardRefExoticComponent<MenuRadioItemProps & React.RefAttributes<HTMLDivElement>>;
172
+ declare const ItemIndicator: React.ForwardRefExoticComponent<MenuItemIndicatorProps & React.RefAttributes<HTMLSpanElement>>;
173
+ declare const Separator: React.ForwardRefExoticComponent<MenuSeparatorProps & React.RefAttributes<HTMLDivElement>>;
174
+ declare const Arrow: React.ForwardRefExoticComponent<MenuArrowProps & React.RefAttributes<SVGSVGElement>>;
175
+ declare const Sub: React.FC<MenuSubProps>;
176
+ declare const SubTrigger: React.ForwardRefExoticComponent<MenuSubTriggerProps & React.RefAttributes<HTMLDivElement>>;
177
+ declare const SubContent: React.ForwardRefExoticComponent<MenuSubContentProps & React.RefAttributes<HTMLDivElement>>;
178
+
179
+ export { Anchor, Arrow, CheckboxItem, Content, Group, Item, ItemIndicator, Label, Menu, MenuAnchor, type MenuAnchorProps, MenuArrow, type MenuArrowProps, MenuCheckboxItem, type MenuCheckboxItemProps, MenuContent, type MenuContentProps, MenuGroup, type MenuGroupProps, MenuItem, MenuItemIndicator, type MenuItemIndicatorProps, type MenuItemProps, MenuLabel, type MenuLabelProps, MenuPortal, type MenuPortalProps, type MenuProps, MenuRadioGroup, type MenuRadioGroupProps, MenuRadioItem, type MenuRadioItemProps, MenuSeparator, type MenuSeparatorProps, MenuSub, MenuSubContent, type MenuSubContentProps, type MenuSubProps, MenuSubTrigger, type MenuSubTriggerProps, Portal, RadioGroup, RadioItem, Root, Separator, Sub, SubContent, SubTrigger, createMenuScope };