packages/react-components/priority-overflow/etc/priority-overflow.api.md
Do not edit this file. It is a report generated by API Extractor.
// @internal (undocumented)
export function createOverflowManager(): OverflowManager;
// @public (undocumented)
export interface ObserveOptions {
hasHiddenItems?: boolean;
minimumVisible?: number;
onUpdateItemVisibility: OnUpdateItemVisibility;
onUpdateOverflow: OnUpdateOverflow;
overflowAxis?: OverflowAxis;
overflowDirection?: OverflowDirection;
padding?: number;
}
// @public (undocumented)
export type OnUpdateItemVisibility = (data: OnUpdateItemVisibilityPayload) => void;
// @public (undocumented)
export interface OnUpdateItemVisibilityPayload {
// (undocumented)
item: OverflowItemEntry;
// (undocumented)
visible: boolean;
}
// @public
export type OnUpdateOverflow = (data: OverflowEventPayload) => void;
// @public (undocumented)
export type OverflowAxis = 'horizontal' | 'vertical';
// @public (undocumented)
export type OverflowDirection = 'start' | 'end';
// @public (undocumented)
export interface OverflowDividerEntry {
element: HTMLElement;
// (undocumented)
groupId: string;
}
// @public
export interface OverflowEventPayload {
// (undocumented)
groupVisibility: Record<string, OverflowGroupState>;
// (undocumented)
invisibleItems: OverflowItemEntry[];
// (undocumented)
visibleItems: OverflowItemEntry[];
}
// @public (undocumented)
export type OverflowGroupState = 'visible' | 'hidden' | 'overflow';
// @public (undocumented)
export interface OverflowItemEntry {
element: HTMLElement;
// (undocumented)
groupId?: string;
id: string;
pinned?: boolean;
priority: number;
}
// @internal (undocumented)
export interface OverflowManager {
addDivider: (divider: OverflowDividerEntry) => void;
addItem: (items: OverflowItemEntry) => void;
addOverflowMenu: (element: HTMLElement) => void;
disconnect: () => void;
forceUpdate: () => void;
observe: (container: HTMLElement, options: ObserveOptions) => void;
removeDivider: (groupId: string) => void;
removeItem: (itemId: string) => void;
removeOverflowMenu: () => void;
update: () => void;
}
// (No @packageDocumentation comment for this package)