@solid2-aria/components 0.0.0-stage → 0.0.1

package/dist/browser/menu.d.ts

@@ -0,0 +1,150 @@
+/*
+ * Copyright 2022 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+/*
+ * Derived from Adobe React Spectrum: packages/react-aria-components/src/Menu.tsx.
+ * Modified for Solid Aria: adapted collection ownership, contexts, accessibility primitives, and reactive properties for Solid 2; uses Solid class props and press responders for custom triggers.
+ * Licensed under Apache-2.0. See LICENSES/Apache-2.0.txt and NOTICE.txt at the repository root.
+ */
+import { ClassOrFunction, ContextValue, DOMRenderProps, PossibleLinkDOMRenderProps, Ref, RenderProps, SlotProps, StyleProps, StyleRenderProps } from "./utils.js";
+import { CollectionProps, ItemRenderProps, SectionProps as SectionProps$1 } from "./collection.js";
+import { JSX } from "@solidjs/web";
+import { LoadMoreSentinelProps } from "@solid2-aria/core/utils/create-load-more-sentinel";
+import { MenuTriggerProps as MenuTriggerProps$1, RootMenuTriggerState } from "@solid2-aria/stately/menu/create-menu-trigger-state";
+import { AriaMenuProps } from "@solid2-aria/core/menu/create-menu";
+import { TreeState } from "@solid2-aria/stately/tree/create-tree-state";
+import { FocusEvents, HoverEvents, Key, LinkDOMProps, MultipleSelection, PressEvents } from "@solid2-aria/types-shared";
+import { GlobalDOMAttributes } from "@solid2-aria/types-shared-web";
+export declare const MenuContext: import("solid-js").Context<ContextValue<MenuProps<unknown>, HTMLDivElement>>;
+export declare const MenuStateContext: import("solid-js").Context<TreeState<unknown> | null>;
+export declare const RootMenuTriggerStateContext: import("solid-js").Context<RootMenuTriggerState | null>;
+export interface MenuTriggerProps extends MenuTriggerProps$1 {
+  children: JSX.Element;
+}
+export interface SubmenuTriggerProps {
+  /**
+   * The contents of the SubmenuTrigger. The first child should be an Item (the trigger) and the
+   * second child should be the Popover (for the submenu).
+   */
+  children: JSX.Element[];
+  /**
+   * The delay time in milliseconds for the submenu to appear after hovering over the trigger.
+   *
+   * @default 200
+   */
+  delay?: number;
+}
+export interface MenuRenderProps {
+  /**
+   * Whether the menu has no items and should display its empty state.
+   *
+   * @selector [data-empty]
+   */
+  isEmpty: boolean;
+}
+export interface MenuProps<T> extends Omit<AriaMenuProps<T>, "children">, CollectionProps<T>, StyleRenderProps<MenuRenderProps>, SlotProps, GlobalDOMAttributes<HTMLDivElement> {
+  /**
+   * The CSS [class](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/class) for the
+   * element. A function may be provided to compute the class based on component state.
+   *
+   * @default 'react-aria-Menu'
+   */
+  class?: ClassOrFunction<MenuRenderProps>;
+  /** Provides content to display when there are no items in the menu. */
+  renderEmptyState?: () => JSX.Element;
+  /** Whether the menu should close when the menu item is selected. */
+  shouldCloseOnSelect?: boolean;
+}
+export interface MenuSectionProps<T> extends SectionProps$1<T>, Omit<MultipleSelection, "disabledKeys">, DOMRenderProps<"section", undefined> {
+  /**
+   * The CSS [class](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/class) for the
+   * element.
+   *
+   * @default 'react-aria-MenuSection'
+   */
+  class?: JSX.ClassValue;
+  /** Whether the menu should close when the menu item is selected. */
+  shouldCloseOnSelect?: boolean;
+}
+export interface MenuItemRenderProps extends ItemRenderProps {
+  /**
+   * Whether the item has a submenu.
+   *
+   * @selector [data-has-submenu]
+   */
+  hasSubmenu: boolean;
+  /**
+   * Whether the item's submenu is open.
+   *
+   * @selector [data-open]
+   */
+  isOpen: boolean;
+}
+export interface MenuItemProps<T = object> extends Omit<RenderProps<MenuItemRenderProps>, "render">, PossibleLinkDOMRenderProps<"div", MenuItemRenderProps>, LinkDOMProps, HoverEvents, FocusEvents, PressEvents, Omit<GlobalDOMAttributes<HTMLDivElement>, "onClick"> {
+  /**
+   * The CSS [class](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/class) for the
+   * element. A function may be provided to compute the class based on component state.
+   *
+   * @default 'react-aria-MenuItem'
+   */
+  class?: ClassOrFunction<MenuItemRenderProps>;
+  /** The unique id of the item. */
+  id?: Key;
+  /**
+   * The object value that this item represents. When using dynamic collections, this is set
+   * automatically.
+   */
+  value?: T;
+  /** A string representation of the item's contents, used for features like typeahead. */
+  textValue?: string;
+  /** An accessibility label for this item. */
+  "aria-label"?: string;
+  /** Whether the item is disabled. */
+  isDisabled?: boolean;
+  /** Handler that is called when the item is selected. */
+  onAction?: () => void;
+  /** Whether the menu should close when the menu item is selected. */
+  shouldCloseOnSelect?: boolean;
+}
+export interface MenuLoadMoreItemProps extends Omit<LoadMoreSentinelProps, "collection" | "direction">, StyleProps, DOMRenderProps<"div", undefined>, GlobalDOMAttributes<HTMLDivElement> {
+  /**
+   * The CSS [class](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/class) for the
+   * element.
+   *
+   * @default 'react-aria-MenuLoadingIndicator'
+   */
+  class?: JSX.ClassValue;
+  /**
+   * The load more spinner to render when loading additional items.
+   */
+  children?: JSX.Element;
+  /**
+   * Whether or not the loading spinner should be rendered or not.
+   */
+  isLoading?: boolean;
+}
+export declare function MenuTrigger(props: MenuTriggerProps): JSX.Element;
+export declare function Menu<T extends object>(input: MenuProps<T> & {
+  ref?: Ref<HTMLDivElement>;
+}): JSX.Element;
+export declare function MenuSection<T>(props: MenuSectionProps<T> & {
+  ref?: Ref<HTMLElement>;
+}): JSX.Element;
+export declare function MenuItem<T>(props: MenuItemProps<T> & {
+  ref?: Ref<HTMLDivElement>;
+}): JSX.Element;
+export declare function SubmenuTrigger(props: SubmenuTriggerProps & {
+  ref?: Ref<HTMLDivElement>;
+}): JSX.Element;
+export declare function MenuLoadMoreItem(props: MenuLoadMoreItemProps & {
+  ref?: Ref<HTMLDivElement>;
+}): JSX.Element;
+//# sourceMappingURL=menu.d.ts.map