@itwin/components-react 3.6.0-dev.36 → 3.6.0-dev.38

package/lib/esm/components-react/toolbar/ToolbarWithOverflow.d.ts

@@ -1,151 +1,151 @@
-/** @packageDocumentation
- * @module Toolbar
- */
-import "./Toolbar.scss";
-import * as React from "react";
-import { ActionButton, CommonToolbarItem, CustomButtonDefinition, GroupButton, OnItemExecutedFunc } from "@itwin/appui-abstract";
-import { CommonProps, NoChildrenProps } from "@itwin/core-react";
-import { Direction, OrthogonalDirection } from "./utilities/Direction";
-/** Describes the data needed to insert a custom `React` button into an ToolbarWithOverflow.
- * @public
- */
-export interface CustomToolbarItem extends CustomButtonDefinition {
-    /** React node that must result in providing a PopupItem @deprecated use panelContentNode */
-    buttonNode?: React.ReactNode;
-    /** defines the content to display in popup panel */
-    panelContentNode?: React.ReactNode;
-    /** If true the popup panel is mounted once and unmounted when button is unmounted. If false the
-     * content node is unmounted each time the popup is closed. */
-    keepContentsLoaded?: boolean;
-}
-/**
- * Context used by Toolbar items to know if popup panel should be hidden - via AutoHide.
- * @public
- */
-export declare const ToolbarPopupAutoHideContext: React.Context<boolean>;
-/**
- * React hook used to retrieve the ToolbarPopupAutoHideContext.
- *  @public
- */
-export declare function useToolbarPopupAutoHideContext(): boolean;
-/** Describes toolbar item.
- * @public
- */
-export declare type ToolbarItem = ActionButton | GroupButton | CustomToolbarItem;
-/** CustomToolbarItem type guard.
- * @internal
- */
-export declare function isCustomToolbarItem(item: ToolbarItem): item is CustomToolbarItem;
-/** @internal */
-export declare const getToolbarDirection: (expandsTo: Direction) => OrthogonalDirection;
-/** Available alignment modes of [[ToolbarWithOverflow]] panels.
- * @public
- */
-export declare enum ToolbarPanelAlignment {
-    Start = 0,
-    End = 1
-}
-/** Enumeration of Toolbar Opacity setting.
- * @public
- */
-export declare enum ToolbarOpacitySetting {
-    /** Use the default background, box-shadow opacity and backdrop-filter blur */
-    Defaults = 0,
-    /** Alter the opacity from transparent to the defaults based on mouse proximity */
-    Proximity = 1,
-    /** Use a transparent background, box-shadow opacity and backdrop-filter blur */
-    Transparent = 2
-}
-/** Helpers for [[ToolbarPanelAlignment]].
- * @internal
- */
-export declare class ToolbarPanelAlignmentHelpers {
-    /** Class name of [[ToolbarPanelAlignment.Start]] */
-    static readonly START_CLASS_NAME = "components-panel-alignment-start";
-    /** Class name of [[ToolbarPanelAlignment.End]] */
-    static readonly END_CLASS_NAME = "components-panel-alignment-end";
-    /** @returns Class name of specified [[ToolbarPanelAlignment]] */
-    static getCssClassName(panelAlignment: ToolbarPanelAlignment): string;
-}
-/** @internal */
-export interface ToolbarOverflowContextProps {
-    readonly expandsTo: Direction;
-    readonly direction: OrthogonalDirection;
-    readonly overflowExpandsTo: Direction;
-    readonly overflowDirection: OrthogonalDirection;
-    readonly panelAlignment: ToolbarPanelAlignment;
-    readonly useDragInteraction: boolean;
-    readonly toolbarOpacitySetting: ToolbarOpacitySetting;
-    readonly openPopupCount: number;
-    readonly onPopupPanelOpenClose: (isOpening: boolean) => void;
-    readonly overflowDisplayActive: boolean;
-    readonly onItemExecuted: OnItemExecutedFunc;
-    readonly onKeyDown: (e: React.KeyboardEvent) => void;
-}
-/**
- * Context used by Toolbar component to provide Direction to child components.
- * @internal
- */
-export declare const ToolbarWithOverflowDirectionContext: React.Context<ToolbarOverflowContextProps>;
-/** @internal */
-export declare function CustomItem({ item, addGroupSeparator }: {
-    item: CustomToolbarItem;
-    addGroupSeparator: boolean;
-}): JSX.Element | null;
-/** @internal */
-export declare function GroupPopupItem({ item, addGroupSeparator }: {
-    item: GroupButton;
-    addGroupSeparator: boolean;
-}): JSX.Element;
-/** @internal */
-export declare function ActionItem({ item, addGroupSeparator }: {
-    item: ActionButton;
-    addGroupSeparator: boolean;
-}): JSX.Element;
-/** @internal */
-export declare function ToolbarItemComponent({ item, addGroupSeparator }: {
-    item: ToolbarItem;
-    addGroupSeparator: boolean;
-}): JSX.Element | null;
-/** @internal */
-export declare function useToolbarWithOverflowDirectionContext(): ToolbarOverflowContextProps;
-/** Properties of [[ToolbarWithOverflow]] component.
- * @public
- */
-export interface ToolbarWithOverflowProps extends CommonProps, NoChildrenProps {
-    /** Describes to which direction the popup panels are expanded. Defaults to: [[Direction.Bottom]] */
-    expandsTo?: Direction;
-    /** Describes to which direction the overflow popup panels are expanded. Defaults to: [[Direction.Right]] */
-    overflowExpandsTo?: Direction;
-    /** definitions for items of the toolbar. i.e. [[CommonToolbarItem]]. Items are expected to be already sorted by group and item. */
-    items: CommonToolbarItem[];
-    /** Describes how expanded panels are aligned. Defaults to: [[ToolbarPanelAlignment.Start]] */
-    panelAlignment?: ToolbarPanelAlignment;
-    /** Use Drag Interaction to open popups with nest action buttons */
-    useDragInteraction?: boolean;
-    /** Determines whether to use mouse proximity to alter the opacity of the toolbar */
-    toolbarOpacitySetting?: ToolbarOpacitySetting;
-    /** Optional function to call on any item execution */
-    onItemExecuted?: OnItemExecutedFunc;
-    /** Optional function to call on any KeyDown events processed by toolbar */
-    onKeyDown?: (e: React.KeyboardEvent) => void;
-}
-/** Component that displays tool settings as a bar across the top of the content view.
- * @public
- */
-export declare function ToolbarWithOverflow(props: ToolbarWithOverflowProps): JSX.Element;
-/** Interface toolbars use to define context for its items.
- * @internal
- */
-export interface ToolbarItemContextArgs {
-    readonly hasOverflow: boolean;
-    readonly useHeight: boolean;
-    readonly onResize: (w: number) => void;
-}
-/** Interface toolbars use to define context for its items.
- * @internal
- */
-export declare const ToolbarItemContext: React.Context<ToolbarItemContextArgs>;
-/** @internal */
-export declare function useToolItemEntryContext(): ToolbarItemContextArgs;
+/** @packageDocumentation
+ * @module Toolbar
+ */
+import "./Toolbar.scss";
+import * as React from "react";
+import { ActionButton, CommonToolbarItem, CustomButtonDefinition, GroupButton, OnItemExecutedFunc } from "@itwin/appui-abstract";
+import { CommonProps, NoChildrenProps } from "@itwin/core-react";
+import { Direction, OrthogonalDirection } from "./utilities/Direction";
+/** Describes the data needed to insert a custom `React` button into an ToolbarWithOverflow.
+ * @public
+ */
+export interface CustomToolbarItem extends CustomButtonDefinition {
+    /** React node that must result in providing a PopupItem @deprecated use panelContentNode */
+    buttonNode?: React.ReactNode;
+    /** defines the content to display in popup panel */
+    panelContentNode?: React.ReactNode;
+    /** If true the popup panel is mounted once and unmounted when button is unmounted. If false the
+     * content node is unmounted each time the popup is closed. */
+    keepContentsLoaded?: boolean;
+}
+/**
+ * Context used by Toolbar items to know if popup panel should be hidden - via AutoHide.
+ * @public
+ */
+export declare const ToolbarPopupAutoHideContext: React.Context<boolean>;
+/**
+ * React hook used to retrieve the ToolbarPopupAutoHideContext.
+ *  @public
+ */
+export declare function useToolbarPopupAutoHideContext(): boolean;
+/** Describes toolbar item.
+ * @public
+ */
+export declare type ToolbarItem = ActionButton | GroupButton | CustomToolbarItem;
+/** CustomToolbarItem type guard.
+ * @internal
+ */
+export declare function isCustomToolbarItem(item: ToolbarItem): item is CustomToolbarItem;
+/** @internal */
+export declare const getToolbarDirection: (expandsTo: Direction) => OrthogonalDirection;
+/** Available alignment modes of [[ToolbarWithOverflow]] panels.
+ * @public
+ */
+export declare enum ToolbarPanelAlignment {
+    Start = 0,
+    End = 1
+}
+/** Enumeration of Toolbar Opacity setting.
+ * @public
+ */
+export declare enum ToolbarOpacitySetting {
+    /** Use the default background, box-shadow opacity and backdrop-filter blur */
+    Defaults = 0,
+    /** Alter the opacity from transparent to the defaults based on mouse proximity */
+    Proximity = 1,
+    /** Use a transparent background, box-shadow opacity and backdrop-filter blur */
+    Transparent = 2
+}
+/** Helpers for [[ToolbarPanelAlignment]].
+ * @internal
+ */
+export declare class ToolbarPanelAlignmentHelpers {
+    /** Class name of [[ToolbarPanelAlignment.Start]] */
+    static readonly START_CLASS_NAME = "components-panel-alignment-start";
+    /** Class name of [[ToolbarPanelAlignment.End]] */
+    static readonly END_CLASS_NAME = "components-panel-alignment-end";
+    /** @returns Class name of specified [[ToolbarPanelAlignment]] */
+    static getCssClassName(panelAlignment: ToolbarPanelAlignment): string;
+}
+/** @internal */
+export interface ToolbarOverflowContextProps {
+    readonly expandsTo: Direction;
+    readonly direction: OrthogonalDirection;
+    readonly overflowExpandsTo: Direction;
+    readonly overflowDirection: OrthogonalDirection;
+    readonly panelAlignment: ToolbarPanelAlignment;
+    readonly useDragInteraction: boolean;
+    readonly toolbarOpacitySetting: ToolbarOpacitySetting;
+    readonly openPopupCount: number;
+    readonly onPopupPanelOpenClose: (isOpening: boolean) => void;
+    readonly overflowDisplayActive: boolean;
+    readonly onItemExecuted: OnItemExecutedFunc;
+    readonly onKeyDown: (e: React.KeyboardEvent) => void;
+}
+/**
+ * Context used by Toolbar component to provide Direction to child components.
+ * @internal
+ */
+export declare const ToolbarWithOverflowDirectionContext: React.Context<ToolbarOverflowContextProps>;
+/** @internal */
+export declare function CustomItem({ item, addGroupSeparator }: {
+    item: CustomToolbarItem;
+    addGroupSeparator: boolean;
+}): JSX.Element | null;
+/** @internal */
+export declare function GroupPopupItem({ item, addGroupSeparator }: {
+    item: GroupButton;
+    addGroupSeparator: boolean;
+}): JSX.Element;
+/** @internal */
+export declare function ActionItem({ item, addGroupSeparator }: {
+    item: ActionButton;
+    addGroupSeparator: boolean;
+}): JSX.Element;
+/** @internal */
+export declare function ToolbarItemComponent({ item, addGroupSeparator }: {
+    item: ToolbarItem;
+    addGroupSeparator: boolean;
+}): JSX.Element | null;
+/** @internal */
+export declare function useToolbarWithOverflowDirectionContext(): ToolbarOverflowContextProps;
+/** Properties of [[ToolbarWithOverflow]] component.
+ * @public
+ */
+export interface ToolbarWithOverflowProps extends CommonProps, NoChildrenProps {
+    /** Describes to which direction the popup panels are expanded. Defaults to: [[Direction.Bottom]] */
+    expandsTo?: Direction;
+    /** Describes to which direction the overflow popup panels are expanded. Defaults to: [[Direction.Right]] */
+    overflowExpandsTo?: Direction;
+    /** definitions for items of the toolbar. i.e. [[CommonToolbarItem]]. Items are expected to be already sorted by group and item. */
+    items: CommonToolbarItem[];
+    /** Describes how expanded panels are aligned. Defaults to: [[ToolbarPanelAlignment.Start]] */
+    panelAlignment?: ToolbarPanelAlignment;
+    /** Use Drag Interaction to open popups with nest action buttons */
+    useDragInteraction?: boolean;
+    /** Determines whether to use mouse proximity to alter the opacity of the toolbar */
+    toolbarOpacitySetting?: ToolbarOpacitySetting;
+    /** Optional function to call on any item execution */
+    onItemExecuted?: OnItemExecutedFunc;
+    /** Optional function to call on any KeyDown events processed by toolbar */
+    onKeyDown?: (e: React.KeyboardEvent) => void;
+}
+/** Component that displays tool settings as a bar across the top of the content view.
+ * @public
+ */
+export declare function ToolbarWithOverflow(props: ToolbarWithOverflowProps): JSX.Element;
+/** Interface toolbars use to define context for its items.
+ * @internal
+ */
+export interface ToolbarItemContextArgs {
+    readonly hasOverflow: boolean;
+    readonly useHeight: boolean;
+    readonly onResize: (w: number) => void;
+}
+/** Interface toolbars use to define context for its items.
+ * @internal
+ */
+export declare const ToolbarItemContext: React.Context<ToolbarItemContextArgs>;
+/** @internal */
+export declare function useToolItemEntryContext(): ToolbarItemContextArgs;
 //# sourceMappingURL=ToolbarWithOverflow.d.ts.map