@excentone/spfx-react
Version:
Contains custom ReactJs components and hooks intended to use when developing SharePoint Framework (SPFx) Web components.
8 lines (7 loc) • 652 B
TypeScript
/**
* `usePropertyValue` is used to get the value of the property from the SPFx webpart's or application extension's `properties` object, which usually contains the configuration for the whole webpart/application extension.
* @param propertyPath The path to the property to get the value of.
* @param defaultValue The value to return if the property path was not found. Default: `undefined`.
* @returns The value of the property, or undefined if the property path does not exists in the `properties` object.
*/
export declare const usePropertyValue: <T>(propertyPath: string, defaultValue?: any, converterFunction?: (propValue: any) => T) => any;