UNPKG

@mikezimm/fps-library-v2

Version:

Library of reusable typescript/javascript functions, interfaces and constants

28 lines (27 loc) 1.52 kB
/// <reference types="react" /> import { IReactJSONSettingsV1 } from '../../../components/atoms/ReactJSON/IReactJSONSettingsV2'; /** * This gets called by getHelpHandleBarsPivotItem... use it as primary entry point if possible. * @param reactJSONSettings * @param explained * @returns */ export declare function buildHandleBarsJSONObjectHelp(reactJSONSettings: IReactJSONSettingsV1, explained: JSX.Element): JSX.Element; /** * * @param reactJSONSettings * @param explained - see comment example below * @returns This is the 'explained' element from Network-Builder for an example: <div className={ 'fps-pph-topic' }>This is what it should create:</div> <ul> <li><b>Title</b> Column will be something like <b>CompanyX - Youtube</b></li> <li><b>Link</b> Column will be something like <b>`{ `{ "Url": "LinkUrlFromForm", "Description": "LinkUrlFromForm" }` }`</b></li> <li><b>LinkType</b> Column will be something like <b>Youtube</b></li> <li><b>ImageUrl</b> Column will be something like <b>/sites/Collection/Library/CompanyX.png</b></li> <li><b>CompanyLogo</b> Column will be something like <b>{ LogosBase }/CompanyX Logo.png</b></li> <li><b>Company</b> Column will be something like <b>CompanyX</b></li> </ul> */ export declare function getHelpHandleBarsPivotItem(reactJSONSettings: IReactJSONSettingsV1, explained: JSX.Element): JSX.Element; //# sourceMappingURL=HandleBarsJSONObjectHelp.d.ts.map