UNPKG

@mikezimm/fps-library-v2

Version:

Library of reusable typescript/javascript functions, interfaces and constants

149 lines (148 loc) 7.81 kB
/** * CodeAnalizerComment: Updated 7 imports on 2024-09-22 14:49:52 * Update:: import { IFPSEnviro } to '@mikezimm/fps-core-v7/lib/banner/features/FPSDOM/IFPSEnviro;' * Update:: import { webpartInstance } to '@mikezimm/fps-core-v7/lib/banner/features/FPSDOM/FPSDocument;' * Update:: import { IFPSSiteThemes } to '@mikezimm/fps-core-v7/lib/banner/FPSWebPartClass/IThisFPSWebPartClass1152;' * Update:: import { IFieldPanelMode } to '@mikezimm/fps-core-v7/lib/banner/FPSWebPartClass/IThisFPSWebPartClass1152;' * Update:: import { AnalyticsWeb } to '@mikezimm/fps-core-v7/lib/components/atoms/easy-analytics/interfaces/constants;' * Update:: import { IPropertyPaneDropdownOption } to '@mikezimm/fps-core-v7/lib/types/@msft/1.15.2/sp-property-pane;' * Update:: import { IFPSListItemPropPaneDropDownOption } to '@mikezimm/fps-core-v7/lib/banner/components/ItemPicker/interfaces/IFPSListItemPropPaneDropDownOption;' */ import { BaseClientSideWebPart } from '@microsoft/sp-webpart-base'; import { IFPSEnviro } from '@mikezimm/fps-core-v7/lib/banner/features/FPSDOM/IFPSEnviro'; import { ISitePreConfigProps } from '@mikezimm/fps-core-v7/lib/common/PropPaneHelp/preconfig/IPreConfig'; import { IRepoLinks } from '@mikezimm/fps-core-v7/lib/components/atoms/Links/IRepoLinks'; import { IFieldPanelDesignMode } from '@mikezimm/fps-core-v7/lib/components/molecules/FieldPanel/interfaces/IMinWPFieldPanelProps'; import { ILoadPerformance, ILoadPerformanceOps } from '@mikezimm/fps-core-v7/lib/components/molecules/Performance/IPerformance'; import { IFPSUser } from '@mikezimm/fps-core-v7/lib/components/atoms/Users/IUserInterfaces'; import { IFPSSiteThemes, IFieldPanelMode } from '@mikezimm/fps-core-v7/lib/banner/FPSWebPartClass/IThisFPSWebPartClass1152'; import { IFPSCert } from '@mikezimm/fps-core-v7/lib/banner/FPSWebPartClass/IFPSCert'; import { IFullBackgroundMode } from '@mikezimm/fps-core-v7/lib/components/molecules/FullPageBackGround/interfaces/IFPSPageBGWPProps'; import { IPropertyPaneDropdownOption } from '@mikezimm/fps-core-v7/lib/types/@msft/1.15.2/sp-property-pane'; import { IFPSListItemPropPaneDropDownOption } from '@mikezimm/fps-core-v7/lib/banner/components/ItemPicker/interfaces/IFPSListItemPropPaneDropDownOption'; import { IFpsSpHttpServiceMIN } from '@mikezimm/fps-core-v7/lib/components/molecules/SpHttp/Sp/IFpsSpHttpServiceMIN'; import { ISourceRowRender } from '@mikezimm/fps-core-v7/lib/components/molecules/SourcePage/ISourceRowRender'; import { IFPSGeneric_JSX_Element } from '@mikezimm/fps-core-v7/lib/types/react/IFPSJSX_Element'; export declare abstract class FPSBaseClass<TProperties> extends BaseClientSideWebPart<TProperties> { /** * These are intended to be set or adjusted right at the beginning of the main webpart class */ protected _repoLink: IRepoLinks; protected _exportIgnorePropsWP: string[]; protected _importBlockPropsWP: string[]; protected _trickyApp: string; protected _trickyEmailsWP: string[]; protected _panelVersion: string; protected _analyticsListX: string; protected _analyticsWebX: string; protected _analyticsOptionsX: string[]; protected _wpTDLeft: string[]; protected _wpTDRight: string[]; protected _wpFilterProps: string[]; protected _fpsSpService: IFpsSpHttpServiceMIN; protected _fpsSiteThemes: IFPSSiteThemes; protected _fpsSiteThemeDark: string; protected _fpsSiteThemeLight: string; protected _fpsSiteThemePrimary: string; /** * Help Page Links for _class PreConfigProps */ protected _tenantHelpUrl: string; protected _tenanatFirst5: string; protected _tenantGetStartedUrl: string; protected _tenantPolicies: string; protected _youtubeChannel: string; protected _youtubeFirst5: string; protected _youtubeHelp: string; protected _youtubeGetStarted: string; /** * These are preset but likely to be adjusted in each webpart as needed */ protected _allowPinMe: boolean; /** * These are preset and NOT Likely to need adjustments */ protected _forceBanner: boolean; protected _modifyBannerTitle: boolean; protected _modifyBannerStyle: boolean; protected _keysToShow: ILoadPerformanceOps[]; protected _allowQuickLaunchHide: boolean; protected _allowSocialBarHide: boolean; protected _allowToolBarHide: boolean; protected _allowAllSectWidth: boolean; protected _allowBeAUser: boolean; protected _allowFeedback: boolean; protected _allowPandoramic: boolean; protected _allowSiteThemeChoice: boolean; protected _allowEasyPages: boolean; protected _allowFullPageBG: IFullBackgroundMode; protected _allowFieldPanel: IFieldPanelMode; protected _allowPropsEasyMode: boolean; protected _expandPropsEasyModeCount: number; protected _wpInfoGroupExpanded: boolean; protected _lastPropPaneChange: string; protected _FieldPanelDesignMode: IFieldPanelDesignMode; protected _FieldPanelWebProp: 'webUrl' | string; protected _FieldPanelListProp: 'listTitle' | string; protected _doHeadingStyles: boolean; protected _imageWPInfo: string; protected _imagePlace: string; protected _allowShowSearch: boolean; /** * These are updated later in the code */ _performance: ILoadPerformance; _sitePresets: ISitePreConfigProps; _FPSUser: IFPSUser; _FPSEnviro: IFPSEnviro; _IFPSCert: IFPSCert[]; /** * These are preset and should be managed by the code... do not change in main webpart class */ protected _wpInstanceID: string; protected _FPSId: string; protected _exitPropPaneChanged: boolean; protected _importErrorMessage: string; protected _trickyEmailsAll: string[]; protected _isSPA: boolean; protected _urlParameters: any; _beAReader: boolean; protected _listPickerValue: string; protected _webUrlPickerValue: string; protected _webUrlPickerValueApproved: boolean; protected _listItemPickerValue: string; protected _runSandbox: boolean; protected _listsDropdownDisabled: boolean; protected _itemsDropdownDisabled: boolean; protected _listItemsPickerList: IPropertyPaneDropdownOption[]; protected _listPickerList: IFPSListItemPropPaneDropDownOption[]; protected _approvedLists: IFPSListItemPropPaneDropDownOption[]; protected _approvedFilePickerTypes: string[]; protected _fetchInstance: string; protected _hardExpire: boolean; /** * These are functions used in the class */ protected _beAUserFunction(): void; /** * This was added per https://github.com/mikezimm/Slick-Sections/issues/27 * Basically took functionality developed in SlickSections and rolling it up into class so it can be used anywhere * * export type ICallbackAddParamToUrl = ( newParamStr: string, reRender: boolean, newTab: boolean ) => void; * * @param newParamStr * @param reRender * @param newTab */ protected _addParamToUrl(newParamStr: string, reRender?: boolean, newTab?: boolean): void; protected _refreshBGStyles(): void; protected _resetEasyIcons(): void; protected _saveFieldPanelViewsFunction(viewsProps: any): void; protected _saveFieldPanelCommandsFunction(commands: any): void; protected onPropertyPaneConfigurationComplete(): void; protected refreshPaneReRender(): void; protected _forceMainRender(): void; protected _renderItemsRow: ((props: ISourceRowRender) => IFPSGeneric_JSX_Element) | null; protected _renderBarsRow: ((props: ISourceRowRender) => IFPSGeneric_JSX_Element) | null; } //# sourceMappingURL=FPSBaseClass.d.ts.map