import type { IToolbarButtonBase } from '@msinternal/sp-toolbar'; /** * Configuration used for a single Top Action command. * * @public */ export interface ITopActionsField { /** * Display name for the action which can be used in a tooltip or aria-label. */ readonly title?: string; /** * Type of the top actions field. */ readonly type: TopActionsFieldType; /** * Target property from the web part's property bag. */ readonly targetProperty: string; /** * Whether this control should be focused. * * @remarks * The default value is false. */ readonly shouldFocus?: boolean; /** * Strongly typed properties object. Specific to each field type. * * @remarks * Example: Dropdown has ITopActionsChoiceGroupProps, Button has ITopActionsButtonProps props. * * @privateRemarks * - These props are from the office-ui-fabric-react. * These props may not be extensive as the fabric-react ones. This is intentional. * - We are not including any callbacks as part of the props, as this might end up breaking * the internal flow and cause unwanted problems. * - These are in line with property pane props as top actions consumes from the same * source as property pane. * * We are including only those which are supported by the web part framework. */ readonly properties: TProperties; /** * The data-automation-id for the top action * @internal */ readonly dataAutomationId?: string; } /** * Enum for all the supported Top Actions field types. * * Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct. * * @privateRemarks * These mirror `PropertyPaneFieldType` in `sp-property-pane`. We use arbitrary values for those without a corresponding field in `PropertyPaneFieldType`. * * @public */ export declare enum TopActionsFieldType { /** * Toggle field. * * @alpha */ Toggle = 5, /** * Choice Group field. */ Dropdown = 10, /** * Button field. */ Button = 11, /** * Split field. * * @alpha */ Split = 100, /** * Combobox field. * * @alpha */ Combobox = 101 } /** * Common props for all top actions fields (except legacy button and dropdown). * * @alpha */ export interface ITopActionsFieldCommonProps extends Pick, Partial> { } //# sourceMappingURL=topActionsField.d.ts.map