UNPKG

@microsoft/sp-webpart-base

Version:

SharePoint Framework support for building web parts

705 lines 27.2 kB
import type * as SPPropertyPane from '@microsoft/sp-property-pane'; /** * Web part configuration settings * * @public * @deprecated This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export interface IPropertyPaneConfiguration extends SPPropertyPane.IPropertyPaneConfiguration { } /** * PropertyPanePage interface. * * @public * @deprecated This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export interface IPropertyPanePage extends SPPropertyPane.IPropertyPanePage { } /** * PropertyPane header. * This header remains same for all the pages. * * @public * @deprecated This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export interface IPropertyPanePageHeader extends SPPropertyPane.IPropertyPanePageHeader { } /** * PropertyPane group. Group is part of the PropertyPanePage. * * @public * @deprecated This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export interface IPropertyPaneGroup extends SPPropertyPane.IPropertyPaneGroup { } /** * PropertyPane field. * * @public * @deprecated This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export interface IPropertyPaneField<TProperties> extends SPPropertyPane.IPropertyPaneField<TProperties> { } /** * PropertyPane CustomPropertyField props. * * @public * @deprecated This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export interface IPropertyPaneCustomFieldProps extends SPPropertyPane.IPropertyPaneCustomFieldProps { } /** * PropertyPane button props. * * @public * @deprecated This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export interface IPropertyPaneButtonProps extends SPPropertyPane.IPropertyPaneButtonProps { } /** * PropertyPane CheckBox component props. * * @public * @deprecated This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export interface IPropertyPaneCheckboxProps extends SPPropertyPane.IPropertyPaneCheckboxProps { } /** * PropertyPane ChoiceGroup icon props. * * @public * @deprecated This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export interface IPropertyPaneChoiceGroupOptionIconProps extends SPPropertyPane.IPropertyPaneChoiceGroupOptionIconProps { } /** * PropertyPane ChoiceGroup props. * * @public * @deprecated This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export interface IPropertyPaneChoiceGroupProps extends SPPropertyPane.IPropertyPaneChoiceGroupProps { } /** * PropertyPane ChoiceGroup option props. * * @public * @deprecated This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export interface IPropertyPaneChoiceGroupOption extends SPPropertyPane.IPropertyPaneChoiceGroupOption { } /** * PropertyPane drop down component props. * * @public * @deprecated This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export interface IPropertyPaneDropdownProps extends SPPropertyPane.IPropertyPaneDropdownProps { } /** * PropertyPane drop down options. * * @public * @deprecated This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export interface IPropertyPaneDropdownOption extends SPPropertyPane.IPropertyPaneDropdownOption { } /** * PropertyPane dropdown callout properties. * * @public * @deprecated This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export interface IPropertyPaneDropdownCalloutProps extends SPPropertyPane.IPropertyPaneDropdownCalloutProps { } /** * Property pane dynamic field filters which is an intersection of both * source and property filters. * * @public * @deprecated This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export interface IPropertyPaneDynamicFieldFilters extends SPPropertyPane.IPropertyPaneDynamicFieldFilters { } /** * PropertyPaneDynamicField props. * * @public * @deprecated This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export interface IPropertyPaneDynamicFieldProps extends SPPropertyPane.IPropertyPaneDynamicFieldProps { } /** * PropertyPane DynamicFieldSet props. * * @public * @deprecated This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export interface IPropertyPaneDynamicFieldSetProps extends SPPropertyPane.IPropertyPaneDynamicFieldSetProps { } /** * `PropertyPaneDynamicData` component props. * * @beta * @deprecated - This has been replaced by IPropertyPaneDynamicFieldProps */ export interface IPropertyPaneDynamicTextFieldProps extends SPPropertyPane.IPropertyPaneDynamicTextFieldProps { } /** * PropertyPaneLabel component props. * * @public * @deprecated This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export interface IPropertyPaneLabelProps extends SPPropertyPane.IPropertyPaneLabelProps { } /** * PropertyPaneLink component props. * * @public * @deprecated This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export interface IPropertyPaneLinkProps extends SPPropertyPane.IPropertyPaneLinkProps { } /** * PropertyPaneSliderProps component props. * * @public * @deprecated This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export interface IPropertyPaneSliderProps extends SPPropertyPane.IPropertyPaneSliderProps { } /** * PropertyPaneTextField component props. * * @public * @deprecated This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export interface IPropertyPaneTextFieldProps extends SPPropertyPane.IPropertyPaneTextFieldProps { } /** * PropertyPaneToggle component props. * * @public * @deprecated This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export interface IPropertyPaneToggleProps extends SPPropertyPane.IPropertyPaneToggleProps { } /** * Configuration related to a shared source. * * @public * @deprecated This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export interface IDynamicDataSharedSourceConfiguration extends SPPropertyPane.IDynamicDataSharedSourceConfiguration { } /** * Configuration related to a shared property. * * @public * @deprecated This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export interface IDynamicDataSharedPropertyConfiguration extends SPPropertyPane.IDynamicDataSharedPropertyConfiguration { } /** * Property pane dynamic data source filters. * * @public * @deprecated This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export interface IDynamicDataSharedSourceFilters extends SPPropertyPane.IDynamicDataSharedSourceFilters { } /** * Property pane dynamic data property filters. * * @public * @deprecated This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export interface IDynamicDataSharedPropertyFilters extends SPPropertyPane.IDynamicDataSharedPropertyFilters { } /** * Property pane conditional group. * * @public * @deprecated This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export interface IPropertyPaneConditionalGroup extends SPPropertyPane.IPropertyPaneConditionalGroup { } /** * Helper method to create a custom field on the PropertyPane. * * @remarks * The purpose of the custom field is to help the web part developer to add a custom control to * the PropertyPane. The PropertyPane supports a host of inbuilt field types. While * this list meets the demands of most web parts, but there are exceptional cases * when web parts have special needs and need a special control. The custom field * helps fill that gap. * * @param properties - Strongly typed Custom field properties. * * @beta * @deprecated This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export declare function PropertyPaneCustomField(properties: IPropertyPaneCustomFieldProps): IPropertyPaneField<IPropertyPaneCustomFieldProps>; /** * Helper method to create a Button on the PropertyPane. * @param targetProperty - Target property the Button is associated to. * @param properties - Strongly typed Button properties. * * @public * @deprecated This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export declare function PropertyPaneButton(targetProperty: string, properties: IPropertyPaneButtonProps): IPropertyPaneField<IPropertyPaneButtonProps>; /** * Helper method to create a Checkbox on the PropertyPane. * @param targetProperty - Target property the checkbox is associated to. * @param properties - Strongly typed Checkbox properties. * * @public * @deprecated This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export declare function PropertyPaneCheckbox(targetProperty: string, properties: IPropertyPaneCheckboxProps): IPropertyPaneField<IPropertyPaneCheckboxProps>; /** * Helper method to create a Choice Group on the PropertyPane. * @param targetProperty - Target property the choice group is associated to. * @param properties - Strongly typed Choice Group properties. * * @public * @deprecated This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export declare function PropertyPaneChoiceGroup(targetProperty: string, properties: IPropertyPaneChoiceGroupProps): IPropertyPaneField<IPropertyPaneChoiceGroupProps>; /** * Helper method to create a Dropdown on the PropertyPane. * @param targetProperty - Target property the dropdown is associated to. * @param properties - Strongly typed Dropdown properties. * * @public * @deprecated This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export declare function PropertyPaneDropdown(targetProperty: string, properties: IPropertyPaneDropdownProps): IPropertyPaneField<IPropertyPaneDropdownProps>; /** * Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field. * * @param targetProperty - Target property the Dynamic Data widget is associated to. * * @public * @deprecated This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export declare function PropertyPaneDynamicField(targetProperty: string, properties: IPropertyPaneDynamicFieldProps): IPropertyPaneField<IPropertyPaneDynamicFieldProps>; /** * Helper method to create a Dynamic Data widget on the Property Pane for a set * of dynamic fields with a common data source. * * These fields can possibly share the same property based on the associated filters. * @param properties - Contains entries and options, described as below: * entries - A set of entries to be configured by the widget. Each entry includes the target * property and, optionally, the label to show. * options - Options enabling customized values for callback, filters etc., * for the given set of dynamic fields. * @public * @deprecated This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export declare function PropertyPaneDynamicFieldSet(properties: IPropertyPaneDynamicFieldSetProps): IPropertyPaneField<IPropertyPaneDynamicFieldSetProps>; /** * Helper method to create a Horizontal Rule on the PropertyPane. * * @public * @deprecated This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export declare function PropertyPaneHorizontalRule(): IPropertyPaneField<void>; /** * Helper method to create a Label on the PropertyPane. * @param targetProperty - Target property the label is associated to. * @param properties - Strongly typed Label properties. * * @public * @deprecated This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export declare function PropertyPaneLabel(targetProperty: string, properties: IPropertyPaneLabelProps): IPropertyPaneField<IPropertyPaneLabelProps>; /** * Helper method to create a Link on the PropertyPane. * @param targetProperty - Target property the Link is associated to. * @param properties - Strongly typed Link properties. * * @public * @deprecated This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export declare function PropertyPaneLink(targetProperty: string, properties: IPropertyPaneLinkProps): IPropertyPaneField<IPropertyPaneLinkProps>; /** * Helper method to create a Slider on the PropertyPane. * @param targetProperty - Target property the slider is associated to. * @param properties - Strongly typed Slider properties. * * @public * @deprecated This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export declare function PropertyPaneSlider(targetProperty: string, properties: IPropertyPaneSliderProps): IPropertyPaneField<IPropertyPaneSliderProps>; /** * Helper method to create a TextField on the PropertyPane. * @param targetProperty - Target property the textfield is associated to. * @param properties - Strongly typed TextField properties. * * @public * @deprecated This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export declare function PropertyPaneTextField(targetProperty: string, properties: IPropertyPaneTextFieldProps): IPropertyPaneField<IPropertyPaneTextFieldProps>; /** * Helper method to create a Toggle on the PropertyPane. * @param targetProperty - Target property the toggle is associated to. * @param properties - Strongly typed Toggle properties. * * @public * @deprecated This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export declare function PropertyPaneToggle(targetProperty: string, properties: IPropertyPaneToggleProps): IPropertyPaneField<IPropertyPaneToggleProps>; /** * Helper method to create a Dynamic TextField on the PropertyPane. * @param targetProperty - Target property the dynamic textfield is associated to. * @param properties - Properties of the PropertyPaneDynamicTextField. * * @beta * @deprecated This has been replaced by PropertyPaneDynamicField and moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export declare function PropertyPaneDynamicTextField(targetProperty: string, properties: IPropertyPaneDynamicTextFieldProps): IPropertyPaneField<IPropertyPaneDynamicTextFieldProps>; /** * Describes different kinds of possible property pane actions. * * @internal * @deprecated This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export declare const _PropertyPaneAction: { /** * Ask the property pane to open */ readonly Open: 1; /** * Ask the property pane to close */ readonly Close: 2; /** * Ask the property pane to toggle */ readonly Toggle: 3; /** * Default action * * Ask the property pane to open if it is already open, with the newly selected * component's configuration else ask to close it. */ readonly Default: 4; /** * Ask the property pane to refresh the contents. * * Property pane refreshes its contents only if the asking component is same as the * one which is being configured currently. In any other case the call is ignored. */ readonly Refresh: 5; }; /** * {@inheritdoc (_PropertyPaneAction:variable)} * @internal */ export type _PropertyPaneAction = (typeof _PropertyPaneAction)[keyof typeof _PropertyPaneAction]; /** * Enum for all the supported PropertyPane field types. * * Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct. * * @public * @deprecated This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export declare enum PropertyPaneFieldType { /** * Custom field. */ Custom = 1, /** * Checkbox field. */ CheckBox = 2, /** * TextField field. */ TextField = 3, /** * Toggle field. */ Toggle = 5, /** * Dropdown field. */ Dropdown = 6, /** * Label field. */ Label = 7, /** * Slider field. */ Slider = 8, /** * Heading field. */ Heading = 9, /** * Choice Group field. */ ChoiceGroup = 10, /** * Button field. */ Button = 11, /** * Horizontal Rule field. */ HorizontalRule = 12, /** * Link field. */ Link = 13, /** * Dynamic data field. * @public */ DynamicField = 14, /** * Dynamic Text Field * * @beta * @deprecated - Please use DynamicField */ DynamicTextField = 15, /** * A set of dynamic fields. * @public */ DynamicFieldSet = 16, /** * Spin button * * @alpha */ SpinButton = 17, /** * Thumbnail picker field. * * @beta */ ThumbnailPicker = 18, /** * Icon picker field. * * @beta */ IconPicker = 19, /** * Alternative Text toggle and text field. * * @beta */ AlternativeText = 20, /** * Webpart Title Heading toggle and dropdown * @internal */ WebPartTitleHeading = 21, /** * Sortable Accordion field * @internal */ SortableAccordion = 22 } /** * Enum for all the supported button types. * * @public * @deprecated This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export declare enum PropertyPaneButtonType { /** * Optional completion action. * * @remarks * Typically used at the end of a form or task when paired with the Primary button OR * as a standalone button to undo an action. * Examples: "Done" button which closes a container but doesn't make a server call or * an "Undo" button when a user is uploading a file in OneDrive. */ Normal = 0, /** * Preferred completion action when paired with a Standard button. * * @remarks * Typically used at the end of a task or form. * Examples: "Create", "Save", "Send" which makes a server call. */ Primary = 1, /** * Hero button. */ Hero = 2, /** * Always used as a set with both Standard and Primary compound buttons. * * @remarks * Typically used in a confirmation dialog. * Examples: A confirmation dialog when a user discards a form or task with a possible * significant time investment such as an email or a complex form */ Compound = 3, /** * Optional actions. * * @remarks * Typically used in a command bar at the top of a view, panel and inside an inline command bar. * Examples: Command bar at the top of OneDrive, Outlook, SharePoint. Inline command bar on the * top of SharePoint web parts. */ Command = 4, /** * Same usage as Command button, when real estate does not allow for icons + labels or as secondary * actions within the command bar. * * @remarks * Typically used in Command bar in small and medium responsive web breakpoints. Also used on objects. * Examples: OneDrive small and medium responsive web breakpoint Command Bars and view icons within the * Command Bar. In SharePoint and OneDrive, Cards with social actions and images which allow users to * access the image picker. In SharePoint, formatting experiences such as formatting a story within the * Authoring experience. In Calendar, in the bottom of an event creation Callout when clicking inside * an empty time range. */ Icon = 5 } /** * Specifies the type of option in a dropdown menu rendered by {@link PropertyPaneDropdown}. * * @public * @deprecated This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export declare enum PropertyPaneDropdownOptionType { /** * Render normal menu item. */ Normal = 0, /** * Render a divider. */ Divider = 1, /** * Render menu item as a header. */ Header = 2 } /** * Enum for the possible values of shared depth of the dynamic data reference. * * @public * @deprecated This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. * Please consume it from there. * @remarks We have left the original implementation here to avoid breaking the public API contract. */ export declare enum DynamicDataSharedDepth { /** * Indicates that nothing is shared. */ None = 0, /** * Indicates that the dynamic data source is shared. */ Source = 1, /** * Indicates that both the dynamic data source and the property are shared. */ Property = 2 } //# sourceMappingURL=SPPropertyPane.d.ts.map