@solid2-aria/components 0.0.0-stage → 0.0.1

package/dist/browser/tree.d.ts

@@ -0,0 +1,98 @@
+/*
+ * Copyright 2024 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/Tree.tsx.
+ * Modified for Solid Aria: preserve flattened tree traversal with Solid collection nodes, controlled expansion, and reactive accessibility primitives; uses Solid class props.
+ * Licensed under Apache-2.0. See LICENSES/Apache-2.0.txt and NOTICE.txt at the repository root.
+ */
+import { ChildrenOrFunction, ClassOrFunction, ContextValue, DOMRenderProps, Ref, RenderProps, SlotProps, StyleRenderProps } from "./utils.js";
+import { CollectionProps, ItemRenderProps, SectionProps as SectionProps$1 } from "./collection.js";
+import { DragAndDropHooks } from "./create-drag-and-drop.js";
+import { GridListHeaderProps } from "./grid-list.js";
+import { JSX } from "@solidjs/web";
+import { LoadMoreSentinelProps } from "@solid2-aria/core/utils/create-load-more-sentinel";
+import { TreeState } from "@solid2-aria/stately/tree/create-tree-state";
+import { AriaTreeProps } from "@solid2-aria/core/tree/create-tree";
+import { AriaTreeItemOptions } from "@solid2-aria/core/tree/create-tree-item";
+import { DisabledBehavior, Expandable, HoverEvents, Key, LinkDOMProps, MultipleSelection, PressEvents, SelectionBehavior, SelectionMode } from "@solid2-aria/types-shared";
+import { GlobalDOMAttributes } from "@solid2-aria/types-shared-web";
+export interface TreeRenderProps {
+  isEmpty: boolean;
+  isFocused: boolean;
+  isFocusVisible: boolean;
+  selectionMode: SelectionMode;
+  allowsDragging: boolean;
+  isDropTarget: boolean;
+  state: TreeState<unknown>;
+}
+export type TreeEmptyStateRenderProps = Omit<TreeRenderProps, "isEmpty">;
+export interface TreeProps<T> extends Omit<AriaTreeProps<T>, "children">, MultipleSelection, CollectionProps<T>, StyleRenderProps<TreeRenderProps>, SlotProps, Expandable, GlobalDOMAttributes<HTMLDivElement> {
+  class?: ClassOrFunction<TreeRenderProps>;
+  selectionBehavior?: SelectionBehavior;
+  renderEmptyState?: (props: TreeEmptyStateRenderProps) => JSX.Element;
+  disabledBehavior?: DisabledBehavior;
+  dragAndDropHooks?: DragAndDropHooks<NoInfer<T>>;
+}
+export interface TreeItemRenderProps extends ItemRenderProps {
+  isExpanded: boolean;
+  hasChildItems: boolean;
+  level: number;
+  isFocusVisibleWithin: boolean;
+  state: TreeState<unknown>;
+  id: Key;
+}
+export type TreeItemContentRenderProps = TreeItemRenderProps;
+export interface TreeItemContentProps {
+  children: ChildrenOrFunction<TreeItemContentRenderProps>;
+}
+export interface TreeItemProps<T = object> extends StyleRenderProps<TreeItemRenderProps>, LinkDOMProps, HoverEvents, PressEvents, Pick<AriaTreeItemOptions, "hasChildItems" | "focusMode" | "allowsArrowNavigation">, Omit<GlobalDOMAttributes<HTMLDivElement>, "onClick"> {
+  class?: ClassOrFunction<TreeItemRenderProps>;
+  id?: Key;
+  value?: T;
+  textValue: string;
+  "aria-label"?: string;
+  children: JSX.Element;
+  isDisabled?: boolean;
+  onAction?: () => void;
+}
+export interface TreeLoadMoreItemRenderProps {
+  level: number;
+}
+export interface TreeLoadMoreItemProps extends Omit<LoadMoreSentinelProps, "collection" | "direction">, RenderProps<TreeLoadMoreItemRenderProps> {
+  class?: ClassOrFunction<TreeLoadMoreItemRenderProps>;
+  children?: ChildrenOrFunction<TreeLoadMoreItemRenderProps>;
+  isLoading?: boolean;
+}
+export interface TreeSectionProps<T> extends SectionProps$1<T>, DOMRenderProps<"div", undefined> {}
+export type TreeHeaderProps = GridListHeaderProps;
+export declare const TreeContext: import("solid-js").Context<ContextValue<TreeProps<any>, HTMLDivElement>>;
+export declare const TreeStateContext: import("solid-js").Context<TreeState<any> | null>;
+export declare const TreeItemContentContext: import("solid-js").Context<TreeItemRenderProps | null>;
+export declare function Tree<T>(input: TreeProps<T> & {
+  ref?: Ref<HTMLDivElement>;
+}): JSX.Element;
+export declare const TreeItemContent: (props: TreeItemContentProps & {
+  ref?: import("@solid2-aria/core/types").Ref<Element>;
+}) => import("solid-js").Element;
+export declare const TreeItem: <T>(props: TreeItemProps<T> & {
+  ref?: import("@solid2-aria/core/types").Ref<HTMLDivElement>;
+}) => import("solid-js").Element;
+export declare const TreeLoadMoreItem: (props: TreeLoadMoreItemProps & {
+  ref?: import("@solid2-aria/core/types").Ref<HTMLDivElement>;
+}) => import("solid-js").Element;
+export declare const TreeSection: <T>(props: TreeSectionProps<T> & {
+  ref?: import("@solid2-aria/core/types").Ref<HTMLDivElement>;
+}) => import("solid-js").Element;
+export declare function TreeHeader(props: TreeHeaderProps & {
+  ref?: Ref<HTMLDivElement>;
+}): JSX.Element;
+//# sourceMappingURL=tree.d.ts.map