@gridui/popover 1.1.7 → 1.1.8

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.
package/README.md CHANGED
@@ -8,3 +8,5 @@ Load styles for any composed dependency used by this family. Applications own ro
8
8
  See [component ownership](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/docs/component-ownership.md) and [release history](https://github.com/sudo-ui/GridUI-React-Monorepo/tree/main/packages-core/popover/.changeset/history).
9
9
 
10
10
  Surface motion uses `@gridui/overlay`; load `@gridui/overlay/styles.css` after Theme and before this family.
11
+
12
+ [Component reference](docs/reference/README.md) contains focused API pages for each public component.
package/docs/catalog.json CHANGED
@@ -1,12 +1,18 @@
1
1
  {
2
2
  "schemaVersion": 1,
3
3
  "name": "@gridui/popover",
4
- "version": "1.1.7",
4
+ "version": "1.1.8",
5
5
  "category": "core",
6
6
  "description": "GridUI React popover",
7
7
  "usage": "Surface motion uses `@gridui/overlay`; load `@gridui/overlay/styles.css` after Theme and before this family.",
8
8
  "documentation": [
9
- "README.md"
9
+ "README.md",
10
+ "docs/reference/README.md",
11
+ "docs/reference/popover-anchor.md",
12
+ "docs/reference/popover-close.md",
13
+ "docs/reference/popover-panel.md",
14
+ "docs/reference/popover-trigger.md",
15
+ "docs/reference/popover.md"
10
16
  ],
11
17
  "exports": [
12
18
  {
@@ -67,6 +73,8 @@
67
73
  "@gridui/popover/styles.css"
68
74
  ],
69
75
  "examples": [
76
+ "https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/popover/stories/contextual-panels.mdx",
77
+ "https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/popover/stories/hover-panels.mdx",
70
78
  "https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/popover/stories/popover.stories.tsx"
71
79
  ]
72
80
  }
@@ -0,0 +1,8 @@
1
+ <!-- Generated by pnpm docs:storybook. -->
2
+ # Component reference
3
+
4
+ - [Popover](popover.md)
5
+ - [PopoverAnchor](popover-anchor.md)
6
+ - [PopoverClose](popover-close.md)
7
+ - [PopoverPanel](popover-panel.md)
8
+ - [PopoverTrigger](popover-trigger.md)
@@ -0,0 +1,63 @@
1
+ <!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
2
+ # PopoverAnchor
3
+
4
+ Public PopoverAnchor component from @gridui/popover. See the package guide for its composition contract.
5
+
6
+ Import from ``@gridui/popover`` and load Theme before this family's stylesheet.
7
+
8
+ ```tsx
9
+ import { PopoverAnchor } from "@gridui/popover";
10
+ import "@gridui/theme/styles.css";
11
+ import "@gridui/popover/styles.css";
12
+ ```
13
+
14
+ Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/popover/README.md) for shared behavior and stylesheet dependencies.
15
+
16
+ ## API
17
+
18
+ The public Props type is the source of these signatures. Defaults below are explicit implementation defaults; story presets are separate. Native attributes remain available through the exported Props type.
19
+
20
+ ### children
21
+
22
+ ``ReactNode`` · Optional
23
+
24
+ Content rendered inside the component.
25
+
26
+ ### onFocus
27
+
28
+ ``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
29
+
30
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
31
+
32
+ ### onBlur
33
+
34
+ ``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
35
+
36
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
37
+
38
+ ### onChange
39
+
40
+ ``(event: ChangeEvent<HTMLDivElement, Element>): void`` · Optional
41
+
42
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
43
+
44
+ ### onSubmit
45
+
46
+ ``(event: SubmitEvent<HTMLDivElement>): void`` · Optional
47
+
48
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
49
+
50
+ ### onClick
51
+
52
+ ``(event: MouseEvent<HTMLDivElement, MouseEvent>): void`` · Optional
53
+
54
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
55
+
56
+ ### asChild
57
+
58
+ ``boolean | undefined`` · Optional
59
+
60
+ ### virtualRef
61
+
62
+ ``RefObject<Measurable | null> | undefined`` · Optional
63
+
@@ -0,0 +1,61 @@
1
+ <!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
2
+ # PopoverClose
3
+
4
+ Compose PopoverClose with Popover inside the same @gridui/popover component family.
5
+
6
+ Import from ``@gridui/popover`` and load Theme before this family's stylesheet.
7
+
8
+ ```tsx
9
+ import { PopoverClose } from "@gridui/popover";
10
+ import "@gridui/theme/styles.css";
11
+ import "@gridui/popover/styles.css";
12
+ ```
13
+
14
+ Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/popover/README.md) for shared behavior and stylesheet dependencies.
15
+
16
+ The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/popover/stories/popover.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
17
+
18
+ ## API
19
+
20
+ The public Props type is the source of these signatures. Defaults below are explicit implementation defaults; story presets are separate. Native attributes remain available through the exported Props type.
21
+
22
+ ### children
23
+
24
+ ``ReactNode`` · Optional
25
+
26
+ Content rendered inside the component.
27
+
28
+ ### onFocus
29
+
30
+ ``(event: FocusEvent<HTMLButtonElement, Element>): void`` · Optional
31
+
32
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
33
+
34
+ ### onBlur
35
+
36
+ ``(event: FocusEvent<HTMLButtonElement, Element>): void`` · Optional
37
+
38
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
39
+
40
+ ### onChange
41
+
42
+ ``(event: ChangeEvent<HTMLButtonElement, Element>): void`` · Optional
43
+
44
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
45
+
46
+ ### onSubmit
47
+
48
+ ``(event: SubmitEvent<HTMLButtonElement>): void`` · Optional
49
+
50
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
51
+
52
+ ### onClick
53
+
54
+ ``(event: MouseEvent<HTMLButtonElement, MouseEvent>): void`` · Optional
55
+
56
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
57
+
58
+ ### asChild
59
+
60
+ ``boolean | undefined`` · Optional
61
+
@@ -0,0 +1,169 @@
1
+ <!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
2
+ # PopoverPanel
3
+
4
+ Compose PopoverPanel with Popover inside the same @gridui/popover component family.
5
+
6
+ Import from ``@gridui/popover`` and load Theme before this family's stylesheet.
7
+
8
+ ```tsx
9
+ import { PopoverPanel } from "@gridui/popover";
10
+ import "@gridui/theme/styles.css";
11
+ import "@gridui/popover/styles.css";
12
+ ```
13
+
14
+ Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/popover/README.md) for shared behavior and stylesheet dependencies.
15
+
16
+ The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/popover/stories/popover.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
17
+
18
+ ## API
19
+
20
+ The public Props type is the source of these signatures. Defaults below are explicit implementation defaults; story presets are separate. Native attributes remain available through the exported Props type.
21
+
22
+ ### forceMount
23
+
24
+ ``true | undefined`` · Optional
25
+
26
+ Used to force mounting when more control is needed. Useful when
27
+ controlling animation with React animation libraries.
28
+
29
+ ### children
30
+
31
+ ``ReactNode`` · Optional
32
+
33
+ Content rendered inside the component.
34
+
35
+ ### onFocus
36
+
37
+ ``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
38
+
39
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
40
+
41
+ ### onBlur
42
+
43
+ ``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
44
+
45
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
46
+
47
+ ### onChange
48
+
49
+ ``(event: ChangeEvent<HTMLDivElement, Element>): void`` · Optional
50
+
51
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
52
+
53
+ ### onSubmit
54
+
55
+ ``(event: SubmitEvent<HTMLDivElement>): void`` · Optional
56
+
57
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
58
+
59
+ ### onClick
60
+
61
+ ``(event: MouseEvent<HTMLDivElement, MouseEvent>): void`` · Optional
62
+
63
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
64
+
65
+ ### asChild
66
+
67
+ ``boolean | undefined`` · Optional
68
+
69
+ ### deferPointerDownOutside
70
+
71
+ ``boolean | undefined`` · Optional
72
+
73
+ When `true`, a `'pointerdown'` event outside of the layered element will
74
+ wait for the interaction's click event before dispatching, allowing
75
+ third-party code to stop propagation of later events and cancel dismissal.
76
+
77
+ ### onEscapeKeyDown
78
+
79
+ ``(event: KeyboardEvent): void`` · Optional
80
+
81
+ Event handler called when the escape key is down.
82
+ Can be prevented.
83
+
84
+ ### onPointerDownOutside
85
+
86
+ ``(event: CustomEvent<{ originalEvent: PointerEvent; }>): void`` · Optional
87
+
88
+ Event handler called when the a `pointerdown` event happens outside of the `DismissableLayer`.
89
+ Can be prevented.
90
+
91
+ ### onFocusOutside
92
+
93
+ ``(event: CustomEvent<{ originalEvent: FocusEvent; }>): void`` · Optional
94
+
95
+ Event handler called when the focus moves outside of the `DismissableLayer`.
96
+ Can be prevented.
97
+
98
+ ### onInteractOutside
99
+
100
+ ``(event: CustomEvent<{ originalEvent: PointerEvent; }> | CustomEvent<{ originalEvent: FocusEvent; }>): void`` · Optional
101
+
102
+ Event handler called when an interaction happens outside the `DismissableLayer`.
103
+ Specifically, when a `pointerdown` event happens outside or focus moves outside of it.
104
+ Can be prevented.
105
+
106
+ ### onOpenAutoFocus
107
+
108
+ ``(event: Event): void`` · Optional
109
+
110
+ Event handler called when auto-focusing on open.
111
+ Can be prevented.
112
+
113
+ ### onCloseAutoFocus
114
+
115
+ ``(event: Event): void`` · Optional
116
+
117
+ Event handler called when auto-focusing on close.
118
+ Can be prevented.
119
+
120
+ ### side
121
+
122
+ ``"left" | "right" | "top" | "bottom" | undefined`` · Optional
123
+
124
+ ### sideOffset
125
+
126
+ ``number | undefined`` · Optional
127
+
128
+ Default: ``8``
129
+
130
+ ### align
131
+
132
+ ``"center" | "start" | "end" | undefined`` · Optional
133
+
134
+ Default: ``"start"``
135
+
136
+ ### alignOffset
137
+
138
+ ``number | undefined`` · Optional
139
+
140
+ ### arrowPadding
141
+
142
+ ``number | undefined`` · Optional
143
+
144
+ ### avoidCollisions
145
+
146
+ ``boolean | undefined`` · Optional
147
+
148
+ ### collisionBoundary
149
+
150
+ ``(Element | null) | (Element | null)[] | undefined`` · Optional
151
+
152
+ ### collisionPadding
153
+
154
+ ``number | Partial<Record<"left" | "right" | "top" | "bottom", number>> | undefined`` · Optional
155
+
156
+ Default: ``16``
157
+
158
+ ### sticky
159
+
160
+ ``("partial" | "always") | undefined`` · Optional
161
+
162
+ ### hideWhenDetached
163
+
164
+ ``boolean | undefined`` · Optional
165
+
166
+ ### updatePositionStrategy
167
+
168
+ ``("always" | "optimized") | undefined`` · Optional
169
+
@@ -0,0 +1,101 @@
1
+ <!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
2
+ # PopoverTrigger
3
+
4
+ Compose PopoverTrigger with Popover inside the same @gridui/popover component family.
5
+
6
+ Import from ``@gridui/popover`` and load Theme before this family's stylesheet.
7
+
8
+ ```tsx
9
+ import { PopoverTrigger } from "@gridui/popover";
10
+ import "@gridui/theme/styles.css";
11
+ import "@gridui/popover/styles.css";
12
+ ```
13
+
14
+ Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/popover/README.md) for shared behavior and stylesheet dependencies.
15
+
16
+ The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/popover/stories/popover.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
17
+
18
+ ## API
19
+
20
+ The public Props type is the source of these signatures. Defaults below are explicit implementation defaults; story presets are separate. Native attributes remain available through the exported Props type.
21
+
22
+ ### children
23
+
24
+ ``ReactNode`` · Optional
25
+
26
+ Content rendered inside the component.
27
+
28
+ ### onFocus
29
+
30
+ ``(event: FocusEvent<HTMLButtonElement, Element>): void`` · Optional
31
+
32
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
33
+
34
+ ### onBlur
35
+
36
+ ``(event: FocusEvent<HTMLButtonElement, Element>): void`` · Optional
37
+
38
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
39
+
40
+ ### onChange
41
+
42
+ ``(event: ChangeEvent<HTMLButtonElement, Element>): void`` · Optional
43
+
44
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
45
+
46
+ ### onSubmit
47
+
48
+ ``(event: SubmitEvent<HTMLButtonElement>): void`` · Optional
49
+
50
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
51
+
52
+ ### onClick
53
+
54
+ ``(event: MouseEvent<HTMLButtonElement, MouseEvent>): void`` · Optional
55
+
56
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
57
+
58
+ ### size
59
+
60
+ ``"small" | "standard" | "large" | "extra-large" | null | undefined`` · Optional
61
+
62
+ Default: ``"small"``
63
+
64
+ Component size preset.
65
+
66
+ ### iconMotion
67
+
68
+ ``"none" | "outward" | null | undefined`` · Optional
69
+
70
+ ### variant
71
+
72
+ ``"text" | "primary" | "secondary" | "quiet" | "highlight" | "underlined" | null | undefined`` · Optional
73
+
74
+ Visual variant.
75
+
76
+ ### layout
77
+
78
+ ``"cell" | "standard" | "icon" | "entry" | "rail" | "divided" | null | undefined`` · Optional
79
+
80
+ Layout within the containing region.
81
+
82
+ ### startIcon
83
+
84
+ ``ReactNode`` · Optional
85
+
86
+ ### startIconLayout
87
+
88
+ ``"divided" | "inline" | undefined`` · Optional
89
+
90
+ ### startIconSize
91
+
92
+ ``"standard" | "large" | "extra-large" | undefined`` · Optional
93
+
94
+ ### endIcon
95
+
96
+ ``ReactNode`` · Optional
97
+
98
+ ### loading
99
+
100
+ ``boolean | undefined`` · Optional
101
+
@@ -0,0 +1,57 @@
1
+ <!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
2
+ # Popover
3
+
4
+ Anchors an interactive surface to a trigger. Use it for contextual controls or details that do not require a modal dialog.
5
+
6
+ Import from ``@gridui/popover`` and load Theme before this family's stylesheet.
7
+
8
+ ```tsx
9
+ import { Popover } from "@gridui/popover";
10
+ import "@gridui/theme/styles.css";
11
+ import "@gridui/popover/styles.css";
12
+ ```
13
+
14
+ Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/popover/README.md) for shared behavior and stylesheet dependencies.
15
+
16
+ The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/popover/stories/popover.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
17
+
18
+ ## API
19
+
20
+ The public Props type is the source of these signatures. Defaults below are explicit implementation defaults; story presets are separate. Native attributes remain available through the exported Props type.
21
+
22
+ ### children
23
+
24
+ ``ReactNode`` · Optional
25
+
26
+ Content rendered inside the component.
27
+
28
+ ### open
29
+
30
+ ``boolean | undefined`` · Optional
31
+
32
+ Controlled visibility. Pair with onOpenChange.
33
+
34
+ ### defaultOpen
35
+
36
+ ``boolean | undefined`` · Optional
37
+
38
+ Default: ``false``
39
+
40
+ Initial uncontrolled visibility. Reset the story after changing it.
41
+
42
+ ### onOpenChange
43
+
44
+ ``(open: boolean): void`` · Optional
45
+
46
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
47
+
48
+ ### modal
49
+
50
+ ``boolean | undefined`` · Optional
51
+
52
+ ### hoverEnabled
53
+
54
+ ``boolean | undefined`` · Optional
55
+
56
+ Default: ``true``
57
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gridui/popover",
3
- "version": "1.1.7",
3
+ "version": "1.1.8",
4
4
  "description": "GridUI React popover",
5
5
  "license": "UNLICENSED",
6
6
  "type": "module",
@@ -27,9 +27,9 @@
27
27
  "react-dom": "^19.2.0"
28
28
  },
29
29
  "dependencies": {
30
- "@gridui/button": "^4.0.0",
30
+ "@gridui/button": "^4.1.0",
31
31
  "@gridui/overlay": "^2.0.0",
32
- "@gridui/style-utils": "^3.0.0",
32
+ "@gridui/style-utils": "^4.0.0",
33
33
  "@gridui/theme": "^2.5.3",
34
34
  "@radix-ui/react-popover": "1.3.1",
35
35
  "class-variance-authority": "0.7.1"