Skip to content

Latest commit

 

History

History
88 lines (66 loc) · 2.77 KB

react-list-preview.api.md

File metadata and controls

88 lines (66 loc) · 2.77 KB
Raw

API Report File for "@fluentui/react-list-preview"

Do not edit this file. It is a report generated by API Extractor.

/// <reference types="react" />

import { Checkbox } from '@fluentui/react-checkbox';
import type { ComponentProps } from '@fluentui/react-utilities';
import type { ComponentState } from '@fluentui/react-utilities';
import type { EventData } from '@fluentui/react-utilities';
import type { EventHandler } from '@fluentui/react-utilities';
import type { ForwardRefComponent } from '@fluentui/react-utilities';
import * as React_2 from 'react';
import { SelectionItemId } from '@fluentui/react-utilities';
import type { SelectionMode as SelectionMode_2 } from '@fluentui/react-utilities';
import type { Slot } from '@fluentui/react-utilities';
import type { SlotClassNames } from '@fluentui/react-utilities';

// @public (undocumented)
export const List: ForwardRefComponent<ListProps>;

// @public (undocumented)
export const listClassNames: SlotClassNames<ListSlots>;

// @public (undocumented)
export const ListItem: ForwardRefComponent<ListItemProps>;

// @public (undocumented)
export const listItemClassNames: SlotClassNames<ListItemSlots>;

// @public
export type ListItemProps = ComponentProps<ListItemSlots> & {
    value?: string | number;
    onAction?: (e: ListItemActionEvent) => void;
};

// @public (undocumented)
export type ListItemSlots = {
    root: NonNullable<Slot<'li', 'div'>>;
    checkmark?: Slot<typeof Checkbox>;
};

// @public
export type ListItemState = ComponentState<ListItemSlots> & {
    selectable: boolean;
    navigable: boolean;
};

// @public
export type ListProps = ComponentProps<ListSlots> & {
    navigationMode?: ListNavigationMode;
    selectionMode?: SelectionMode_2;
    selectedItems?: SelectionItemId[];
    defaultSelectedItems?: SelectionItemId[];
    onSelectionChange?: EventHandler<OnListSelectionChangeData>;
};

// @public (undocumented)
export type ListSlots = {
    root: NonNullable<Slot<'ul', 'div' | 'ol'>>;
};

// @public
export type ListState = ComponentState<ListSlots> & ListContextValue;

// @public
export const renderList_unstable: (state: ListState, contextValues: ListContextValues) => JSX.Element;

// @public
export const renderListItem_unstable: (state: ListItemState) => JSX.Element;

// @public
export const useList_unstable: (props: ListProps, ref: React_2.Ref<HTMLDivElement | HTMLUListElement | HTMLOListElement>) => ListState;

// @public
export const useListItem_unstable: (props: ListItemProps, ref: React_2.Ref<HTMLLIElement | HTMLDivElement>) => ListItemState;

// @public
export const useListItemStyles_unstable: (state: ListItemState) => ListItemState;

// @public
export const useListStyles_unstable: (state: ListState) => ListState;

// (No @packageDocumentation comment for this package)