@gridui/dropdown-menu 1.2.0 → 2.0.1

package/docs/reference/context-menu.md

@@ -0,0 +1,179 @@
+<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
+# ContextMenu
+
+Shows contextual actions at a requested position. Use it for item-specific actions invoked by a context-menu gesture or an explicit trigger.
+
+Import from ``@gridui/dropdown-menu`` and load Theme before this family's stylesheet.
+
+```tsx
+import { ContextMenu } from "@gridui/dropdown-menu";
+import "@gridui/theme/styles.css";
+import "@gridui/dropdown-menu/styles.css";
+```
+
+Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/dropdown-menu/README.md) for shared behavior and stylesheet dependencies.
+
+The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/dropdown-menu/stories/context-menu.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
+
+## API
+
+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.
+
+### onFocus
+
+``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onBlur
+
+``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onChange
+
+``(event: ChangeEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onSubmit
+
+``(event: SubmitEvent<HTMLDivElement>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onClick
+
+``(event: MouseEvent<HTMLDivElement, MouseEvent>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### asChild
+
+``boolean | undefined`` · Optional
+
+### onEscapeKeyDown
+
+``(event: KeyboardEvent): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onPointerDownOutside
+
+``(event: CustomEvent<{ originalEvent: PointerEvent; }>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onFocusOutside
+
+``(event: CustomEvent<{ originalEvent: FocusEvent; }>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onInteractOutside
+
+``(event: CustomEvent<{ originalEvent: PointerEvent; }> | CustomEvent<{ originalEvent: FocusEvent; }>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onCloseAutoFocus
+
+``(event: Event): void`` · Optional
+
+Event handler called when auto-focusing on close.
+Can be prevented.
+
+### forceMount
+
+``true | undefined`` · Optional
+
+Used to force mounting when more control is needed. Useful when
+controlling animation with React animation libraries.
+
+### loop
+
+``boolean | undefined`` · Optional
+
+Whether keyboard navigation should loop around
+
+### side
+
+``"left" | "right" | "top" | "bottom" | undefined`` · Optional
+
+### sideOffset
+
+``number | undefined`` · Optional
+
+### align
+
+``"center" | "start" | "end" | undefined`` · Optional
+
+### alignOffset
+
+``number | undefined`` · Optional
+
+### arrowPadding
+
+``number | undefined`` · Optional
+
+### avoidCollisions
+
+``boolean | undefined`` · Optional
+
+### collisionBoundary
+
+``(Element | null) | (Element | null)[] | undefined`` · Optional
+
+### collisionPadding
+
+``number | Partial<Record<"left" | "right" | "top" | "bottom", number>> | undefined`` · Optional
+
+### sticky
+
+``("partial" | "always") | undefined`` · Optional
+
+### hideWhenDetached
+
+``boolean | undefined`` · Optional
+
+### updatePositionStrategy
+
+``("always" | "optimized") | undefined`` · Optional
+
+### morph
+
+``boolean | undefined`` · Optional
+
+### respectReducedMotion
+
+``boolean | undefined`` · Optional
+
+### dir
+
+``("ltr" | "rtl") | undefined`` · Optional
+
+### x
+
+``number`` · Required
+
+### y
+
+``number`` · Required
+
+### label
+
+``string`` · Required
+
+### children
+
+``ReactNode`` · Required
+
+Content rendered inside the component.
+
+### onClose
+
+``(): void`` · Required
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+

package/docs/reference/dropdown-menu-content.md

@@ -0,0 +1,165 @@
+<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
+# DropdownMenuContent
+
+Compose DropdownMenuContent with DropdownMenu inside the same @gridui/dropdown-menu component family.
+
+Import from ``@gridui/dropdown-menu`` and load Theme before this family's stylesheet.
+
+```tsx
+import { DropdownMenuContent } from "@gridui/dropdown-menu";
+import "@gridui/theme/styles.css";
+import "@gridui/dropdown-menu/styles.css";
+```
+
+Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/dropdown-menu/README.md) for shared behavior and stylesheet dependencies.
+
+The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/dropdown-menu/stories/dropdown-menu.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
+
+## API
+
+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.
+
+### children
+
+``ReactNode`` · Optional
+
+Content rendered inside the component.
+
+### onFocus
+
+``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onBlur
+
+``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onChange
+
+``(event: ChangeEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onSubmit
+
+``(event: SubmitEvent<HTMLDivElement>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onClick
+
+``(event: MouseEvent<HTMLDivElement, MouseEvent>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### asChild
+
+``boolean | undefined`` · Optional
+
+### onEscapeKeyDown
+
+``(event: KeyboardEvent): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onPointerDownOutside
+
+``(event: CustomEvent<{ originalEvent: PointerEvent; }>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onFocusOutside
+
+``(event: CustomEvent<{ originalEvent: FocusEvent; }>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onInteractOutside
+
+``(event: CustomEvent<{ originalEvent: PointerEvent; }> | CustomEvent<{ originalEvent: FocusEvent; }>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onCloseAutoFocus
+
+``(event: Event): void`` · Optional
+
+Event handler called when auto-focusing on close.
+Can be prevented.
+
+### forceMount
+
+``true | undefined`` · Optional
+
+Used to force mounting when more control is needed. Useful when
+controlling animation with React animation libraries.
+
+### loop
+
+``boolean | undefined`` · Optional
+
+Whether keyboard navigation should loop around
+
+### side
+
+``"left" | "right" | "top" | "bottom" | undefined`` · Optional
+
+### sideOffset
+
+``number | undefined`` · Optional
+
+Default: ``8``
+
+### align
+
+``"center" | "start" | "end" | undefined`` · Optional
+
+Default: ``"end"``
+
+### alignOffset
+
+``number | undefined`` · Optional
+
+### arrowPadding
+
+``number | undefined`` · Optional
+
+### avoidCollisions
+
+``boolean | undefined`` · Optional
+
+### collisionBoundary
+
+``(Element | null) | (Element | null)[] | undefined`` · Optional
+
+### collisionPadding
+
+``number | Partial<Record<"left" | "right" | "top" | "bottom", number>> | undefined`` · Optional
+
+### sticky
+
+``("partial" | "always") | undefined`` · Optional
+
+### hideWhenDetached
+
+``boolean | undefined`` · Optional
+
+### updatePositionStrategy
+
+``("always" | "optimized") | undefined`` · Optional
+
+### morph
+
+``boolean | undefined`` · Optional
+
+Default: ``false``
+
+### respectReducedMotion
+
+``boolean | undefined`` · Optional
+
+Default: ``true``
+

package/docs/reference/dropdown-menu-item.md

@@ -0,0 +1,77 @@
+<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
+# DropdownMenuItem
+
+Compose DropdownMenuItem with ContextMenu inside the same @gridui/dropdown-menu component family.
+
+Import from ``@gridui/dropdown-menu`` and load Theme before this family's stylesheet.
+
+```tsx
+import { DropdownMenuItem } from "@gridui/dropdown-menu";
+import "@gridui/theme/styles.css";
+import "@gridui/dropdown-menu/styles.css";
+```
+
+Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/dropdown-menu/README.md) for shared behavior and stylesheet dependencies.
+
+The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/dropdown-menu/stories/context-menu.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
+
+## API
+
+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.
+
+### children
+
+``ReactNode`` · Optional
+
+Content rendered inside the component.
+
+### onFocus
+
+``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onBlur
+
+``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onChange
+
+``(event: ChangeEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onSubmit
+
+``(event: SubmitEvent<HTMLDivElement>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onClick
+
+``(event: MouseEvent<HTMLDivElement, MouseEvent>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onSelect
+
+``(event: Event): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### asChild
+
+``boolean | undefined`` · Optional
+
+### disabled
+
+``boolean | undefined`` · Optional
+
+Prevents interaction when enabled.
+
+### textValue
+
+``string | undefined`` · Optional
+

package/docs/reference/dropdown-menu-label.md

@@ -0,0 +1,61 @@
+<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
+# DropdownMenuLabel
+
+Compose DropdownMenuLabel with DropdownMenu inside the same @gridui/dropdown-menu component family.
+
+Import from ``@gridui/dropdown-menu`` and load Theme before this family's stylesheet.
+
+```tsx
+import { DropdownMenuLabel } from "@gridui/dropdown-menu";
+import "@gridui/theme/styles.css";
+import "@gridui/dropdown-menu/styles.css";
+```
+
+Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/dropdown-menu/README.md) for shared behavior and stylesheet dependencies.
+
+The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/dropdown-menu/stories/dropdown-menu.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
+
+## API
+
+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.
+
+### children
+
+``ReactNode`` · Optional
+
+Content rendered inside the component.
+
+### onFocus
+
+``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onBlur
+
+``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onChange
+
+``(event: ChangeEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onSubmit
+
+``(event: SubmitEvent<HTMLDivElement>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onClick
+
+``(event: MouseEvent<HTMLDivElement, MouseEvent>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### asChild
+
+``boolean | undefined`` · Optional
+

package/docs/reference/dropdown-menu-radio-group.md

@@ -0,0 +1,73 @@
+<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
+# DropdownMenuRadioGroup
+
+Compose DropdownMenuRadioGroup with DropdownMenu inside the same @gridui/dropdown-menu component family.
+
+Import from ``@gridui/dropdown-menu`` and load Theme before this family's stylesheet.
+
+```tsx
+import { DropdownMenuRadioGroup } from "@gridui/dropdown-menu";
+import "@gridui/theme/styles.css";
+import "@gridui/dropdown-menu/styles.css";
+```
+
+Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/dropdown-menu/README.md) for shared behavior and stylesheet dependencies.
+
+The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/dropdown-menu/stories/dropdown-menu.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
+
+## API
+
+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.
+
+### children
+
+``ReactNode`` · Optional
+
+Content rendered inside the component.
+
+### onFocus
+
+``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onBlur
+
+``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onChange
+
+``(event: ChangeEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onSubmit
+
+``(event: SubmitEvent<HTMLDivElement>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onClick
+
+``(event: MouseEvent<HTMLDivElement, MouseEvent>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### asChild
+
+``boolean | undefined`` · Optional
+
+### value
+
+``string | undefined`` · Optional
+
+Controlled value. Pair with the corresponding change callback.
+
+### onValueChange
+
+``(value: string): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+

package/docs/reference/dropdown-menu-radio-item.md

@@ -0,0 +1,83 @@
+<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
+# DropdownMenuRadioItem
+
+Compose DropdownMenuRadioItem with DropdownMenu inside the same @gridui/dropdown-menu component family.
+
+Import from ``@gridui/dropdown-menu`` and load Theme before this family's stylesheet.
+
+```tsx
+import { DropdownMenuRadioItem } from "@gridui/dropdown-menu";
+import "@gridui/theme/styles.css";
+import "@gridui/dropdown-menu/styles.css";
+```
+
+Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/dropdown-menu/README.md) for shared behavior and stylesheet dependencies.
+
+The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/dropdown-menu/stories/dropdown-menu.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
+
+## API
+
+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.
+
+### children
+
+``ReactNode`` · Optional
+
+Content rendered inside the component.
+
+### onFocus
+
+``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onBlur
+
+``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onChange
+
+``(event: ChangeEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onSubmit
+
+``(event: SubmitEvent<HTMLDivElement>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onClick
+
+``(event: MouseEvent<HTMLDivElement, MouseEvent>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onSelect
+
+``(event: Event): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### asChild
+
+``boolean | undefined`` · Optional
+
+### disabled
+
+``boolean | undefined`` · Optional
+
+Prevents interaction when enabled.
+
+### value
+
+``string`` · Required
+
+Controlled value. Pair with the corresponding change callback.
+
+### textValue
+
+``string | undefined`` · Optional
+

package/docs/reference/dropdown-menu-trigger.md

@@ -0,0 +1,61 @@
+<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
+# DropdownMenuTrigger
+
+Compose DropdownMenuTrigger with DropdownMenu inside the same @gridui/dropdown-menu component family.
+
+Import from ``@gridui/dropdown-menu`` and load Theme before this family's stylesheet.
+
+```tsx
+import { DropdownMenuTrigger } from "@gridui/dropdown-menu";
+import "@gridui/theme/styles.css";
+import "@gridui/dropdown-menu/styles.css";
+```
+
+Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/dropdown-menu/README.md) for shared behavior and stylesheet dependencies.
+
+The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/dropdown-menu/stories/dropdown-menu.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
+
+## API
+
+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.
+
+### children
+
+``ReactNode`` · Optional
+
+Content rendered inside the component.
+
+### onFocus
+
+``(event: FocusEvent<HTMLButtonElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onBlur
+
+``(event: FocusEvent<HTMLButtonElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onChange
+
+``(event: ChangeEvent<HTMLButtonElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onSubmit
+
+``(event: SubmitEvent<HTMLButtonElement>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onClick
+
+``(event: MouseEvent<HTMLButtonElement, MouseEvent>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### asChild
+
+``boolean | undefined`` · Optional
+