Back to Fluentui

React Priority Overflow.Api

packages/react-components/react-overflow/library/etc/react-priority-overflow.api.md

4.40.2-hotfix22.7 KB
Original Source

API Report File for "@fluentui/react-overflow"

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

ts
import type { ObserveOptions } from '@fluentui/priority-overflow';
import type { OnUpdateItemVisibility } from '@fluentui/priority-overflow';
import type { OnUpdateOverflow } from '@fluentui/priority-overflow';
import { OverflowGroupState } from '@fluentui/priority-overflow';
import type { OverflowItemEntry } from '@fluentui/priority-overflow';
import * as React_2 from 'react';

// @public (undocumented)
export const DATA_OVERFLOW_ITEM = 'data-overflow-item';

// @public (undocumented)
export const DATA_OVERFLOW_MENU = 'data-overflow-menu';

// @public (undocumented)
export const DATA_OVERFLOWING = 'data-overflowing';

// @public
export const Overflow: React_2.ForwardRefExoticComponent<
  Partial<Pick<ObserveOptions, 'padding' | 'overflowDirection' | 'overflowAxis' | 'minimumVisible'>> & {
    children: React_2.ReactElement;
  } & React_2.RefAttributes<unknown>
>;

// @public
export const OverflowItem: React_2.ForwardRefExoticComponent<OverflowItemProps & React_2.RefAttributes<unknown>>;

// @public
export type OverflowItemProps = {
  id: string;
  groupId?: string;
  priority?: number;
  children: React_2.ReactElement;
};

// @public
export type OverflowProps = Partial<
  Pick<ObserveOptions, 'overflowAxis' | 'overflowDirection' | 'padding' | 'minimumVisible'>
> & {
  children: React_2.ReactElement;
};

// @public (undocumented)
export const updateVisibilityAttribute: OnUpdateItemVisibility;

// @public (undocumented)
export function useIsOverflowGroupVisible(id: string): OverflowGroupState;

// @public (undocumented)
export function useIsOverflowItemVisible(id: string): boolean;

// @public (undocumented)
export const useOverflowContainer: <TElement extends HTMLElement>(
  update: OnUpdateOverflow,
  options: Omit<ObserveOptions, 'onUpdateOverflow'>,
) => UseOverflowContainerReturn<TElement>;

// @public (undocumented)
export interface UseOverflowContainerReturn<TElement extends HTMLElement> {
  containerRef: React_2.RefObject<TElement>;
  registerItem: OverflowContextValue['registerItem'];
  updateOverflow: OverflowContextValue['updateOverflow'];
}

// @public (undocumented)
export const useOverflowCount: () => number;

// @public
export function useOverflowItem<TElement extends HTMLElement>(
  id: string,
  priority?: number,
  groupId?: string,
): React_2.RefObject<TElement>;

// @public (undocumented)
export function useOverflowMenu<TElement extends HTMLElement>(
  id?: string,
): {
  ref: React_2.RefObject<TElement>;
  overflowCount: number;
  isOverflowing: boolean;
};

// (No @packageDocumentation comment for this package)