@solid2-aria/components 0.0.0-stage → 0.0.1

package/dist/browser/table.d.ts

@@ -0,0 +1,184 @@
+/*
+ * Derived from Adobe React Spectrum: packages/react-aria-components/src/Table.tsx.
+ * Modified for Solid Aria: preserve table collection, sorting and sizing algorithms with Solid contexts, collection descriptors 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 { ClassOrFunction, ContextValue, DOMProps as DOMProps$1, DOMRenderProps, Ref, RenderProps, SlotProps, StyleProps, StyleRenderProps } from "./utils.js";
+import { CollectionProps, ItemRenderProps } from "./collection.js";
+import { DragAndDropHooks } from "./create-drag-and-drop.js";
+import { JSX } from "@solidjs/web";
+import { LoadMoreSentinelProps } from "@solid2-aria/core/utils/create-load-more-sentinel";
+import { TableColumnResizeState } from "@solid2-aria/stately/table/create-table-column-resize-state";
+import { TableProps as TableProps$1, TableState } from "@solid2-aria/stately/table/create-table-state";
+import { AriaLabelingProps, DisabledBehavior, HoverEvents, Key, LinkDOMProps, PressEvents, SelectionBehavior, SelectionMode, SortDirection } from "@solid2-aria/types-shared";
+import { GlobalDOMAttributes } from "@solid2-aria/types-shared-web";
+import { ColumnSize, ColumnStaticSize } from "@solid2-aria/stately/table/column";
+export interface ResizableTableContainerProps extends DOMProps$1, DOMRenderProps<"div", undefined>, GlobalDOMAttributes<HTMLDivElement> {
+  class?: JSX.ClassValue;
+  onResizeStart?: (widths: Map<Key, ColumnSize>) => void;
+  onResize?: (widths: Map<Key, ColumnSize>) => void;
+  onResizeEnd?: (widths: Map<Key, ColumnSize>) => void;
+}
+export interface TableRenderProps {
+  isFocused: boolean;
+  isFocusVisible: boolean;
+  isDropTarget: boolean;
+  state: TableState<unknown>;
+}
+export interface TableProps extends Omit<TableProps$1<unknown>, "children">, StyleRenderProps<TableRenderProps, "table" | "div">, SlotProps, AriaLabelingProps, GlobalDOMAttributes<HTMLTableElement> {
+  class?: ClassOrFunction<TableRenderProps>;
+  children?: JSX.Element;
+  selectionBehavior?: SelectionBehavior;
+  disabledBehavior?: DisabledBehavior;
+  onRowAction?: (key: Key) => void;
+  dragAndDropHooks?: DragAndDropHooks;
+}
+export interface TableOptionsContextValue {
+  selectionMode: SelectionMode;
+  selectionBehavior: SelectionBehavior | null;
+  disallowEmptySelection: boolean;
+  allowsDragging: boolean;
+}
+export interface TableHeaderRenderProps {
+  isHovered: boolean;
+}
+export interface TableHeaderProps<T> extends StyleRenderProps<TableHeaderRenderProps, "thead" | "div">, HoverEvents, GlobalDOMAttributes<HTMLTableSectionElement> {
+  class?: ClassOrFunction<TableHeaderRenderProps>;
+  columns?: Iterable<T>;
+  children?: JSX.Element | ((item: T) => JSX.Element);
+  dependencies?: readonly unknown[];
+}
+export interface ColumnRenderProps {
+  isHovered: boolean;
+  isPressed: boolean;
+  isFocused: boolean;
+  isFocusVisible: boolean;
+  allowsSorting: boolean;
+  sortDirection: SortDirection | undefined;
+  isResizing: boolean;
+  sort: (direction: SortDirection) => void;
+  startResize: () => void;
+}
+export interface ColumnProps extends RenderProps<ColumnRenderProps, "th" | "div">, GlobalDOMAttributes<HTMLTableCellElement> {
+  class?: ClassOrFunction<ColumnRenderProps>;
+  id?: Key;
+  allowsSorting?: boolean;
+  isRowHeader?: boolean;
+  textValue?: string;
+  width?: ColumnSize | null;
+  defaultWidth?: ColumnSize | null;
+  minWidth?: ColumnStaticSize | null;
+  maxWidth?: ColumnStaticSize | null;
+  focusMode?: "child" | "cell";
+  allowsArrowNavigation?: boolean;
+}
+export interface ColumnResizerRenderProps {
+  isHovered: boolean;
+  isFocused: boolean;
+  isFocusVisible: boolean;
+  isResizing: boolean;
+  resizableDirection: "right" | "left" | "both";
+}
+export interface ColumnResizerProps extends HoverEvents, RenderProps<ColumnResizerRenderProps>, GlobalDOMAttributes<HTMLDivElement> {
+  class?: ClassOrFunction<ColumnResizerRenderProps>;
+  "aria-label"?: string;
+}
+export interface TableBodyRenderProps {
+  isEmpty: boolean;
+  isDropTarget: boolean;
+}
+export interface TableBodyProps<T> extends Omit<CollectionProps<T>, "disabledKeys">, StyleRenderProps<TableBodyRenderProps, "tbody" | "div">, GlobalDOMAttributes<HTMLTableSectionElement> {
+  class?: ClassOrFunction<TableBodyRenderProps>;
+  renderEmptyState?: (props: TableBodyRenderProps) => JSX.Element;
+}
+export interface TableFooterProps<T> extends Omit<CollectionProps<T>, "disabledKeys">, StyleProps, GlobalDOMAttributes<HTMLTableSectionElement> {
+  class?: JSX.ClassValue;
+}
+export interface RowRenderProps extends ItemRenderProps {
+  isFocusVisibleWithin: boolean;
+  id?: Key;
+  isExpanded: boolean;
+  hasChildItems: boolean;
+  level: number;
+  state: TableState<unknown>;
+}
+export interface RowFocusContextValue {
+  isFocusVisibleWithinRow: boolean;
+}
+export interface RowProps<T> extends StyleRenderProps<RowRenderProps, "tr" | "div">, LinkDOMProps, HoverEvents, PressEvents, Omit<GlobalDOMAttributes<HTMLTableRowElement>, "onClick"> {
+  class?: ClassOrFunction<RowRenderProps>;
+  columns?: Iterable<T>;
+  children?: JSX.Element | ((item: T) => JSX.Element);
+  value?: T;
+  dependencies?: readonly unknown[];
+  textValue?: string;
+  isDisabled?: boolean;
+  disabledBehavior?: DisabledBehavior;
+  onAction?: () => void;
+  id?: Key;
+  hasChildItems?: boolean;
+}
+export interface CellRenderProps {
+  isPressed: boolean;
+  isFocused: boolean;
+  isFocusVisible: boolean;
+  isHovered: boolean;
+  isSelected: boolean;
+  isDisabled: boolean;
+  isFocusVisibleWithinRow: boolean;
+  id?: Key;
+  columnIndex?: number | null;
+  isTreeColumn: boolean;
+  isExpanded: boolean;
+  hasChildItems: boolean;
+  level: number;
+}
+export interface CellProps extends RenderProps<CellRenderProps, "td" | "div">, GlobalDOMAttributes<HTMLTableCellElement> {
+  class?: ClassOrFunction<CellRenderProps>;
+  id?: Key;
+  textValue?: string;
+  colSpan?: number;
+  focusMode?: "child" | "cell";
+  allowsArrowNavigation?: boolean;
+}
+export interface TableLoadMoreItemProps extends Omit<LoadMoreSentinelProps, "collection">, StyleProps, DOMRenderProps<"tr" | "div", undefined>, GlobalDOMAttributes<HTMLTableRowElement> {
+  class?: JSX.ClassValue;
+  children?: JSX.Element;
+  isLoading?: boolean;
+}
+export declare const TableContext: import("solid-js").Context<ContextValue<TableProps, HTMLTableElement>>;
+export declare const TableStateContext: import("solid-js").Context<TableState<unknown> | null>;
+export declare const TableColumnResizeStateContext: import("solid-js").Context<TableColumnResizeState<unknown> | null>;
+export declare const RowFocusContext: import("solid-js").Context<RowFocusContextValue>;
+export declare function createTableOptions(): TableOptionsContextValue;
+export declare function ResizableTableContainer(props: ResizableTableContainerProps & {
+  ref?: Ref<HTMLDivElement>;
+}): JSX.Element;
+export declare function Table(input: TableProps & {
+  ref?: Ref<HTMLTableElement>;
+}): JSX.Element;
+export declare const TableHeader: <T>(props: TableHeaderProps<T> & {
+  ref?: import("@solid2-aria/core/types").Ref<HTMLTableSectionElement>;
+}) => import("solid-js").Element;
+export declare const Column: (props: ColumnProps & {
+  ref?: import("@solid2-aria/core/types").Ref<HTMLTableCellElement>;
+}) => import("solid-js").Element;
+export declare function ColumnResizer(props: ColumnResizerProps & {
+  ref?: Ref<HTMLDivElement>;
+}): JSX.Element;
+export declare const TableBody: <T>(props: TableBodyProps<T> & {
+  ref?: import("@solid2-aria/core/types").Ref<HTMLTableSectionElement>;
+}) => import("solid-js").Element;
+export declare const TableFooter: <T>(props: TableFooterProps<T> & {
+  ref?: import("@solid2-aria/core/types").Ref<HTMLTableSectionElement>;
+}) => import("solid-js").Element;
+export declare function Row<T>(ownProps: RowProps<T> & {
+  ref?: Ref<HTMLTableRowElement>;
+}): JSX.Element;
+export declare const Cell: (props: CellProps & {
+  ref?: import("@solid2-aria/core/types").Ref<HTMLTableCellElement>;
+}) => import("solid-js").Element;
+export declare const TableLoadMoreItem: (props: TableLoadMoreItemProps & {
+  ref?: import("@solid2-aria/core/types").Ref<HTMLTableRowElement>;
+}) => import("solid-js").Element;
+//# sourceMappingURL=table.d.ts.map