{ "kind": "package", "name": "gpgbk-fabric-react", "summary": [], "remarks": [], "exports": { "ActionButton": { "kind": "class", "extends": "BaseComponent", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "_skipComponentRefResolution": { "kind": "property", "signature": "protected _skipComponentRefResolution: boolean;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "boolean", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Tell BaseComponent to bypass resolution of componentRef." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "ActivityItem": { "kind": "class", "extends": "BaseComponent", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(props: IActivityItemProps);", "parameters": { "props": { "name": "props", "description": [], "isOptional": false, "isSpread": false, "type": "IActivityItemProps" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Constructs a new instance of the " }, { "kind": "api-link", "elements": [ { "kind": "text", "text": "ActivityItem" } ], "target": { "scopeName": "", "packageName": "gpgbk-fabric-react", "exportName": "ActivityItem", "memberName": "" } }, { "kind": "text", "text": " class" } ], "remarks": [] }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "addDirectionalKeyCode": { "kind": "function", "signature": "export function addDirectionalKeyCode(which: number): void;", "returnValue": { "type": "void", "description": [] }, "parameters": { "which": { "name": "which", "description": [], "isOptional": false, "isSpread": false, "type": "number" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Adds a keycode to the list of keys that, when pressed, should cause the focus outlines to be visible. This can be used to add global shortcut keys that directionally move from section to section within an app or between focus trap zones." } ], "remarks": [], "isBeta": false }, "addElementAtIndex": { "kind": "function", "signature": "export function addElementAtIndex(array: T[], index: number, itemToAdd: T): T[];", "returnValue": { "type": "T[]", "description": [] }, "parameters": { "array": { "name": "array", "description": [ { "kind": "text", "text": "The array to operate on" } ], "isOptional": false, "isSpread": false, "type": "T[]" }, "index": { "name": "index", "description": [ { "kind": "text", "text": "The index where an element should be inserted" } ], "isOptional": false, "isSpread": false, "type": "number" }, "itemToAdd": { "name": "itemToAdd", "description": [ { "kind": "text", "text": "The element to insert" } ], "isOptional": false, "isSpread": false, "type": "T" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Given an array, this function returns a new array where an element has been inserted at the given index." } ], "remarks": [], "isBeta": false }, "arraysEqual": { "kind": "function", "signature": "export function arraysEqual(array1: T[], array2: T[]): boolean;", "returnValue": { "type": "boolean", "description": [ { "kind": "text", "text": "True if the arrays are the same length and have the same values in the same positions, false otherwise." } ] }, "parameters": { "array1": { "name": "array1", "description": [ { "kind": "text", "text": "First array to compare" } ], "isOptional": false, "isSpread": false, "type": "T[]" }, "array2": { "name": "array2", "description": [ { "kind": "text", "text": "Second array to compare" } ], "isOptional": false, "isSpread": false, "type": "T[]" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Returns a boolean indicating if the two given arrays are equal in length and values." } ], "remarks": [], "isBeta": false }, "asAsync": { "kind": "function", "signature": "export function asAsync(options: IAsAsyncOptions): React.ComponentType;", "returnValue": { "type": "React.ComponentType", "description": [] }, "parameters": { "options": { "name": "options", "description": [], "isOptional": false, "isSpread": false, "type": "IAsAsyncOptions" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Produces a component which internally loads the target component before first mount. The component passes all props through to the loaded component." }, { "kind": "paragraph" }, { "kind": "text", "text": "This overload accepts a module with a default export for the component." } ], "remarks": [], "isBeta": false }, "assertNever": { "kind": "function", "signature": "export function assertNever(x: never): never;", "returnValue": { "type": "never", "description": [] }, "parameters": { "x": { "name": "x", "description": [], "isOptional": false, "isSpread": false, "type": "never" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "AssertNever is a utility function that can be used for exhaustiveness checks in switch statements." } ], "remarks": [], "isBeta": false }, "assign": { "kind": "function", "signature": "export function assign(target: any, ...args: any[]): any;", "returnValue": { "type": "any", "description": [ { "kind": "text", "text": "Resulting merged target." } ] }, "parameters": { "target": { "name": "target", "description": [ { "kind": "text", "text": "Target object to merge following object arguments into." } ], "isOptional": false, "isSpread": false, "type": "any" }, "args": { "name": "args", "description": [ { "kind": "text", "text": "One or more objects that will be mixed into the target in the order they are provided." } ], "isOptional": false, "isSpread": true, "type": "any[]" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Makes a resulting merge of a bunch of objects. Pass in the target object followed by 1 or more objects as arguments and they will be merged sequentially into the target. Note that this will shallow merge; it will not create new cloned values for target members." } ], "remarks": [], "isBeta": false }, "Async": { "kind": "class", "extends": "", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Bugs often appear in async code when stuff gets disposed, but async operations don't get canceled. This Async helper class solves these issues by tying async code to the lifetime of a disposable object." }, { "kind": "paragraph" }, { "kind": "text", "text": "Usage: Anything class extending from BaseModel can access this helper via this.async. Otherwise create a new instance of the class and remember to call dispose() during your code's dispose handler." } ], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(parent?: object, onError?: (e: any) => void);", "parameters": { "parent": { "name": "parent", "description": [], "isOptional": true, "isSpread": false, "type": "object" }, "onError": { "name": "onError", "description": [], "isOptional": true, "isSpread": false, "type": "(e: any) => void" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Constructs a new instance of the " }, { "kind": "api-link", "elements": [ { "kind": "text", "text": "Async" } ], "target": { "scopeName": "", "packageName": "gpgbk-fabric-react", "exportName": "Async", "memberName": "" } }, { "kind": "text", "text": " class" } ], "remarks": [] }, "_logError": { "kind": "method", "signature": "protected _logError(e: any): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "e": { "name": "e", "description": [], "isOptional": false, "isSpread": false, "type": "any" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "cancelAnimationFrame": { "kind": "method", "signature": "cancelAnimationFrame(id: number): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "id": { "name": "id", "description": [], "isOptional": false, "isSpread": false, "type": "number" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "clearImmediate": { "kind": "method", "signature": "clearImmediate(id: number): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "id": { "name": "id", "description": [ { "kind": "text", "text": "Id to cancel." } ], "isOptional": false, "isSpread": false, "type": "number" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Clears the immediate." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "clearInterval": { "kind": "method", "signature": "clearInterval(id: number): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "id": { "name": "id", "description": [ { "kind": "text", "text": "Id to cancel." } ], "isOptional": false, "isSpread": false, "type": "number" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Clears the interval." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "clearTimeout": { "kind": "method", "signature": "clearTimeout(id: number): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "id": { "name": "id", "description": [ { "kind": "text", "text": "Id to cancel." } ], "isOptional": false, "isSpread": false, "type": "number" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Clears the timeout." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "debounce": { "kind": "method", "signature": "debounce(func: T, wait?: number, options?: {\n leading?: boolean;\n maxWait?: number;\n trailing?: boolean;\n }): ICancelable & (() => void);", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "ICancelable & (() => void)", "description": [ { "kind": "text", "text": "The new debounced function." } ] }, "parameters": { "func": { "name": "func", "description": [ { "kind": "text", "text": "The function to debounce." } ], "isOptional": false, "isSpread": false, "type": "T" }, "wait": { "name": "wait", "description": [ { "kind": "text", "text": "The number of milliseconds to delay." } ], "isOptional": true, "isSpread": false, "type": "number" }, "options": { "name": "options", "description": [ { "kind": "text", "text": "The options object." } ], "isOptional": true, "isSpread": false, "type": "{\n leading?: boolean;\n maxWait?: number;\n trailing?: boolean;\n }" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Creates a function that will delay the execution of func until after wait milliseconds have elapsed since the last time it was invoked. Provide an options object to indicate that func should be invoked on the leading and/or trailing edge of the wait timeout. Subsequent calls to the debounced function will return the result of the last func call." }, { "kind": "paragraph" }, { "kind": "text", "text": "Note: If leading and trailing options are true func will be called on the trailing edge of the timeout only if the the debounced function is invoked more than once during the wait timeout." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "dispose": { "kind": "method", "signature": "dispose(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Dispose function, clears all async operations." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "requestAnimationFrame": { "kind": "method", "signature": "requestAnimationFrame(callback: () => void): number;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "number", "description": [] }, "parameters": { "callback": { "name": "callback", "description": [], "isOptional": false, "isSpread": false, "type": "() => void" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "setImmediate": { "kind": "method", "signature": "setImmediate(callback: () => void): number;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "number", "description": [ { "kind": "text", "text": "The setTimeout id." } ] }, "parameters": { "callback": { "name": "callback", "description": [ { "kind": "text", "text": "Callback to execute." } ], "isOptional": false, "isSpread": false, "type": "() => void" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "SetImmediate override, which will auto cancel the immediate during dispose." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "setInterval": { "kind": "method", "signature": "setInterval(callback: () => void, duration: number): number;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "number", "description": [ { "kind": "text", "text": "The setTimeout id." } ] }, "parameters": { "callback": { "name": "callback", "description": [ { "kind": "text", "text": "Callback to execute." } ], "isOptional": false, "isSpread": false, "type": "() => void" }, "duration": { "name": "duration", "description": [ { "kind": "text", "text": "Duration in milliseconds." } ], "isOptional": false, "isSpread": false, "type": "number" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "SetInterval override, which will auto cancel the timeout during dispose." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "setTimeout": { "kind": "method", "signature": "setTimeout(callback: () => void, duration: number): number;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "number", "description": [ { "kind": "text", "text": "The setTimeout id." } ] }, "parameters": { "callback": { "name": "callback", "description": [ { "kind": "text", "text": "Callback to execute." } ], "isOptional": false, "isSpread": false, "type": "() => void" }, "duration": { "name": "duration", "description": [ { "kind": "text", "text": "Duration in milliseconds." } ], "isOptional": false, "isSpread": false, "type": "number" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "SetTimeout override, which will auto cancel the timeout during dispose." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "throttle": { "kind": "method", "signature": "throttle(func: T, wait?: number, options?: {\n leading?: boolean;\n trailing?: boolean;\n }): T | (() => void);", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "T | (() => void)", "description": [ { "kind": "text", "text": "The new throttled function." } ] }, "parameters": { "func": { "name": "func", "description": [ { "kind": "text", "text": "The function to throttle." } ], "isOptional": false, "isSpread": false, "type": "T" }, "wait": { "name": "wait", "description": [ { "kind": "text", "text": "The number of milliseconds to throttle executions to. Defaults to 0." } ], "isOptional": true, "isSpread": false, "type": "number" }, "options": { "name": "options", "description": [ { "kind": "text", "text": "The options object." } ], "isOptional": true, "isSpread": false, "type": "{\n leading?: boolean;\n trailing?: boolean;\n }" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Creates a function that, when executed, will only call the func function at most once per every wait milliseconds. Provide an options object to indicate that func should be invoked on the leading and/or trailing edge of the wait timeout. Subsequent calls to the throttled function will return the result of the last func call." }, { "kind": "paragraph" }, { "kind": "text", "text": "Note: If leading and trailing options are true func will be called on the trailing edge of the timeout only if the the throttled function is invoked more than once during the wait timeout." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "autobind": { "kind": "function", "signature": "export function autobind(target: any, key: string, descriptor: TypedPropertyDescriptor): {\n configurable: boolean;\n get(): T;\n set(newValue: any): void;\n} | void;", "returnValue": { "type": "{\n configurable: boolean;\n get(): T;\n set(newValue: any): void;\n} | void", "description": [] }, "parameters": { "target": { "name": "target", "description": [], "isOptional": false, "isSpread": false, "type": "any" }, "key": { "name": "key", "description": [], "isOptional": false, "isSpread": false, "type": "string" }, "descriptor": { "name": "descriptor", "description": [], "isOptional": false, "isSpread": false, "type": "TypedPropertyDescriptor" } }, "deprecatedMessage": [ { "kind": "text", "text": "This has been deprecated in favor of using arrow function properties" } ], "summary": [ { "kind": "text", "text": "Autobind is a utility for binding methods in a class. This simplifies tagging methods as being \"bound\" to the this pointer so that they can be used in scenarios that simply require a function callback." } ], "remarks": [], "isBeta": false }, "Autofill": { "kind": "class", "extends": "BaseComponent", "implements": "IAutofill", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(props: IAutofillProps);", "parameters": { "props": { "name": "props", "description": [], "isOptional": false, "isSpread": false, "type": "IAutofillProps" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Constructs a new instance of the " }, { "kind": "api-link", "elements": [ { "kind": "text", "text": "Autofill" } ], "target": { "scopeName": "", "packageName": "gpgbk-fabric-react", "exportName": "Autofill", "memberName": "" } }, { "kind": "text", "text": " class" } ], "remarks": [] }, "clear": { "kind": "method", "signature": "clear(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentDidUpdate": { "kind": "method", "signature": "componentDidUpdate(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentWillReceiveProps": { "kind": "method", "signature": "componentWillReceiveProps(nextProps: IAutofillProps): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "nextProps": { "name": "nextProps", "description": [], "isOptional": false, "isSpread": false, "type": "IAutofillProps" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "cursorLocation": { "kind": "property", "signature": "readonly cursorLocation: number | null;", "isOptional": false, "isReadOnly": true, "isStatic": false, "type": "number | null", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "defaultProps": { "kind": "property", "signature": "static defaultProps:", "isOptional": false, "isReadOnly": false, "isStatic": true, "type": "{\n enableAutofillOnKeyPress: KeyCodes[];\n }", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "focus": { "kind": "method", "signature": "focus(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "inputElement": { "kind": "property", "signature": "readonly inputElement: HTMLInputElement | null;", "isOptional": false, "isReadOnly": true, "isStatic": false, "type": "HTMLInputElement | null", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "isValueSelected": { "kind": "property", "signature": "readonly isValueSelected: boolean;", "isOptional": false, "isReadOnly": true, "isStatic": false, "type": "boolean", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "selectionEnd": { "kind": "property", "signature": "readonly selectionEnd: number | null;", "isOptional": false, "isReadOnly": true, "isStatic": false, "type": "number | null", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "selectionStart": { "kind": "property", "signature": "readonly selectionStart: number | null;", "isOptional": false, "isReadOnly": true, "isStatic": false, "type": "number | null", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "value": { "kind": "property", "signature": "readonly value: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, "type": "string", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false } } }, "AutoScroll": { "kind": "class", "extends": "", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "AutoScroll simply hooks up mouse events given a parent element, and scrolls the container up/down depending on how close the mouse is to the top/bottom of the container." }, { "kind": "paragraph" }, { "kind": "text", "text": "Once you don't want autoscroll any more, just dispose the helper and it will unhook events." } ], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(element: HTMLElement);", "parameters": { "element": { "name": "element", "description": [], "isOptional": false, "isSpread": false, "type": "HTMLElement" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Constructs a new instance of the " }, { "kind": "api-link", "elements": [ { "kind": "text", "text": "AutoScroll" } ], "target": { "scopeName": "", "packageName": "gpgbk-fabric-react", "exportName": "AutoScroll", "memberName": "" } }, { "kind": "text", "text": " class" } ], "remarks": [] }, "dispose": { "kind": "method", "signature": "dispose(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "BaseAutoFill": { "kind": "class", "extends": "Autofill", "implements": "", "typeParameters": [], "deprecatedMessage": [ { "kind": "text", "text": "do not use." } ], "summary": [], "remarks": [], "isBeta": false, "isSealed": false }, "BaseButton": { "kind": "class", "extends": "BaseComponent", "implements": "IButton", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(props: IBaseButtonProps, rootClassName: string);", "parameters": { "props": { "name": "props", "description": [], "isOptional": false, "isSpread": false, "type": "IBaseButtonProps" }, "rootClassName": { "name": "rootClassName", "description": [], "isOptional": false, "isSpread": false, "type": "string" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Constructs a new instance of the " }, { "kind": "api-link", "elements": [ { "kind": "text", "text": "BaseButton" } ], "target": { "scopeName": "", "packageName": "gpgbk-fabric-react", "exportName": "BaseButton", "memberName": "" } }, { "kind": "text", "text": " class" } ], "remarks": [] }, "componentDidMount": { "kind": "method", "signature": "componentDidMount(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentDidUpdate": { "kind": "method", "signature": "componentDidUpdate(prevProps: IBaseButtonProps, prevState: IBaseButtonState): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "prevProps": { "name": "prevProps", "description": [], "isOptional": false, "isSpread": false, "type": "IBaseButtonProps" }, "prevState": { "name": "prevState", "description": [], "isOptional": false, "isSpread": false, "type": "IBaseButtonState" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "defaultProps": { "kind": "property", "signature": "static defaultProps: Partial;", "isOptional": false, "isReadOnly": false, "isStatic": true, "type": "Partial", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "dismissMenu": { "kind": "method", "signature": "dismissMenu(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "focus": { "kind": "method", "signature": "focus(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "openMenu": { "kind": "method", "signature": "openMenu(shouldFocusOnContainer?: boolean, shouldFocusOnMount?: boolean): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "shouldFocusOnContainer": { "name": "shouldFocusOnContainer", "description": [], "isOptional": true, "isSpread": false, "type": "boolean" }, "shouldFocusOnMount": { "name": "shouldFocusOnMount", "description": [], "isOptional": true, "isSpread": false, "type": "boolean" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "BaseComponent": { "kind": "class", "extends": "React.Component", "implements": "", "typeParameters": [ "TProps extends IBaseProps = {}", "TState = {}" ], "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "BaseComponent class, which provides basic helpers for all components." } ], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(props: TProps, context?: any);", "parameters": { "props": { "name": "props", "description": [ { "kind": "text", "text": "The props for the component." } ], "isOptional": false, "isSpread": false, "type": "TProps" }, "context": { "name": "context", "description": [ { "kind": "text", "text": "The context for the component." } ], "isOptional": true, "isSpread": false, "type": "any" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "BaseComponent constructor" } ], "remarks": [] }, "_async": { "kind": "property", "signature": "protected readonly _async: Async;", "isOptional": false, "isReadOnly": true, "isStatic": false, "type": "Async", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Gets the async instance associated with the component, created on demand. The async instance gives subclasses a way to execute setTimeout/setInterval async calls safely, where the callbacks will be cleared/ignored automatically after unmounting. The helpers within the async object also preserve the this pointer so that you don't need to \"bind\" the callbacks." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "_disposables": { "kind": "property", "signature": "protected readonly _disposables: IDisposable[];", "isOptional": false, "isReadOnly": true, "isStatic": false, "type": "IDisposable[]", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Allows subclasses to push things to this._disposables to be auto disposed." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "_events": { "kind": "property", "signature": "protected readonly _events: EventGroup;", "isOptional": false, "isReadOnly": true, "isStatic": false, "type": "EventGroup", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Gets the event group instance assocaited with the component, created on demand. The event instance provides on/off methods for listening to DOM (or regular javascript object) events. The event callbacks will be automatically disconnected after unmounting. The helpers within the events object also preserve the this reference so that you don't need to \"bind\" the callbacks." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "_resolveRef": { "kind": "method", "signature": "protected _resolveRef(refName: string): (ref: React.ReactNode) => React.ReactNode;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "(ref: React.ReactNode) => React.ReactNode", "description": [ { "kind": "text", "text": "A function instance keyed from the given refname." } ] }, "parameters": { "refName": { "name": "refName", "description": [ { "kind": "text", "text": "Name of the member to assign the ref to." } ], "isOptional": false, "isSpread": false, "type": "string" } }, "deprecatedMessage": [ { "kind": "text", "text": "Use " }, { "kind": "code", "text": "createRef", "highlighter": "plain" }, { "kind": "text", "text": " from React.createRef." } ], "summary": [ { "kind": "text", "text": "Helper to return a memoized ref resolver function." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "_skipComponentRefResolution": { "kind": "property", "signature": "protected _skipComponentRefResolution: boolean;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "boolean", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Controls whether the componentRef prop will be resolved by this component instance. If you are implementing a passthrough (higher-order component), you would set this to false and pass through the props to the inner component, allowing it to resolve the componentRef." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "_updateComponentRef": { "kind": "method", "signature": "protected _updateComponentRef(currentProps: IBaseProps, newProps?: IBaseProps): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "currentProps": { "name": "currentProps", "description": [], "isOptional": false, "isSpread": false, "type": "IBaseProps" }, "newProps": { "name": "newProps", "description": [], "isOptional": true, "isSpread": false, "type": "IBaseProps" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Updates the componentRef (by calling it with \"this\" when necessary.)" } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "_warnConditionallyRequiredProps": { "kind": "method", "signature": "protected _warnConditionallyRequiredProps(requiredProps: string[], conditionalPropName: string, condition: boolean): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "requiredProps": { "name": "requiredProps", "description": [ { "kind": "text", "text": "The name of the props that are required when the condition is met." } ], "isOptional": false, "isSpread": false, "type": "string[]" }, "conditionalPropName": { "name": "conditionalPropName", "description": [ { "kind": "text", "text": "The name of the prop that the condition is based on." } ], "isOptional": false, "isSpread": false, "type": "string" }, "condition": { "name": "condition", "description": [ { "kind": "text", "text": "Whether the condition is met." } ], "isOptional": false, "isSpread": false, "type": "boolean" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Warns when props are required if a condition is met." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "_warnDeprecations": { "kind": "method", "signature": "protected _warnDeprecations(deprecationMap: ISettingsMap): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "deprecationMap": { "name": "deprecationMap", "description": [ { "kind": "text", "text": "The map of deprecations, where key is the prop name and the value is either null or a replacement prop name." } ], "isOptional": false, "isSpread": false, "type": "ISettingsMap" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Warns when a deprecated props are being used." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "_warnMutuallyExclusive": { "kind": "method", "signature": "protected _warnMutuallyExclusive(mutuallyExclusiveMap: ISettingsMap): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "mutuallyExclusiveMap": { "name": "mutuallyExclusiveMap", "description": [ { "kind": "text", "text": "The map of mutually exclusive props." } ], "isOptional": false, "isSpread": false, "type": "ISettingsMap" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Warns when props which are mutually exclusive with each other are both used." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "className": { "kind": "property", "signature": "readonly className: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, "type": "string", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Gets the object's class name." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "componentDidMount": { "kind": "method", "signature": "componentDidMount(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "When the component has mounted, update the componentRef." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentWillReceiveProps": { "kind": "method", "signature": "componentWillReceiveProps(newProps: Readonly, newContext: any): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "newProps": { "name": "newProps", "description": [], "isOptional": false, "isSpread": false, "type": "Readonly" }, "newContext": { "name": "newContext", "description": [], "isOptional": false, "isSpread": false, "type": "any" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "When the component will receive props, make sure the componentRef is updated." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentWillUnmount": { "kind": "method", "signature": "componentWillUnmount(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "If we have disposables, dispose them automatically on unmount." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "onError": { "kind": "property", "signature": "static onError: ((errorMessage?: string, ex?: any) => void);", "isOptional": false, "isReadOnly": false, "isStatic": true, "type": "((errorMessage?: string, ex?: any) => void)", "deprecatedMessage": [ { "kind": "text", "text": "Use React's error boundaries instead." } ], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false } } }, "BaseExtendedPeoplePicker": { "kind": "class", "extends": "BaseExtendedPicker", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false }, "BaseExtendedPicker": { "kind": "class", "extends": "BaseComponent", "implements": "IBaseExtendedPicker", "typeParameters": [ "T", "P extends IBaseExtendedPickerProps" ], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(basePickerProps: P);", "parameters": { "basePickerProps": { "name": "basePickerProps", "description": [], "isOptional": false, "isSpread": false, "type": "P" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Constructs a new instance of the " }, { "kind": "api-link", "elements": [ { "kind": "text", "text": "BaseExtendedPicker" } ], "target": { "scopeName": "", "packageName": "gpgbk-fabric-react", "exportName": "BaseExtendedPicker", "memberName": "" } }, { "kind": "text", "text": " class" } ], "remarks": [] }, "_onSelectedItemsChanged": { "kind": "property", "signature": "protected _onSelectedItemsChanged: () => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "() => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "_onSuggestionSelected": { "kind": "property", "signature": "protected _onSuggestionSelected: (item: T) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(item: T) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "canAddItems": { "kind": "method", "signature": "protected canAddItems(): boolean;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "boolean", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "clearInput": { "kind": "method", "signature": "clearInput(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentDidMount": { "kind": "method", "signature": "componentDidMount(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentWillReceiveProps": { "kind": "method", "signature": "componentWillReceiveProps(newProps: P): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "newProps": { "name": "newProps", "description": [], "isOptional": false, "isSpread": false, "type": "P" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "floatingPicker": { "kind": "property", "signature": "floatingPicker:", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "{\n (component: BaseFloatingPicker> | null): void;\n current: BaseFloatingPicker> | null;\n value: BaseFloatingPicker> | null;\n }", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "floatingPickerProps": { "kind": "property", "signature": "protected floatingPickerProps: IBaseFloatingPickerProps;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "IBaseFloatingPickerProps", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "focus": { "kind": "method", "signature": "focus(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "highlightedItems": { "kind": "property", "signature": "readonly highlightedItems: T[];", "isOptional": false, "isReadOnly": true, "isStatic": false, "type": "T[]", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "input": { "kind": "property", "signature": "protected input:", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "{\n (component: Autofill | null): void;\n current: Autofill | null;\n value: Autofill | null;\n }", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "inputElement": { "kind": "property", "signature": "readonly inputElement: HTMLInputElement | null;", "isOptional": false, "isReadOnly": true, "isStatic": false, "type": "HTMLInputElement | null", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "items": { "kind": "property", "signature": "readonly items: any;", "isOptional": false, "isReadOnly": true, "isStatic": false, "type": "any", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "onBackspace": { "kind": "property", "signature": "protected onBackspace: (ev: React.KeyboardEvent) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(ev: React.KeyboardEvent) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "onCopy": { "kind": "property", "signature": "protected onCopy: (ev: React.ClipboardEvent) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(ev: React.ClipboardEvent) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "onInputChange": { "kind": "property", "signature": "protected onInputChange: (value: string) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(value: string) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "onInputClick": { "kind": "property", "signature": "protected onInputClick: (ev: React.MouseEvent) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(ev: React.MouseEvent) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "onInputFocus": { "kind": "property", "signature": "protected onInputFocus: (ev: React.FocusEvent) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(ev: React.FocusEvent) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "onPaste": { "kind": "property", "signature": "protected onPaste: (ev: React.ClipboardEvent) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(ev: React.ClipboardEvent) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "onSelectionChange": { "kind": "property", "signature": "protected onSelectionChange: () => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "() => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "renderSelectedItemsList": { "kind": "method", "signature": "protected renderSelectedItemsList(): JSX.Element;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "renderSuggestions": { "kind": "method", "signature": "protected renderSuggestions(): JSX.Element;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "root": { "kind": "property", "signature": "protected root:", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "{\n (component: HTMLDivElement | null): void;\n current: HTMLDivElement | null;\n value: HTMLDivElement | null;\n }", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "selectedItemsList": { "kind": "property", "signature": "selectedItemsList:", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "{\n (component: BaseSelectedItemsList> | null): void;\n current: BaseSelectedItemsList> | null;\n value: BaseSelectedItemsList> | null;\n }", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "selectedItemsListProps": { "kind": "property", "signature": "protected selectedItemsListProps: IBaseSelectedItemsListProps;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "IBaseSelectedItemsListProps", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "selection": { "kind": "property", "signature": "protected selection: Selection;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "Selection", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false } } }, "BaseFloatingPeoplePicker": { "kind": "class", "extends": "BaseFloatingPicker", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false }, "BaseFloatingPicker": { "kind": "class", "extends": "BaseComponent", "implements": "IBaseFloatingPicker", "typeParameters": [ "T", "P extends IBaseFloatingPickerProps" ], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(basePickerProps: P);", "parameters": { "basePickerProps": { "name": "basePickerProps", "description": [], "isOptional": false, "isSpread": false, "type": "P" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Constructs a new instance of the " }, { "kind": "api-link", "elements": [ { "kind": "text", "text": "BaseFloatingPicker" } ], "target": { "scopeName": "", "packageName": "gpgbk-fabric-react", "exportName": "BaseFloatingPicker", "memberName": "" } }, { "kind": "text", "text": " class" } ], "remarks": [] }, "completeSuggestion": { "kind": "property", "signature": "completeSuggestion: () => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "() => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "componentDidMount": { "kind": "method", "signature": "componentDidMount(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentDidUpdate": { "kind": "method", "signature": "componentDidUpdate(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentWillReceiveProps": { "kind": "method", "signature": "componentWillReceiveProps(newProps: P): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "newProps": { "name": "newProps", "description": [], "isOptional": false, "isSpread": false, "type": "P" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentWillUnmount": { "kind": "method", "signature": "componentWillUnmount(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "currentPromise": { "kind": "property", "signature": "protected currentPromise: PromiseLike;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "PromiseLike", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "currentSelectedSuggestionIndex": { "kind": "property", "signature": "readonly currentSelectedSuggestionIndex: number;", "isOptional": false, "isReadOnly": true, "isStatic": false, "type": "number", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "forceResolveSuggestion": { "kind": "method", "signature": "forceResolveSuggestion(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "hidePicker": { "kind": "property", "signature": "hidePicker: () => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "() => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "inputText": { "kind": "property", "signature": "readonly inputText: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, "type": "string", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "isSuggestionsShown": { "kind": "property", "signature": "readonly isSuggestionsShown: boolean;", "isOptional": false, "isReadOnly": true, "isStatic": false, "type": "boolean", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "onChange": { "kind": "method", "signature": "protected onChange(item: T): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "item": { "name": "item", "description": [], "isOptional": false, "isSpread": false, "type": "T" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "onKeyDown": { "kind": "property", "signature": "protected onKeyDown: (ev: MouseEvent) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(ev: MouseEvent) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "onQueryStringChanged": { "kind": "property", "signature": "onQueryStringChanged: (queryString: string) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(queryString: string) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "onSelectionChange": { "kind": "method", "signature": "protected onSelectionChange(): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "onSuggestionClick": { "kind": "property", "signature": "protected onSuggestionClick: (ev: React.MouseEvent, item: T, index: number) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(ev: React.MouseEvent, item: T, index: number) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "onSuggestionRemove": { "kind": "property", "signature": "protected onSuggestionRemove: (ev: React.MouseEvent, item: T, index: number) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(ev: React.MouseEvent, item: T, index: number) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "renderSuggestions": { "kind": "method", "signature": "protected renderSuggestions(): JSX.Element | null;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element | null", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "root": { "kind": "property", "signature": "protected root:", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "{\n (component: HTMLDivElement | null): void;\n current: HTMLDivElement | null;\n value: HTMLDivElement | null;\n }", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "selection": { "kind": "property", "signature": "protected selection: Selection;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "Selection", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "showPicker": { "kind": "property", "signature": "showPicker: (updateValue?: boolean) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(updateValue?: boolean) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "suggestions": { "kind": "property", "signature": "readonly suggestions: any[];", "isOptional": false, "isReadOnly": true, "isStatic": false, "type": "any[]", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "suggestionsControl": { "kind": "property", "signature": "protected suggestionsControl: SuggestionsControl;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "SuggestionsControl", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "SuggestionsControlOfProperType": { "kind": "property", "signature": "protected SuggestionsControlOfProperType: new (props: ISuggestionsControlProps) => SuggestionsControl;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "new (props: ISuggestionsControlProps) => SuggestionsControl", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "suggestionStore": { "kind": "property", "signature": "protected suggestionStore: SuggestionsStore;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "SuggestionsStore", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "updateSuggestions": { "kind": "method", "signature": "updateSuggestions(suggestions: T[], forceUpdate?: boolean): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "suggestions": { "name": "suggestions", "description": [], "isOptional": false, "isSpread": false, "type": "T[]" }, "forceUpdate": { "name": "forceUpdate", "description": [], "isOptional": true, "isSpread": false, "type": "boolean" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "updateSuggestionsList": { "kind": "method", "signature": "protected updateSuggestionsList(suggestions: T[] | PromiseLike): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "suggestions": { "name": "suggestions", "description": [], "isOptional": false, "isSpread": false, "type": "T[] | PromiseLike" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "updateSuggestionWithZeroState": { "kind": "method", "signature": "protected updateSuggestionWithZeroState(): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "updateValue": { "kind": "method", "signature": "protected updateValue(updatedValue: string): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "updatedValue": { "name": "updatedValue", "description": [], "isOptional": false, "isSpread": false, "type": "string" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "BasePeoplePicker": { "kind": "class", "extends": "BasePicker", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false }, "BasePeopleSelectedItemsList": { "kind": "class", "extends": "BaseSelectedItemsList", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false }, "BasePicker": { "kind": "class", "extends": "BaseComponent", "implements": "IBasePicker", "typeParameters": [ "T", "P extends IBasePickerProps" ], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(basePickerProps: P);", "parameters": { "basePickerProps": { "name": "basePickerProps", "description": [], "isOptional": false, "isSpread": false, "type": "P" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Constructs a new instance of the " }, { "kind": "api-link", "elements": [ { "kind": "text", "text": "BasePicker" } ], "target": { "scopeName": "", "packageName": "gpgbk-fabric-react", "exportName": "BasePicker", "memberName": "" } }, { "kind": "text", "text": " class" } ], "remarks": [] }, "_ariaMap": { "kind": "property", "signature": "protected _ariaMap: IPickerAriaIds;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "IPickerAriaIds", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "_isFocusZoneInnerKeystroke": { "kind": "property", "signature": "protected _isFocusZoneInnerKeystroke: (ev: React.KeyboardEvent) => boolean;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(ev: React.KeyboardEvent) => boolean", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "addItem": { "kind": "property", "signature": "protected addItem: (item: T) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(item: T) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "addItemByIndex": { "kind": "property", "signature": "protected addItemByIndex: (index: number) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(index: number) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "canAddItems": { "kind": "method", "signature": "protected canAddItems(): boolean;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "boolean", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "completeSuggestion": { "kind": "method", "signature": "completeSuggestion(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentDidMount": { "kind": "method", "signature": "componentDidMount(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentWillReceiveProps": { "kind": "method", "signature": "componentWillReceiveProps(newProps: P): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "newProps": { "name": "newProps", "description": [], "isOptional": false, "isSpread": false, "type": "P" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentWillUnmount": { "kind": "method", "signature": "componentWillUnmount(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentWillUpdate": { "kind": "method", "signature": "componentWillUpdate(newProps: P, newState: IBasePickerState): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "newProps": { "name": "newProps", "description": [], "isOptional": false, "isSpread": false, "type": "P" }, "newState": { "name": "newState", "description": [], "isOptional": false, "isSpread": false, "type": "IBasePickerState" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "currentPromise": { "kind": "property", "signature": "protected currentPromise: PromiseLike | undefined;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "PromiseLike | undefined", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "dismissSuggestions": { "kind": "property", "signature": "dismissSuggestions: (ev?: any) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(ev?: any) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "focus": { "kind": "method", "signature": "focus(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "focusInput": { "kind": "method", "signature": "focusInput(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "focusZone": { "kind": "property", "signature": "protected focusZone:", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "{\n (component: IFocusZone | null): void;\n current: IFocusZone | null;\n value: IFocusZone | null;\n }", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "getActiveDescendant": { "kind": "method", "signature": "protected getActiveDescendant(): string | undefined;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "string | undefined", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "getSuggestionsAlert": { "kind": "method", "signature": "protected getSuggestionsAlert(): JSX.Element | undefined;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element | undefined", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "input": { "kind": "property", "signature": "protected input:", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "{\n (component: IAutofill | null): void;\n current: IAutofill | null;\n value: IAutofill | null;\n }", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "items": { "kind": "property", "signature": "readonly items: T[];", "isOptional": false, "isReadOnly": true, "isStatic": false, "type": "T[]", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "onBackspace": { "kind": "method", "signature": "protected onBackspace(ev: React.KeyboardEvent): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "ev": { "name": "ev", "description": [], "isOptional": false, "isSpread": false, "type": "React.KeyboardEvent" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "onChange": { "kind": "method", "signature": "protected onChange(items?: T[]): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "items": { "name": "items", "description": [], "isOptional": true, "isSpread": false, "type": "T[]" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "onEmptyInputFocus": { "kind": "method", "signature": "protected onEmptyInputFocus(): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "onGetMoreResults": { "kind": "property", "signature": "protected onGetMoreResults: () => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "() => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "onInputBlur": { "kind": "property", "signature": "protected onInputBlur: (ev: React.FocusEvent) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(ev: React.FocusEvent) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "onInputChange": { "kind": "property", "signature": "protected onInputChange: (value: string) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(value: string) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "onInputFocus": { "kind": "property", "signature": "protected onInputFocus: (ev: React.FocusEvent) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(ev: React.FocusEvent) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "onItemChange": { "kind": "property", "signature": "protected onItemChange: (changedItem: T, index: number) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(changedItem: T, index: number) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "onKeyDown": { "kind": "property", "signature": "protected onKeyDown: (ev: React.KeyboardEvent) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(ev: React.KeyboardEvent) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "onSelectionChange": { "kind": "method", "signature": "protected onSelectionChange(): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "onSuggestionClick": { "kind": "property", "signature": "protected onSuggestionClick: (ev: React.MouseEvent, item: any, index: number) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(ev: React.MouseEvent, item: any, index: number) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "onSuggestionRemove": { "kind": "property", "signature": "protected onSuggestionRemove: (ev: React.MouseEvent, item: IPersonaProps, index: number) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(ev: React.MouseEvent, item: IPersonaProps, index: number) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "onSuggestionSelect": { "kind": "method", "signature": "protected onSuggestionSelect(): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "refocusSuggestions": { "kind": "property", "signature": "refocusSuggestions: (keyCode: KeyCodes) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(keyCode: KeyCodes) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "removeItem": { "kind": "property", "signature": "protected removeItem: (item: IPickerItemProps, focusNextItem?: boolean | undefined) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(item: IPickerItemProps, focusNextItem?: boolean | undefined) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "removeItems": { "kind": "property", "signature": "protected removeItems: (itemsToRemove: any[]) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(itemsToRemove: any[]) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "renderItems": { "kind": "method", "signature": "protected renderItems(): JSX.Element[];", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element[]", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "renderSuggestions": { "kind": "method", "signature": "protected renderSuggestions(): JSX.Element | null;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element | null", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "resetFocus": { "kind": "method", "signature": "protected resetFocus(index?: number): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "index": { "name": "index", "description": [], "isOptional": true, "isSpread": false, "type": "number" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "resolveNewValue": { "kind": "method", "signature": "protected resolveNewValue(updatedValue: string, suggestions: T[]): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "updatedValue": { "name": "updatedValue", "description": [], "isOptional": false, "isSpread": false, "type": "string" }, "suggestions": { "name": "suggestions", "description": [], "isOptional": false, "isSpread": false, "type": "T[]" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "root": { "kind": "property", "signature": "protected root:", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "{\n (component: HTMLDivElement | null): void;\n current: HTMLDivElement | null;\n value: HTMLDivElement | null;\n }", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "selection": { "kind": "property", "signature": "protected selection: Selection;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "Selection", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "suggestionElement": { "kind": "property", "signature": "protected suggestionElement:", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "{\n (component: Suggestions | null): void;\n current: Suggestions | null;\n value: Suggestions | null;\n }", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "SuggestionOfProperType": { "kind": "property", "signature": "protected SuggestionOfProperType: new (props: ISuggestionsProps) => Suggestions;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "new (props: ISuggestionsProps) => Suggestions", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "suggestionStore": { "kind": "property", "signature": "protected suggestionStore: SuggestionsController;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "SuggestionsController", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "updateSuggestions": { "kind": "method", "signature": "protected updateSuggestions(suggestions: any[]): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "suggestions": { "name": "suggestions", "description": [], "isOptional": false, "isSpread": false, "type": "any[]" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "updateSuggestionsList": { "kind": "method", "signature": "protected updateSuggestionsList(suggestions: T[] | PromiseLike, updatedValue?: string): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "suggestions": { "name": "suggestions", "description": [], "isOptional": false, "isSpread": false, "type": "T[] | PromiseLike" }, "updatedValue": { "name": "updatedValue", "description": [], "isOptional": true, "isSpread": false, "type": "string" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "updateValue": { "kind": "method", "signature": "protected updateValue(updatedValue: string): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "updatedValue": { "name": "updatedValue", "description": [], "isOptional": false, "isSpread": false, "type": "string" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "BasePickerListBelow": { "kind": "class", "extends": "BasePicker", "implements": "", "typeParameters": [ "T", "P extends IBasePickerProps" ], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "onBackspace": { "kind": "method", "signature": "protected onBackspace(ev: React.KeyboardEvent): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "ev": { "name": "ev", "description": [], "isOptional": false, "isSpread": false, "type": "React.KeyboardEvent" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "BaseSelectedItemsList": { "kind": "class", "extends": "BaseComponent", "implements": "IBaseSelectedItemsList", "typeParameters": [ "T", "P extends IBaseSelectedItemsListProps" ], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(basePickerProps: P);", "parameters": { "basePickerProps": { "name": "basePickerProps", "description": [], "isOptional": false, "isSpread": false, "type": "P" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Constructs a new instance of the " }, { "kind": "api-link", "elements": [ { "kind": "text", "text": "BaseSelectedItemsList" } ], "target": { "scopeName": "", "packageName": "gpgbk-fabric-react", "exportName": "BaseSelectedItemsList", "memberName": "" } }, { "kind": "text", "text": " class" } ], "remarks": [] }, "addItems": { "kind": "property", "signature": "addItems: (items: T[]) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(items: T[]) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "componentDidMount": { "kind": "method", "signature": "componentDidMount(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentWillReceiveProps": { "kind": "method", "signature": "componentWillReceiveProps(newProps: P): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "newProps": { "name": "newProps", "description": [], "isOptional": false, "isSpread": false, "type": "P" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentWillUpdate": { "kind": "method", "signature": "componentWillUpdate(newProps: P, newState: IBaseSelectedItemsListState): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "newProps": { "name": "newProps", "description": [], "isOptional": false, "isSpread": false, "type": "P" }, "newState": { "name": "newState", "description": [], "isOptional": false, "isSpread": false, "type": "IBaseSelectedItemsListState" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "copyItems": { "kind": "method", "signature": "protected copyItems(items: T[]): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "items": { "name": "items", "description": [], "isOptional": false, "isSpread": false, "type": "T[]" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "hasSelectedItems": { "kind": "method", "signature": "hasSelectedItems(): boolean;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "boolean", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "highlightedItems": { "kind": "method", "signature": "highlightedItems(): T[];", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "T[]", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "items": { "kind": "property", "signature": "readonly items: T[];", "isOptional": false, "isReadOnly": true, "isStatic": false, "type": "T[]", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "onChange": { "kind": "method", "signature": "protected onChange(items?: T[]): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "items": { "name": "items", "description": [], "isOptional": true, "isSpread": false, "type": "T[]" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "onCopy": { "kind": "property", "signature": "onCopy: (ev: React.ClipboardEvent) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(ev: React.ClipboardEvent) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "onItemChange": { "kind": "property", "signature": "protected onItemChange: (changedItem: T, index: number) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(changedItem: T, index: number) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "onSelectionChanged": { "kind": "property", "signature": "protected onSelectionChanged: () => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "() => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "removeItem": { "kind": "property", "signature": "removeItem: (item: ISelectedItemProps) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(item: ISelectedItemProps) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "removeItemAt": { "kind": "property", "signature": "removeItemAt: (index: number) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(index: number) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "removeItems": { "kind": "property", "signature": "removeItems: (itemsToRemove: any[]) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(itemsToRemove: any[]) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "removeSelectedItems": { "kind": "method", "signature": "removeSelectedItems(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "render": { "kind": "method", "signature": "render(): any;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "any", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "renderItems": { "kind": "property", "signature": "protected renderItems: () => JSX.Element[];", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "() => JSX.Element[]", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "root": { "kind": "property", "signature": "protected root: HTMLElement;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "HTMLElement", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "selection": { "kind": "property", "signature": "protected selection: Selection;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "Selection", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "unselectAll": { "kind": "method", "signature": "unselectAll(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "updateItems": { "kind": "method", "signature": "updateItems(items: T[], focusIndex?: number): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "items": { "name": "items", "description": [], "isOptional": false, "isSpread": false, "type": "T[]" }, "focusIndex": { "name": "focusIndex", "description": [], "isOptional": true, "isSpread": false, "type": "number" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Controls what happens whenever there is an action that impacts the selected items. If selectedItems is provided as a property then this will act as a controlled component and it will not update it's own state." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "BaseSlots": { "kind": "enum", "values": { "backgroundColor": { "kind": "enum value", "value": "1", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "foregroundColor": { "kind": "enum value", "value": "2", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "primaryColor": { "kind": "enum value", "value": "0", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "BreadcrumbBase": { "kind": "class", "extends": "BaseComponent", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(props: IBreadcrumbProps);", "parameters": { "props": { "name": "props", "description": [], "isOptional": false, "isSpread": false, "type": "IBreadcrumbProps" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Constructs a new instance of the " }, { "kind": "api-link", "elements": [ { "kind": "text", "text": "BreadcrumbBase" } ], "target": { "scopeName": "", "packageName": "gpgbk-fabric-react", "exportName": "BreadcrumbBase", "memberName": "" } }, { "kind": "text", "text": " class" } ], "remarks": [] }, "componentWillReceiveProps": { "kind": "method", "signature": "componentWillReceiveProps(nextProps: IBreadcrumbProps): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "nextProps": { "name": "nextProps", "description": [], "isOptional": false, "isSpread": false, "type": "IBreadcrumbProps" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "defaultProps": { "kind": "property", "signature": "static defaultProps: IBreadcrumbProps;", "isOptional": false, "isReadOnly": false, "isStatic": true, "type": "IBreadcrumbProps", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "focus": { "kind": "method", "signature": "focus(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Sets focus to the first breadcrumb link." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "buildClassMap": { "kind": "function", "signature": "export function buildClassMap(styles: T): {\n [key in keyof T]?: string;\n};", "returnValue": { "type": "{\n [key in keyof T]?: string;\n}", "description": [ { "kind": "text", "text": "Map of property name to class name." } ] }, "parameters": { "styles": { "name": "styles", "description": [ { "kind": "text", "text": "Map of unprocessed styles." } ], "isOptional": false, "isSpread": false, "type": "T" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Builds a class names object from a given map." } ], "remarks": [], "isBeta": false }, "buildColumns": { "kind": "function", "signature": "export function buildColumns(items: any[], canResizeColumns?: boolean, onColumnClick?: (ev: React.MouseEvent, column: IColumn) => any, sortedColumnKey?: string, isSortedDescending?: boolean, groupedColumnKey?: string, isMultiline?: boolean): IColumn[];", "returnValue": { "type": "IColumn[]", "description": [] }, "parameters": { "items": { "name": "items", "description": [], "isOptional": false, "isSpread": false, "type": "any[]" }, "canResizeColumns": { "name": "canResizeColumns", "description": [], "isOptional": true, "isSpread": false, "type": "boolean" }, "onColumnClick": { "name": "onColumnClick", "description": [], "isOptional": true, "isSpread": false, "type": "(ev: React.MouseEvent, column: IColumn) => any" }, "sortedColumnKey": { "name": "sortedColumnKey", "description": [], "isOptional": true, "isSpread": false, "type": "string" }, "isSortedDescending": { "name": "isSortedDescending", "description": [], "isOptional": true, "isSpread": false, "type": "boolean" }, "groupedColumnKey": { "name": "groupedColumnKey", "description": [], "isOptional": true, "isSpread": false, "type": "string" }, "isMultiline": { "name": "isMultiline", "description": [], "isOptional": true, "isSpread": false, "type": "boolean" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "Button": { "kind": "class", "extends": "BaseComponent", "implements": "", "typeParameters": [], "deprecatedMessage": [ { "kind": "text", "text": "Use the individual *Button components instead." } ], "summary": [ { "kind": "text", "text": "This class is deprecated. Use the individual *Button components instead." } ], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(props: IButtonProps);", "parameters": { "props": { "name": "props", "description": [], "isOptional": false, "isSpread": false, "type": "IButtonProps" } }, "deprecatedMessage": [ { "kind": "text", "text": "Use the individual *Button components instead." } ], "summary": [ { "kind": "text", "text": "Constructs a new instance of the " }, { "kind": "api-link", "elements": [ { "kind": "text", "text": "Button" } ], "target": { "scopeName": "", "packageName": "gpgbk-fabric-react", "exportName": "Button", "memberName": "" } }, { "kind": "text", "text": " class" } ], "remarks": [] }, "_skipComponentRefResolution": { "kind": "property", "signature": "protected _skipComponentRefResolution: boolean;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "boolean", "deprecatedMessage": [ { "kind": "text", "text": "Use the individual *Button components instead." } ], "summary": [ { "kind": "text", "text": "Set this BaseComponent._skipComponentRefResolution to true, bypassing resolution of componentRef." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [ { "kind": "text", "text": "Use the individual *Button components instead." } ], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "ButtonType": { "kind": "enum", "values": { "command": { "kind": "enum value", "value": "4", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "compound": { "kind": "enum value", "value": "3", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "default": { "kind": "enum value", "value": "6", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "hero": { "kind": "enum value", "value": "2", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "icon": { "kind": "enum value", "value": "5", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "normal": { "kind": "enum value", "value": "0", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "primary": { "kind": "enum value", "value": "1", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "calculatePrecision": { "kind": "function", "signature": "export function calculatePrecision(value: number | string): number;", "returnValue": { "type": "number", "description": [] }, "parameters": { "value": { "name": "value", "description": [ { "kind": "text", "text": "the value to determine the precision of" } ], "isOptional": false, "isSpread": false, "type": "number | string" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Calculates a number's precision based on the number of trailing zeros if the number does not have a decimal indicated by a negative precision. Otherwise, it calculates the number of digits after the decimal point indicated by a positive precision." } ], "remarks": [], "isBeta": false }, "Calendar": { "kind": "class", "extends": "BaseComponent", "implements": "ICalendar", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(props: ICalendarProps);", "parameters": { "props": { "name": "props", "description": [], "isOptional": false, "isSpread": false, "type": "ICalendarProps" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Constructs a new instance of the " }, { "kind": "api-link", "elements": [ { "kind": "text", "text": "Calendar" } ], "target": { "scopeName": "", "packageName": "gpgbk-fabric-react", "exportName": "Calendar", "memberName": "" } }, { "kind": "text", "text": " class" } ], "remarks": [] }, "componentDidUpdate": { "kind": "method", "signature": "componentDidUpdate(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentWillReceiveProps": { "kind": "method", "signature": "componentWillReceiveProps(nextProps: ICalendarProps): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "nextProps": { "name": "nextProps", "description": [], "isOptional": false, "isSpread": false, "type": "ICalendarProps" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "defaultProps": { "kind": "property", "signature": "static defaultProps: ICalendarProps;", "isOptional": false, "isReadOnly": false, "isStatic": true, "type": "ICalendarProps", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "focus": { "kind": "method", "signature": "focus(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "Callout": { "kind": "class", "extends": "BaseComponent", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(props: ICalloutProps);", "parameters": { "props": { "name": "props", "description": [], "isOptional": false, "isSpread": false, "type": "ICalloutProps" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Constructs a new instance of the " }, { "kind": "api-link", "elements": [ { "kind": "text", "text": "Callout" } ], "target": { "scopeName": "", "packageName": "gpgbk-fabric-react", "exportName": "Callout", "memberName": "" } }, { "kind": "text", "text": " class" } ], "remarks": [] }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "canAnyMenuItemsCheck": { "kind": "function", "signature": "export function canAnyMenuItemsCheck(items: IContextualMenuItem[]): boolean;", "returnValue": { "type": "boolean", "description": [] }, "parameters": { "items": { "name": "items", "description": [], "isOptional": false, "isSpread": false, "type": "IContextualMenuItem[]" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Returns true if a list of menu items can contain a checkbox" } ], "remarks": [], "isBeta": false }, "CheckBase": { "kind": "class", "extends": "BaseComponent", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "defaultProps": { "kind": "property", "signature": "static defaultProps: ICheckProps;", "isOptional": false, "isReadOnly": false, "isStatic": true, "type": "ICheckProps", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "shouldComponentUpdate": { "kind": "method", "signature": "shouldComponentUpdate(newProps: ICheckProps): boolean;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "boolean", "description": [] }, "parameters": { "newProps": { "name": "newProps", "description": [], "isOptional": false, "isSpread": false, "type": "ICheckProps" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "CheckboxBase": { "kind": "class", "extends": "BaseComponent", "implements": "ICheckbox", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(props: ICheckboxProps, context?: any);", "parameters": { "props": { "name": "props", "description": [ { "kind": "text", "text": "Props for the component" } ], "isOptional": false, "isSpread": false, "type": "ICheckboxProps" }, "context": { "name": "context", "description": [ { "kind": "text", "text": "Context or initial state for the base component." } ], "isOptional": true, "isSpread": false, "type": "any" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Initialize a new instance of the TopHeaderV2" } ], "remarks": [] }, "checked": { "kind": "property", "signature": "readonly checked: boolean;", "isOptional": false, "isReadOnly": true, "isStatic": false, "type": "boolean", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "componentWillReceiveProps": { "kind": "method", "signature": "componentWillReceiveProps(newProps: ICheckboxProps): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "newProps": { "name": "newProps", "description": [], "isOptional": false, "isSpread": false, "type": "ICheckboxProps" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "defaultProps": { "kind": "property", "signature": "static defaultProps: ICheckboxProps;", "isOptional": false, "isReadOnly": false, "isStatic": true, "type": "ICheckboxProps", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "focus": { "kind": "method", "signature": "focus(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Render the Checkbox based on passed props" } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "CheckboxVisibility": { "kind": "enum", "values": { "always": { "kind": "enum value", "value": "1", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Visible always." } ], "remarks": [], "isBeta": false }, "hidden": { "kind": "enum value", "value": "2", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Hide checkboxes." } ], "remarks": [], "isBeta": false }, "onHover": { "kind": "enum value", "value": "0", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Visible on hover." } ], "remarks": [], "isBeta": false } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "ChoiceGroupBase": { "kind": "class", "extends": "BaseComponent", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(props: IChoiceGroupProps);", "parameters": { "props": { "name": "props", "description": [], "isOptional": false, "isSpread": false, "type": "IChoiceGroupProps" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Constructs a new instance of the " }, { "kind": "api-link", "elements": [ { "kind": "text", "text": "ChoiceGroupBase" } ], "target": { "scopeName": "", "packageName": "gpgbk-fabric-react", "exportName": "ChoiceGroupBase", "memberName": "" } }, { "kind": "text", "text": " class" } ], "remarks": [] }, "componentWillReceiveProps": { "kind": "method", "signature": "componentWillReceiveProps(newProps: IChoiceGroupProps): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "newProps": { "name": "newProps", "description": [], "isOptional": false, "isSpread": false, "type": "IChoiceGroupProps" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "defaultProps": { "kind": "property", "signature": "static defaultProps: IChoiceGroupProps;", "isOptional": false, "isReadOnly": false, "isStatic": true, "type": "IChoiceGroupProps", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "focus": { "kind": "method", "signature": "focus(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "classNamesFunction": { "kind": "function", "signature": "export function classNamesFunction>(): (getStyles: IStyleFunctionOrObject | undefined, styleProps?: TStyleProps) => IProcessedStyleSet;", "returnValue": { "type": "(getStyles: IStyleFunctionOrObject | undefined, styleProps?: TStyleProps) => IProcessedStyleSet", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Creates a getClassNames function which calls getStyles given the props, and injects them into mergeStyleSets." } ], "remarks": [], "isBeta": false }, "Coachmark": { "kind": "class", "extends": "BaseComponent", "implements": "ICoachmark", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(props: ICoachmarkProps);", "parameters": { "props": { "name": "props", "description": [], "isOptional": false, "isSpread": false, "type": "ICoachmarkProps" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Constructs a new instance of the " }, { "kind": "api-link", "elements": [ { "kind": "text", "text": "Coachmark" } ], "target": { "scopeName": "", "packageName": "gpgbk-fabric-react", "exportName": "Coachmark", "memberName": "" } }, { "kind": "text", "text": " class" } ], "remarks": [] }, "componentDidMount": { "kind": "method", "signature": "componentDidMount(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentDidUpdate": { "kind": "method", "signature": "componentDidUpdate(prevProps: ICoachmarkProps, prevState: ICoachmarkState): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "prevProps": { "name": "prevProps", "description": [], "isOptional": false, "isSpread": false, "type": "ICoachmarkProps" }, "prevState": { "name": "prevState", "description": [], "isOptional": false, "isSpread": false, "type": "ICoachmarkState" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentWillReceiveProps": { "kind": "method", "signature": "componentWillReceiveProps(newProps: ICoachmarkProps): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "newProps": { "name": "newProps", "description": [], "isOptional": false, "isSpread": false, "type": "ICoachmarkProps" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "defaultProps": { "kind": "property", "signature": "static defaultProps: Partial;", "isOptional": false, "isReadOnly": false, "isStatic": true, "type": "Partial", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "dismiss": { "kind": "property", "signature": "dismiss: (ev?: Event | React.KeyboardEvent | React.MouseEvent | undefined) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(ev?: Event | React.KeyboardEvent | React.MouseEvent | undefined) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "shouldComponentUpdate": { "kind": "method", "signature": "shouldComponentUpdate(newProps: ICoachmarkProps, newState: ICoachmarkState): boolean;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "boolean", "description": [] }, "parameters": { "newProps": { "name": "newProps", "description": [], "isOptional": false, "isSpread": false, "type": "ICoachmarkProps" }, "newState": { "name": "newState", "description": [], "isOptional": false, "isSpread": false, "type": "ICoachmarkState" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "CollapseAllVisibility": { "kind": "enum", "values": { "hidden": { "kind": "enum value", "value": "0", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "visible": { "kind": "enum value", "value": "1", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "ColorPickerBase": { "kind": "class", "extends": "BaseComponent", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(props: IColorPickerProps);", "parameters": { "props": { "name": "props", "description": [], "isOptional": false, "isSpread": false, "type": "IColorPickerProps" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Constructs a new instance of the " }, { "kind": "api-link", "elements": [ { "kind": "text", "text": "ColorPickerBase" } ], "target": { "scopeName": "", "packageName": "gpgbk-fabric-react", "exportName": "ColorPickerBase", "memberName": "" } }, { "kind": "text", "text": " class" } ], "remarks": [] }, "componentWillReceiveProps": { "kind": "method", "signature": "componentWillReceiveProps(newProps: IColorPickerProps): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "newProps": { "name": "newProps", "description": [], "isOptional": false, "isSpread": false, "type": "IColorPickerProps" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "defaultProps": { "kind": "property", "signature": "static defaultProps:", "isOptional": false, "isReadOnly": false, "isStatic": true, "type": "{\n hexLabel: string;\n redLabel: string;\n greenLabel: string;\n blueLabel: string;\n alphaLabel: string;\n }", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "ColorPickerGridCellBase": { "kind": "class", "extends": "React.Component", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "defaultProps": { "kind": "property", "signature": "static defaultProps: IColorPickerGridCellProps;", "isOptional": false, "isReadOnly": false, "isStatic": true, "type": "IColorPickerGridCellProps", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "ColumnActionsMode": { "kind": "enum", "values": { "clickable": { "kind": "enum value", "value": "1", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Renders the column header is clickable." } ], "remarks": [], "isBeta": false }, "disabled": { "kind": "enum value", "value": "0", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Renders the column header as disabled." } ], "remarks": [], "isBeta": false }, "hasDropdown": { "kind": "enum value", "value": "2", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Renders the column header ias clickable and displays the dropdown cheveron." } ], "remarks": [], "isBeta": false } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Enum to describe how a particular column header behaves.... This enum is used to to specify the property IColumn:columnActionsMode. If IColumn:columnActionsMode is undefined, then it's equivalent to ColumnActionsMode.clickable" } ], "remarks": [], "isBeta": false }, "ColumnDragEndLocation": { "kind": "enum", "values": { "header": { "kind": "enum value", "value": "2", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Drag ended on Header" } ], "remarks": [], "isBeta": false }, "outside": { "kind": "enum value", "value": "0", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Drag ended outside of current list" } ], "remarks": [], "isBeta": false }, "surface": { "kind": "enum value", "value": "1", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Drag ended on current List" } ], "remarks": [], "isBeta": false } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Enum to describe where the column has been dropped, after starting the drag" } ], "remarks": [], "isBeta": false }, "ComboBox": { "kind": "class", "extends": "BaseComponent", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(props: IComboBoxProps);", "parameters": { "props": { "name": "props", "description": [], "isOptional": false, "isSpread": false, "type": "IComboBoxProps" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Constructs a new instance of the " }, { "kind": "api-link", "elements": [ { "kind": "text", "text": "ComboBox" } ], "target": { "scopeName": "", "packageName": "gpgbk-fabric-react", "exportName": "ComboBox", "memberName": "" } }, { "kind": "text", "text": " class" } ], "remarks": [] }, "componentDidMount": { "kind": "method", "signature": "componentDidMount(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentDidUpdate": { "kind": "method", "signature": "componentDidUpdate(prevProps: IComboBoxProps, prevState: IComboBoxState): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "prevProps": { "name": "prevProps", "description": [], "isOptional": false, "isSpread": false, "type": "IComboBoxProps" }, "prevState": { "name": "prevState", "description": [], "isOptional": false, "isSpread": false, "type": "IComboBoxState" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentWillReceiveProps": { "kind": "method", "signature": "componentWillReceiveProps(newProps: IComboBoxProps): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "newProps": { "name": "newProps", "description": [], "isOptional": false, "isSpread": false, "type": "IComboBoxProps" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentWillUnmount": { "kind": "method", "signature": "componentWillUnmount(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "defaultProps": { "kind": "property", "signature": "static defaultProps: IComboBoxProps;", "isOptional": false, "isReadOnly": false, "isStatic": true, "type": "IComboBoxProps", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "dismissMenu": { "kind": "property", "signature": "dismissMenu: () => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "() => void", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Close menu callout if it is open" } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "focus": { "kind": "property", "signature": "focus: (shouldOpenOnFocus?: boolean | undefined, useFocusAsync?: boolean | undefined) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(shouldOpenOnFocus?: boolean | undefined, useFocusAsync?: boolean | undefined) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "CommandBarBase": { "kind": "class", "extends": "BaseComponent", "implements": "ICommandBar", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "defaultProps": { "kind": "property", "signature": "static defaultProps: ICommandBarProps;", "isOptional": false, "isReadOnly": false, "isStatic": true, "type": "ICommandBarProps", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "focus": { "kind": "method", "signature": "focus(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "remeasure": { "kind": "method", "signature": "remeasure(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "CommandBarButton": { "kind": "class", "extends": "BaseComponent", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "_skipComponentRefResolution": { "kind": "property", "signature": "protected _skipComponentRefResolution: boolean;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "boolean", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Tell BaseComponent to bypass resolution of componentRef." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "CompactPeoplePicker": { "kind": "class", "extends": "BasePeoplePicker", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Compact layout. It uses small personas when displaying search results." } ], "remarks": [], "isBeta": false, "isSealed": false, "members": { "defaultProps": { "kind": "property", "signature": "static defaultProps:", "isOptional": false, "isReadOnly": false, "isStatic": true, "type": "{\n onRenderItem: (props: IPeoplePickerItemProps) => JSX.Element;\n onRenderSuggestionsItem: (props: IPersonaProps, itemProps?: IBasePickerSuggestionsProps | undefined) => JSX.Element;\n createGenericItem: typeof createGenericItem;\n }", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false } } }, "CompoundButton": { "kind": "class", "extends": "BaseComponent", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "_skipComponentRefResolution": { "kind": "property", "signature": "protected _skipComponentRefResolution: boolean;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "boolean", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Tell BaseComponent to bypass resolution of componentRef." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "concatStyleSets": { "kind": "function", "signature": "export function concatStyleSets(...styleSets: (IStyleSet | false | null | undefined)[]): IConcatenatedStyleSet;", "returnValue": { "type": "IConcatenatedStyleSet", "description": [] }, "parameters": { "styleSets": { "name": "styleSets", "description": [ { "kind": "text", "text": "One or more stylesets to be merged (each param can also be falsy)." } ], "isOptional": false, "isSpread": true, "type": "(IStyleSet | false | null | undefined)[]" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Combine a set of styles together (but does not register css classes)." } ], "remarks": [], "isBeta": false }, "ConstrainMode": { "kind": "enum", "values": { "horizontalConstrained": { "kind": "enum value", "value": "1", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "If specified, constrains the list to the given layout space." } ], "remarks": [], "isBeta": false }, "unconstrained": { "kind": "enum value", "value": "0", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "If specified, lets the content grow which allows the page to manage scrolling." } ], "remarks": [], "isBeta": false } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "ContextualMenuBase": { "kind": "class", "extends": "BaseComponent", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(props: IContextualMenuProps);", "parameters": { "props": { "name": "props", "description": [], "isOptional": false, "isSpread": false, "type": "IContextualMenuProps" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Constructs a new instance of the " }, { "kind": "api-link", "elements": [ { "kind": "text", "text": "ContextualMenuBase" } ], "target": { "scopeName": "", "packageName": "gpgbk-fabric-react", "exportName": "ContextualMenuBase", "memberName": "" } }, { "kind": "text", "text": " class" } ], "remarks": [] }, "componentDidMount": { "kind": "method", "signature": "componentDidMount(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentWillMount": { "kind": "method", "signature": "componentWillMount(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentWillUnmount": { "kind": "method", "signature": "componentWillUnmount(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentWillUpdate": { "kind": "method", "signature": "componentWillUpdate(newProps: IContextualMenuProps): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "newProps": { "name": "newProps", "description": [], "isOptional": false, "isSpread": false, "type": "IContextualMenuProps" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "defaultProps": { "kind": "property", "signature": "static defaultProps: IContextualMenuProps;", "isOptional": false, "isReadOnly": false, "isStatic": true, "type": "IContextualMenuProps", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "dismiss": { "kind": "property", "signature": "dismiss: (ev?: any, dismissAll?: boolean | undefined) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(ev?: any, dismissAll?: boolean | undefined) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "render": { "kind": "method", "signature": "render(): JSX.Element | null;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element | null", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "ContextualMenuItemBase": { "kind": "class", "extends": "BaseComponent", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "dismissMenu": { "kind": "property", "signature": "dismissMenu: (dismissAll?: boolean | undefined) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(dismissAll?: boolean | undefined) => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "dismissSubMenu": { "kind": "property", "signature": "dismissSubMenu: () => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "() => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "openSubMenu": { "kind": "property", "signature": "openSubMenu: () => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "() => void", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "ContextualMenuItemType": { "kind": "enum", "values": { "Divider": { "kind": "enum value", "value": "1", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "Header": { "kind": "enum value", "value": "2", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "Normal": { "kind": "enum value", "value": "0", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "Section": { "kind": "enum value", "value": "3", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "createArray": { "kind": "function", "signature": "export function createArray(size: number, getItem: (index: number) => T): T[];", "returnValue": { "type": "T[]", "description": [] }, "parameters": { "size": { "name": "size", "description": [ { "kind": "text", "text": "Size of array." } ], "isOptional": false, "isSpread": false, "type": "number" }, "getItem": { "name": "getItem", "description": [ { "kind": "text", "text": "Callback to populate given cell index." } ], "isOptional": false, "isSpread": false, "type": "(index: number) => T" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Creates an array of a given size and helper method to populate." } ], "remarks": [], "isBeta": false }, "createFontStyles": { "kind": "function", "signature": "export function createFontStyles(localeCode: string | null): IFontStyles;", "returnValue": { "type": "IFontStyles", "description": [] }, "parameters": { "localeCode": { "name": "localeCode", "description": [], "isOptional": false, "isSpread": false, "type": "string | null" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "createGenericItem": { "kind": "function", "signature": "export function createGenericItem(name: string, currentValidationState: ValidationState, allowPhoneInitials: boolean): IGenericItem & {\n key: React.Key;\n};", "returnValue": { "type": "IGenericItem & {\n key: React.Key;\n}", "description": [] }, "parameters": { "name": { "name": "name", "description": [], "isOptional": false, "isSpread": false, "type": "string" }, "currentValidationState": { "name": "currentValidationState", "description": [], "isOptional": false, "isSpread": false, "type": "ValidationState" }, "allowPhoneInitials": { "name": "allowPhoneInitials", "description": [], "isOptional": false, "isSpread": false, "type": "boolean" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "createItem": { "kind": "function", "signature": "export function createItem(name: string, isValid: boolean): ISuggestionModel;", "returnValue": { "type": "ISuggestionModel", "description": [] }, "parameters": { "name": { "name": "name", "description": [], "isOptional": false, "isSpread": false, "type": "string" }, "isValid": { "name": "isValid", "description": [], "isOptional": false, "isSpread": false, "type": "boolean" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "createRef": { "kind": "function", "signature": "export function createRef(): RefObject;", "returnValue": { "type": "RefObject", "description": [] }, "parameters": {}, "deprecatedMessage": [ { "kind": "text", "text": "Use React.createRef. May be removed in 6 months (Jan '19)." } ], "summary": [], "remarks": [], "isBeta": false }, "createTheme": { "kind": "function", "signature": "export function createTheme(theme: IPartialTheme, depComments?: boolean): ITheme;", "returnValue": { "type": "ITheme", "description": [] }, "parameters": { "theme": { "name": "theme", "description": [ { "kind": "text", "text": "Partial theme object." } ], "isOptional": false, "isSpread": false, "type": "IPartialTheme" }, "depComments": { "name": "depComments", "description": [ { "kind": "text", "text": "Whether to include deprecated tags as comments for deprecated slots." } ], "isOptional": true, "isSpread": false, "type": "boolean" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Creates a custom theme definition which can be used with the Customizer." } ], "remarks": [], "isBeta": false }, "css": { "kind": "function", "signature": "export function css(...args: ICssInput[]): string;", "returnValue": { "type": "string", "description": [] }, "parameters": { "args": { "name": "args", "description": [], "isOptional": false, "isSpread": true, "type": "ICssInput[]" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Concatination helper, which can merge class names together. Skips over falsey values." } ], "remarks": [], "isBeta": false }, "cssColor": { "kind": "function", "signature": "export function cssColor(color: string): IRGB | undefined;", "returnValue": { "type": "IRGB | undefined", "description": [] }, "parameters": { "color": { "name": "color", "description": [], "isOptional": false, "isSpread": false, "type": "string" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "customizable": { "kind": "function", "signature": "export function customizable(scope: string, fields: string[], concatStyles?: boolean):

(ComposedComponent: React.ComponentType

) => any;", "returnValue": { "type": "

(ComposedComponent: React.ComponentType

) => any", "description": [] }, "parameters": { "scope": { "name": "scope", "description": [], "isOptional": false, "isSpread": false, "type": "string" }, "fields": { "name": "fields", "description": [], "isOptional": false, "isSpread": false, "type": "string[]" }, "concatStyles": { "name": "concatStyles", "description": [], "isOptional": true, "isSpread": false, "type": "boolean" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "Customizations": { "kind": "class", "extends": "", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "applyScopedSettings": { "kind": "method", "signature": "static applyScopedSettings(scopeName: string, settings: Settings): void;", "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { "type": "void", "description": [] }, "parameters": { "scopeName": { "name": "scopeName", "description": [], "isOptional": false, "isSpread": false, "type": "string" }, "settings": { "name": "settings", "description": [], "isOptional": false, "isSpread": false, "type": "Settings" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "applySettings": { "kind": "method", "signature": "static applySettings(settings: Settings): void;", "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { "type": "void", "description": [] }, "parameters": { "settings": { "name": "settings", "description": [], "isOptional": false, "isSpread": false, "type": "Settings" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "getSettings": { "kind": "method", "signature": "static getSettings(properties: string[], scopeName?: string, localSettings?: ICustomizations): any;", "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { "type": "any", "description": [] }, "parameters": { "properties": { "name": "properties", "description": [], "isOptional": false, "isSpread": false, "type": "string[]" }, "scopeName": { "name": "scopeName", "description": [], "isOptional": true, "isSpread": false, "type": "string" }, "localSettings": { "name": "localSettings", "description": [], "isOptional": true, "isSpread": false, "type": "ICustomizations" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "observe": { "kind": "method", "signature": "static observe(onChange: () => void): void;", "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { "type": "void", "description": [] }, "parameters": { "onChange": { "name": "onChange", "description": [], "isOptional": false, "isSpread": false, "type": "() => void" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "reset": { "kind": "method", "signature": "static reset(): void;", "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "unobserve": { "kind": "method", "signature": "static unobserve(onChange: () => void): void;", "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { "type": "void", "description": [] }, "parameters": { "onChange": { "name": "onChange", "description": [], "isOptional": false, "isSpread": false, "type": "() => void" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "Customizer": { "kind": "class", "extends": "BaseComponent", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "The Customizer component allows for default props to be mixed into components which are decorated with the customizable() decorator, or use the styled HOC. This enables injection scenarios like:" }, { "kind": "paragraph" }, { "kind": "text", "text": "1. render svg icons instead of the icon font within all buttons 2. inject a custom theme object into a component" }, { "kind": "paragraph" }, { "kind": "text", "text": "Props are provided via the settings prop which should be one of the following: - A json map which contains 1 or more name/value pairs representing injectable props. - A function that receives the current settings and returns the new ones that apply to the scope" } ], "remarks": [], "isBeta": false, "isSealed": false, "members": { "componentDidMount": { "kind": "method", "signature": "componentDidMount(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentWillUnmount": { "kind": "method", "signature": "componentWillUnmount(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "render": { "kind": "method", "signature": "render(): React.ReactElement<{}>;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "React.ReactElement<{}>", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "DatePickerBase": { "kind": "class", "extends": "BaseComponent", "implements": "IDatePicker", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(props: IDatePickerProps);", "parameters": { "props": { "name": "props", "description": [], "isOptional": false, "isSpread": false, "type": "IDatePickerProps" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Constructs a new instance of the " }, { "kind": "api-link", "elements": [ { "kind": "text", "text": "DatePickerBase" } ], "target": { "scopeName": "", "packageName": "gpgbk-fabric-react", "exportName": "DatePickerBase", "memberName": "" } }, { "kind": "text", "text": " class" } ], "remarks": [] }, "componentDidUpdate": { "kind": "method", "signature": "componentDidUpdate(prevProps: IDatePickerProps, prevState: IDatePickerState): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "prevProps": { "name": "prevProps", "description": [], "isOptional": false, "isSpread": false, "type": "IDatePickerProps" }, "prevState": { "name": "prevState", "description": [], "isOptional": false, "isSpread": false, "type": "IDatePickerState" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentWillReceiveProps": { "kind": "method", "signature": "componentWillReceiveProps(nextProps: IDatePickerProps): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "nextProps": { "name": "nextProps", "description": [], "isOptional": false, "isSpread": false, "type": "IDatePickerProps" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "defaultProps": { "kind": "property", "signature": "static defaultProps: IDatePickerProps;", "isOptional": false, "isReadOnly": false, "isStatic": true, "type": "IDatePickerProps", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "focus": { "kind": "method", "signature": "focus(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "reset": { "kind": "method", "signature": "reset(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "DateRangeType": { "kind": "enum", "values": { "Day": { "kind": "enum value", "value": "0", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "Month": { "kind": "enum value", "value": "2", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "Week": { "kind": "enum value", "value": "1", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "WorkWeek": { "kind": "enum value", "value": "3", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "The supported date range types" } ], "remarks": [], "isBeta": false }, "DayOfWeek": { "kind": "enum", "values": { "Friday": { "kind": "enum value", "value": "5", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "Monday": { "kind": "enum value", "value": "1", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "Saturday": { "kind": "enum value", "value": "6", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "Sunday": { "kind": "enum value", "value": "0", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "Thursday": { "kind": "enum value", "value": "4", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "Tuesday": { "kind": "enum value", "value": "2", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "Wednesday": { "kind": "enum value", "value": "3", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "The days of the week" } ], "remarks": [], "isBeta": false }, "DefaultButton": { "kind": "class", "extends": "BaseComponent", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "_skipComponentRefResolution": { "kind": "property", "signature": "protected _skipComponentRefResolution: boolean;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "boolean", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Tell BaseComponent to bypass resolution of componentRef." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "DelayedRender": { "kind": "class", "extends": "React.Component", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Utility component for delaying the render of a child component after a given delay. This component requires a single child component; don't pass in many components. Wrap multiple components in a DIV if necessary." } ], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(props: IDelayedRenderProps);", "parameters": { "props": { "name": "props", "description": [], "isOptional": false, "isSpread": false, "type": "IDelayedRenderProps" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Constructs a new instance of the " }, { "kind": "api-link", "elements": [ { "kind": "text", "text": "DelayedRender" } ], "target": { "scopeName": "", "packageName": "gpgbk-fabric-react", "exportName": "DelayedRender", "memberName": "" } }, { "kind": "text", "text": " class" } ], "remarks": [] }, "componentDidMount": { "kind": "method", "signature": "componentDidMount(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentWillUnmount": { "kind": "method", "signature": "componentWillUnmount(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "defaultProps": { "kind": "property", "signature": "static defaultProps:", "isOptional": false, "isReadOnly": false, "isStatic": true, "type": "{\n delay: number;\n }", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "render": { "kind": "method", "signature": "render(): React.ReactElement<{}> | null;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "React.ReactElement<{}> | null", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "DetailsListBase": { "kind": "class", "extends": "BaseComponent", "implements": "IDetailsList", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(props: IDetailsListProps);", "parameters": { "props": { "name": "props", "description": [], "isOptional": false, "isSpread": false, "type": "IDetailsListProps" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Constructs a new instance of the " }, { "kind": "api-link", "elements": [ { "kind": "text", "text": "DetailsListBase" } ], "target": { "scopeName": "", "packageName": "gpgbk-fabric-react", "exportName": "DetailsListBase", "memberName": "" } }, { "kind": "text", "text": " class" } ], "remarks": [] }, "_onRenderRow": { "kind": "property", "signature": "protected _onRenderRow: (props: IDetailsRowProps, defaultRender?: any) => JSX.Element;", "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "(props: IDetailsRowProps, defaultRender?: any) => JSX.Element", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "componentDidUpdate": { "kind": "method", "signature": "componentDidUpdate(prevProps: any, prevState: any): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "prevProps": { "name": "prevProps", "description": [], "isOptional": false, "isSpread": false, "type": "any" }, "prevState": { "name": "prevState", "description": [], "isOptional": false, "isSpread": false, "type": "any" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentWillReceiveProps": { "kind": "method", "signature": "componentWillReceiveProps(newProps: IDetailsListProps): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "newProps": { "name": "newProps", "description": [], "isOptional": false, "isSpread": false, "type": "IDetailsListProps" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentWillUnmount": { "kind": "method", "signature": "componentWillUnmount(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentWillUpdate": { "kind": "method", "signature": "componentWillUpdate(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "defaultProps": { "kind": "property", "signature": "static defaultProps:", "isOptional": false, "isReadOnly": false, "isStatic": true, "type": "{\n layoutMode: DetailsListLayoutMode;\n selectionMode: SelectionMode;\n constrainMode: ConstrainMode;\n checkboxVisibility: CheckboxVisibility;\n isHeaderVisible: boolean;\n enableShimmer: boolean;\n }", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "focusIndex": { "kind": "method", "signature": "focusIndex(index: number, forceIntoFirstElement?: boolean, measureItem?: (itemIndex: number) => number, scrollToMode?: ScrollToMode): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "index": { "name": "index", "description": [], "isOptional": false, "isSpread": false, "type": "number" }, "forceIntoFirstElement": { "name": "forceIntoFirstElement", "description": [], "isOptional": true, "isSpread": false, "type": "boolean" }, "measureItem": { "name": "measureItem", "description": [], "isOptional": true, "isSpread": false, "type": "(itemIndex: number) => number" }, "scrollToMode": { "name": "scrollToMode", "description": [], "isOptional": true, "isSpread": false, "type": "ScrollToMode" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "forceUpdate": { "kind": "method", "signature": "forceUpdate(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "getStartItemIndexInView": { "kind": "method", "signature": "getStartItemIndexInView(): number;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "number", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "scrollToIndex": { "kind": "method", "signature": "scrollToIndex(index: number, measureItem?: (itemIndex: number) => number, scrollToMode?: ScrollToMode): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "index": { "name": "index", "description": [], "isOptional": false, "isSpread": false, "type": "number" }, "measureItem": { "name": "measureItem", "description": [], "isOptional": true, "isSpread": false, "type": "(itemIndex: number) => number" }, "scrollToMode": { "name": "scrollToMode", "description": [], "isOptional": true, "isSpread": false, "type": "ScrollToMode" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "DetailsListLayoutMode": { "kind": "enum", "values": { "fixedColumns": { "kind": "enum value", "value": "0", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Lets the user resize columns and makes not attempt to fit them." } ], "remarks": [], "isBeta": false }, "justified": { "kind": "enum value", "value": "1", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Manages which columns are visible, tries to size them according to their min/max rules and drops off columns that can't fit and have isCollapsable set." } ], "remarks": [], "isBeta": false } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "DetailsRowBase": { "kind": "class", "extends": "BaseComponent", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(props: IDetailsRowBaseProps);", "parameters": { "props": { "name": "props", "description": [], "isOptional": false, "isSpread": false, "type": "IDetailsRowBaseProps" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Constructs a new instance of the " }, { "kind": "api-link", "elements": [ { "kind": "text", "text": "DetailsRowBase" } ], "target": { "scopeName": "", "packageName": "gpgbk-fabric-react", "exportName": "DetailsRowBase", "memberName": "" } }, { "kind": "text", "text": " class" } ], "remarks": [] }, "_onRenderCheck": { "kind": "method", "signature": "protected _onRenderCheck(props: IDetailsRowCheckProps): JSX.Element;", "accessModifier": "protected", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": { "props": { "name": "props", "description": [], "isOptional": false, "isSpread": false, "type": "IDetailsRowCheckProps" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentDidMount": { "kind": "method", "signature": "componentDidMount(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentDidUpdate": { "kind": "method", "signature": "componentDidUpdate(previousProps: IDetailsRowBaseProps): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "previousProps": { "name": "previousProps", "description": [], "isOptional": false, "isSpread": false, "type": "IDetailsRowBaseProps" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentWillReceiveProps": { "kind": "method", "signature": "componentWillReceiveProps(newProps: IDetailsRowBaseProps): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "newProps": { "name": "newProps", "description": [], "isOptional": false, "isSpread": false, "type": "IDetailsRowBaseProps" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentWillUnmount": { "kind": "method", "signature": "componentWillUnmount(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "focus": { "kind": "method", "signature": "focus(forceIntoFirstElement?: boolean): boolean;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "boolean", "description": [] }, "parameters": { "forceIntoFirstElement": { "name": "forceIntoFirstElement", "description": [], "isOptional": true, "isSpread": false, "type": "boolean" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "measureCell": { "kind": "method", "signature": "measureCell(index: number, onMeasureDone: (width: number) => void): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "index": { "name": "index", "description": [ { "kind": "text", "text": "The cell index" } ], "isOptional": false, "isSpread": false, "type": "number" }, "onMeasureDone": { "name": "onMeasureDone", "description": [ { "kind": "text", "text": "The call back function when finish measure" } ], "isOptional": false, "isSpread": false, "type": "(width: number) => void" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "measure cell at index. and call the call back with the measured cell width when finish measure" } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "shouldComponentUpdate": { "kind": "method", "signature": "shouldComponentUpdate(nextProps: IDetailsRowBaseProps, nextState: IDetailsRowState): boolean;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "boolean", "description": [] }, "parameters": { "nextProps": { "name": "nextProps", "description": [], "isOptional": false, "isSpread": false, "type": "IDetailsRowBaseProps" }, "nextState": { "name": "nextState", "description": [], "isOptional": false, "isSpread": false, "type": "IDetailsRowState" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "DialogBase": { "kind": "class", "extends": "BaseComponent", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(props: IDialogProps);", "parameters": { "props": { "name": "props", "description": [], "isOptional": false, "isSpread": false, "type": "IDialogProps" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Constructs a new instance of the " }, { "kind": "api-link", "elements": [ { "kind": "text", "text": "DialogBase" } ], "target": { "scopeName": "", "packageName": "gpgbk-fabric-react", "exportName": "DialogBase", "memberName": "" } }, { "kind": "text", "text": " class" } ], "remarks": [] }, "defaultProps": { "kind": "property", "signature": "static defaultProps: IDialogProps;", "isOptional": false, "isReadOnly": false, "isStatic": true, "type": "IDialogProps", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "DialogContentBase": { "kind": "class", "extends": "BaseComponent", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(props: IDialogContentProps);", "parameters": { "props": { "name": "props", "description": [], "isOptional": false, "isSpread": false, "type": "IDialogContentProps" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Constructs a new instance of the " }, { "kind": "api-link", "elements": [ { "kind": "text", "text": "DialogContentBase" } ], "target": { "scopeName": "", "packageName": "gpgbk-fabric-react", "exportName": "DialogContentBase", "memberName": "" } }, { "kind": "text", "text": " class" } ], "remarks": [] }, "defaultProps": { "kind": "property", "signature": "static defaultProps: IDialogContentProps;", "isOptional": false, "isReadOnly": false, "isStatic": true, "type": "IDialogContentProps", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "DialogFooterBase": { "kind": "class", "extends": "BaseComponent", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "DialogType": { "kind": "enum", "values": { "close": { "kind": "enum value", "value": "2", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Dialog with an 'x' close button in the upper-right corner" } ], "remarks": [], "isBeta": false }, "largeHeader": { "kind": "enum value", "value": "1", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Dialog with large header banner" } ], "remarks": [], "isBeta": false }, "normal": { "kind": "enum value", "value": "0", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Standard dialog" } ], "remarks": [], "isBeta": false } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "DirectionalHint": { "kind": "enum", "values": { "bottomAutoEdge": { "kind": "enum value", "value": "7", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Appear below the target element, aligning with the target element such that the callout tends toward the center of the screen." } ], "remarks": [], "isBeta": false }, "bottomCenter": { "kind": "enum value", "value": "5", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Appear below the target element, with the centers of the callout and target aligning." } ], "remarks": [], "isBeta": false }, "bottomLeftEdge": { "kind": "enum value", "value": "4", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Appear below the target element, with the left edges of the callout and target aligning." } ], "remarks": [], "isBeta": false }, "bottomRightEdge": { "kind": "enum value", "value": "6", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Appear below the target element, with the right edges of the callout and target aligning." } ], "remarks": [], "isBeta": false }, "leftBottomEdge": { "kind": "enum value", "value": "10", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Appear to the left of the target element, with the bottom edges of the callout and target aligning." } ], "remarks": [], "isBeta": false }, "leftCenter": { "kind": "enum value", "value": "9", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Appear to the left of the target element, with the centers of the callout and target aligning." } ], "remarks": [], "isBeta": false }, "leftTopEdge": { "kind": "enum value", "value": "8", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Appear to the left of the target element, with the top edges of the callout and target aligning." } ], "remarks": [], "isBeta": false }, "rightBottomEdge": { "kind": "enum value", "value": "13", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Appear to the right of the target element, with the bottom edges of the callout and target aligning." } ], "remarks": [], "isBeta": false }, "rightCenter": { "kind": "enum value", "value": "12", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Appear to the right of the target element, with the centers of the callout and target aligning." } ], "remarks": [], "isBeta": false }, "rightTopEdge": { "kind": "enum value", "value": "11", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Appear to the right of the target element, with the top edges of the callout and target aligning." } ], "remarks": [], "isBeta": false }, "topAutoEdge": { "kind": "enum value", "value": "3", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Appear above the target element, aligning with the target element such that the callout tends toward the center of the screen." } ], "remarks": [], "isBeta": false }, "topCenter": { "kind": "enum value", "value": "1", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Appear above the target element, with the centers of the callout and target aligning." } ], "remarks": [], "isBeta": false }, "topLeftEdge": { "kind": "enum value", "value": "0", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Appear above the target element, with the left edges of the callout and target aligning." } ], "remarks": [], "isBeta": false }, "topRightEdge": { "kind": "enum value", "value": "2", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Appear above the target element, with the right edges of the callout and target aligning." } ], "remarks": [], "isBeta": false } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "disableBodyScroll": { "kind": "function", "signature": "export function disableBodyScroll(): void;", "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Disables the body scrolling." } ], "remarks": [], "isBeta": false }, "DocumentCard": { "kind": "class", "extends": "BaseComponent", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(props: IDocumentCardProps);", "parameters": { "props": { "name": "props", "description": [], "isOptional": false, "isSpread": false, "type": "IDocumentCardProps" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Constructs a new instance of the " }, { "kind": "api-link", "elements": [ { "kind": "text", "text": "DocumentCard" } ], "target": { "scopeName": "", "packageName": "gpgbk-fabric-react", "exportName": "DocumentCard", "memberName": "" } }, { "kind": "text", "text": " class" } ], "remarks": [] }, "defaultProps": { "kind": "property", "signature": "static defaultProps: IDocumentCardProps;", "isOptional": false, "isReadOnly": false, "isStatic": true, "type": "IDocumentCardProps", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "DocumentCardActions": { "kind": "class", "extends": "BaseComponent", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "DocumentCardActivity": { "kind": "class", "extends": "BaseComponent", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "render": { "kind": "method", "signature": "render(): JSX.Element | null;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element | null", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "DocumentCardLocation": { "kind": "class", "extends": "BaseComponent", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "DocumentCardLogo": { "kind": "class", "extends": "BaseComponent", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "DocumentCardPreview": { "kind": "class", "extends": "BaseComponent", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "DocumentCardStatus": { "kind": "class", "extends": "BaseComponent", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(props: IDocumentCardStatusProps);", "parameters": { "props": { "name": "props", "description": [], "isOptional": false, "isSpread": false, "type": "IDocumentCardStatusProps" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Constructs a new instance of the " }, { "kind": "api-link", "elements": [ { "kind": "text", "text": "DocumentCardStatus" } ], "target": { "scopeName": "", "packageName": "gpgbk-fabric-react", "exportName": "DocumentCardStatus", "memberName": "" } }, { "kind": "text", "text": " class" } ], "remarks": [] }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "DocumentCardTitle": { "kind": "class", "extends": "BaseComponent", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(props: IDocumentCardTitleProps);", "parameters": { "props": { "name": "props", "description": [], "isOptional": false, "isSpread": false, "type": "IDocumentCardTitleProps" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Constructs a new instance of the " }, { "kind": "api-link", "elements": [ { "kind": "text", "text": "DocumentCardTitle" } ], "target": { "scopeName": "", "packageName": "gpgbk-fabric-react", "exportName": "DocumentCardTitle", "memberName": "" } }, { "kind": "text", "text": " class" } ], "remarks": [] }, "componentDidMount": { "kind": "method", "signature": "componentDidMount(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentDidUpdate": { "kind": "method", "signature": "componentDidUpdate(): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentWillReceiveProps": { "kind": "method", "signature": "componentWillReceiveProps(newProps: IDocumentCardTitleProps): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "newProps": { "name": "newProps", "description": [], "isOptional": false, "isSpread": false, "type": "IDocumentCardTitleProps" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "DocumentCardType": { "kind": "enum", "values": { "compact": { "kind": "enum value", "value": "1", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Compact layout. Displays the preview beside the details, rather than above." } ], "remarks": [], "isBeta": false }, "normal": { "kind": "enum value", "value": "0", "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Standard DocumentCard." } ], "remarks": [], "isBeta": false } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "doesElementContainFocus": { "kind": "function", "signature": "export function doesElementContainFocus(element: HTMLElement): boolean;", "returnValue": { "type": "boolean", "description": [] }, "parameters": { "element": { "name": "element", "description": [], "isOptional": false, "isSpread": false, "type": "HTMLElement" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Determines if an element, or any of its children, contain focus." } ], "remarks": [], "isBeta": false }, "DropdownBase": { "kind": "class", "extends": "BaseComponent", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "members": { "__constructor": { "kind": "constructor", "signature": "constructor(props: IDropdownProps);", "parameters": { "props": { "name": "props", "description": [], "isOptional": false, "isSpread": false, "type": "IDropdownProps" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Constructs a new instance of the " }, { "kind": "api-link", "elements": [ { "kind": "text", "text": "DropdownBase" } ], "target": { "scopeName": "", "packageName": "gpgbk-fabric-react", "exportName": "DropdownBase", "memberName": "" } }, { "kind": "text", "text": " class" } ], "remarks": [] }, "componentDidUpdate": { "kind": "method", "signature": "componentDidUpdate(prevProps: IDropdownProps, prevState: IDropdownState): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "prevProps": { "name": "prevProps", "description": [], "isOptional": false, "isSpread": false, "type": "IDropdownProps" }, "prevState": { "name": "prevState", "description": [], "isOptional": false, "isSpread": false, "type": "IDropdownState" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "componentWillReceiveProps": { "kind": "method", "signature": "componentWillReceiveProps(newProps: IDropdownProps): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "newProps": { "name": "newProps", "description": [], "isOptional": false, "isSpread": false, "type": "IDropdownProps" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "defaultProps": { "kind": "property", "signature": "static defaultProps:", "isOptional": false, "isReadOnly": false, "isStatic": true, "type": "{\n options: any[];\n }", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, "focus": { "kind": "method", "signature": "focus(shouldOpenOnFocus?: boolean): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "shouldOpenOnFocus": { "name": "shouldOpenOnFocus", "description": [], "isOptional": true, "isSpread": false, "type": "boolean" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "render": { "kind": "method", "signature": "render(): JSX.Element;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "JSX.Element", "description": [] }, "parameters": {}, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, "setSelectedIndex": { "kind": "method", "signature": "setSelectedIndex(event: React.FormEvent, index: number): void;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { "type": "void", "description": [] }, "parameters": { "event": { "name": "event", "description": [], "isOptional": false, "isSpread": false, "type": "React.FormEvent" }, "index": { "name": "index", "description": [], "isOptional": false, "isSpread": false, "type": "number" } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false } } }, "DropdownMenuItemType": { "kind": "enum", "values": { "Divider": { "kind": "enum value", "value": "1", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "Header": { "kind": "enum value", "value": "2", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "Normal": { "kind": "enum value", "value": "0", "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false } }, "deprecatedMessage": [], "summary": [], "remarks": [], "isBeta": false }, "elementContains": { "kind": "function", "signature": "export function elementContains(parent: HTMLElement | null, child: HTMLElement | null, allowVirtualParents?: boolean): boolean;", "returnValue": { "type": "boolean", "description": [] }, "parameters": { "parent": { "name": "parent", "description": [], "isOptional": false, "isSpread": false, "type": "HTMLElement | null" }, "child": { "name": "child", "description": [], "isOptional": false, "isSpread": false, "type": "HTMLElement | null" }, "allowVirtualParents": { "name": "allowVirtualParents", "description": [], "isOptional": true, "isSpread": false, "type": "boolean" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Determines whether or not a parent element contains a given child element. If " }, { "kind": "code", "text": "allowVirtualParents", "highlighter": "plain" }, { "kind": "text", "text": " is true, this method may return " }, { "kind": "code", "text": "true", "highlighter": "plain" }, { "kind": "text", "text": " if the child has the parent in its virtual element hierarchy." } ], "remarks": [], "isBeta": false }, "elementContainsAttribute": { "kind": "function", "signature": "export function elementContainsAttribute(element: HTMLElement, attribute: string): string | null;", "returnValue": { "type": "string | null", "description": [ { "kind": "text", "text": "the value of the first instance found" } ] }, "parameters": { "element": { "name": "element", "description": [ { "kind": "text", "text": "element to start searching at" } ], "isOptional": false, "isSpread": false, "type": "HTMLElement" }, "attribute": { "name": "attribute", "description": [ { "kind": "text", "text": "the attribute to search for" } ], "isOptional": false, "isSpread": false, "type": "string" } }, "deprecatedMessage": [], "summary": [ { "kind": "text", "text": "Determines if an element, or any of its ancestors, contain the given attribute" } ], "remarks": [], "isBeta": false }, "ElementType": { "kind": "enum", "values": { "anchor": { "kind": "enum value", "value": "1", "deprecatedMessage": [], "summary": [ { "kind": "html-tag", "token": "" }, { "kind": "text", "text": " element." } ], "remarks": [], "isBeta": false }, "button": { "kind": "enum value", "value": "0", "deprecatedMessage": [], "summary": [ { "kind": "html-tag", "token": "