From f1d7bb3c35531554d4e855a9b2e3e7966a47fc17 Mon Sep 17 00:00:00 2001 From: Natalie Ethell Date: Tue, 26 Mar 2019 15:24:10 -0700 Subject: [PATCH] Update api files (#8477) * update api files * change files --- .../updateAPIFiles_2019-03-26-21-59.json | 11 +++ .../updateAPIFiles_2019-03-26-21-59.json | 11 +++ .../updateAPIFiles_2019-03-26-21-59.json | 11 +++ packages/merge-styles/etc/merge-styles.api.md | 1 - .../etc/office-ui-fabric-react.api.md | 72 +------------------ packages/utilities/etc/utilities.api.md | 4 -- 6 files changed, 35 insertions(+), 75 deletions(-) create mode 100644 common/changes/@uifabric/merge-styles/updateAPIFiles_2019-03-26-21-59.json create mode 100644 common/changes/@uifabric/utilities/updateAPIFiles_2019-03-26-21-59.json create mode 100644 common/changes/office-ui-fabric-react/updateAPIFiles_2019-03-26-21-59.json diff --git a/common/changes/@uifabric/merge-styles/updateAPIFiles_2019-03-26-21-59.json b/common/changes/@uifabric/merge-styles/updateAPIFiles_2019-03-26-21-59.json new file mode 100644 index 0000000000000..0133a8509e28f --- /dev/null +++ b/common/changes/@uifabric/merge-styles/updateAPIFiles_2019-03-26-21-59.json @@ -0,0 +1,11 @@ +{ + "changes": [ + { + "packageName": "@uifabric/merge-styles", + "comment": "update API file", + "type": "patch" + } + ], + "packageName": "@uifabric/merge-styles", + "email": "naethell@microsoft.com" +} \ No newline at end of file diff --git a/common/changes/@uifabric/utilities/updateAPIFiles_2019-03-26-21-59.json b/common/changes/@uifabric/utilities/updateAPIFiles_2019-03-26-21-59.json new file mode 100644 index 0000000000000..acde3eb3881cb --- /dev/null +++ b/common/changes/@uifabric/utilities/updateAPIFiles_2019-03-26-21-59.json @@ -0,0 +1,11 @@ +{ + "changes": [ + { + "packageName": "@uifabric/utilities", + "comment": "update API file", + "type": "patch" + } + ], + "packageName": "@uifabric/utilities", + "email": "naethell@microsoft.com" +} \ No newline at end of file diff --git a/common/changes/office-ui-fabric-react/updateAPIFiles_2019-03-26-21-59.json b/common/changes/office-ui-fabric-react/updateAPIFiles_2019-03-26-21-59.json new file mode 100644 index 0000000000000..1961ebf9163d9 --- /dev/null +++ b/common/changes/office-ui-fabric-react/updateAPIFiles_2019-03-26-21-59.json @@ -0,0 +1,11 @@ +{ + "changes": [ + { + "packageName": "office-ui-fabric-react", + "comment": "update API file", + "type": "patch" + } + ], + "packageName": "office-ui-fabric-react", + "email": "naethell@microsoft.com" +} \ No newline at end of file diff --git a/packages/merge-styles/etc/merge-styles.api.md b/packages/merge-styles/etc/merge-styles.api.md index 62539925c6472..6823672618b1e 100644 --- a/packages/merge-styles/etc/merge-styles.api.md +++ b/packages/merge-styles/etc/merge-styles.api.md @@ -141,7 +141,6 @@ export function setRTL(isRTL: boolean): void; // @public export class Stylesheet { - // (undocumented) constructor(config?: IStyleSheetConfig); argsFromClassName(className: string): IStyle[] | undefined; cacheClassName(className: string, key: string, args: IStyle[], rules: string[]): void; diff --git a/packages/office-ui-fabric-react/etc/office-ui-fabric-react.api.md b/packages/office-ui-fabric-react/etc/office-ui-fabric-react.api.md index c98313563c53e..b1c898a712d97 100644 --- a/packages/office-ui-fabric-react/etc/office-ui-fabric-react.api.md +++ b/packages/office-ui-fabric-react/etc/office-ui-fabric-react.api.md @@ -41,7 +41,6 @@ export class ActionButton extends BaseComponent { // @public (undocumented) export class ActivityItem extends BaseComponent { - // (undocumented) constructor(props: IActivityItemProps); // (undocumented) render(): JSX.Element; @@ -65,7 +64,6 @@ export class AnnouncedBase extends React.Component { // @public (undocumented) export class Autofill extends BaseComponent implements IAutofill { - // (undocumented) constructor(props: IAutofillProps); // (undocumented) clear(): void; @@ -101,7 +99,6 @@ export class BaseAutoFill extends Autofill { // @public (undocumented) export class BaseButton extends BaseComponent implements IButton { - // (undocumented) constructor(props: IBaseButtonProps, rootClassName: string); // (undocumented) componentDidMount(): void; @@ -125,7 +122,6 @@ export class BaseExtendedPeoplePicker extends BaseExtendedPicker> extends BaseComponent> implements IBaseExtendedPicker { - // (undocumented) constructor(basePickerProps: P); // (undocumented) protected canAddItems(): boolean; @@ -189,7 +185,6 @@ export class BaseFloatingPeoplePicker extends BaseFloatingPicker> extends BaseComponent implements IBaseFloatingPicker { - // (undocumented) constructor(basePickerProps: P); // (undocumented) completeSuggestion: () => void; @@ -263,7 +258,6 @@ export class BasePeopleSelectedItemsList extends BaseSelectedItemsList> extends BaseComponent implements IBasePicker { - // (undocumented) constructor(basePickerProps: P); // (undocumented) protected addItem: (item: T) => void; @@ -375,7 +369,6 @@ export class BasePickerListBelow> extends BaseP // @public (undocumented) export class BaseSelectedItemsList> extends BaseComponent> implements IBaseSelectedItemsList { - // (undocumented) constructor(basePickerProps: P); // (undocumented) addItems: (items: T[]) => void; @@ -439,7 +432,6 @@ export const Breadcrumb: React.StatelessComponent; // @public (undocumented) export class BreadcrumbBase extends BaseComponent { - // (undocumented) constructor(props: IBreadcrumbProps); // (undocumented) componentWillReceiveProps(nextProps: IBreadcrumbProps): void; @@ -455,7 +447,6 @@ export function buildColumns(items: any[], canResizeColumns?: boolean, onColumnC // @public @deprecated export class Button extends BaseComponent { - // (undocumented) constructor(props: IButtonProps); // (undocumented) render(): JSX.Element; @@ -482,7 +473,6 @@ export enum ButtonType { // @public (undocumented) export class Calendar extends BaseComponent implements ICalendar { - // (undocumented) constructor(props: ICalendarProps); // (undocumented) componentDidUpdate(): void; @@ -500,7 +490,6 @@ export class Calendar extends BaseComponent impl // // @public (undocumented) export class Callout extends BaseComponent { - // (undocumented) constructor(props: ICalloutProps); // (undocumented) render(): JSX.Element; @@ -551,7 +540,6 @@ export const ChoiceGroup: React_2.StatelessComponent; // @public (undocumented) export class ChoiceGroupBase extends BaseComponent implements IChoiceGroup { - // (undocumented) constructor(props: IChoiceGroupProps); readonly checkedOption: IChoiceGroupOption | undefined; // (undocumented) @@ -578,7 +566,6 @@ export const COACHMARK_ATTRIBUTE_NAME = "data-coachmarkid"; // @public (undocumented) export class CoachmarkBase extends BaseComponent implements ICoachmark { - // (undocumented) constructor(props: ICoachmarkProps); // (undocumented) componentDidMount(): void; @@ -609,7 +596,6 @@ export const ColorPicker: React_2.StatelessComponent; // @public (undocumented) export class ColorPickerBase extends BaseComponent implements IColorPicker { - // (undocumented) constructor(props: IColorPickerProps); // (undocumented) readonly color: IColor; @@ -654,7 +640,6 @@ export enum ColumnDragEndLocation { // @public (undocumented) export class ComboBox extends BaseComponent { - // (undocumented) constructor(props: IComboBoxProps); // (undocumented) componentDidMount(): void; @@ -667,6 +652,8 @@ export class ComboBox extends BaseComponent { // (undocumented) static defaultProps: IComboBoxProps; dismissMenu: () => void; + // Warning: (ae-unresolved-inheritdoc-base) The `@inheritDoc` tag needs a TSDoc declaration reference; signature matching is not supported yet + // // (undocumented) focus: (shouldOpenOnFocus?: boolean | undefined, useFocusAsync?: boolean | undefined) => void; // (undocumented) @@ -728,7 +715,6 @@ export const ContextualMenu: React_2.StatelessComponent; // @public (undocumented) export class ContextualMenuBase extends BaseComponent { - // (undocumented) constructor(props: IContextualMenuProps); // (undocumented) componentDidMount(): void; @@ -795,7 +781,6 @@ export const DatePicker: React_2.StatelessComponent; // @public (undocumented) export class DatePickerBase extends BaseComponent implements IDatePicker { - // (undocumented) constructor(props: IDatePickerProps); // (undocumented) componentDidUpdate(prevProps: IDatePickerProps, prevState: IDatePickerState): void; @@ -859,7 +844,6 @@ export const DetailsList: React_2.StatelessComponent; // @public (undocumented) export class DetailsListBase extends BaseComponent implements IDetailsList { - // (undocumented) constructor(props: IDetailsListProps); // (undocumented) componentDidUpdate(prevProps: IDetailsListProps, prevState: IDetailsListState): void; @@ -904,7 +888,6 @@ export const DetailsRow: React_2.StatelessComponent; // @public (undocumented) export class DetailsRowBase extends BaseComponent { - // (undocumented) constructor(props: IDetailsRowBaseProps); // (undocumented) componentDidMount(): void; @@ -933,7 +916,6 @@ export const Dialog: React_2.StatelessComponent; // @public (undocumented) export class DialogBase extends BaseComponent { - // (undocumented) constructor(props: IDialogProps); // (undocumented) static defaultProps: IDialogProps; @@ -946,7 +928,6 @@ export const DialogContent: React_2.StatelessComponent; // @public (undocumented) export class DialogContentBase extends BaseComponent { - // (undocumented) constructor(props: IDialogContentProps); // (undocumented) static defaultProps: IDialogContentProps; @@ -1032,7 +1013,6 @@ export const Dropdown: React_2.StatelessComponent; // @public (undocumented) export class DropdownBase extends BaseComponent { - // (undocumented) constructor(props: IDropdownProps); // (undocumented) componentDidUpdate(prevProps: IDropdownProps, prevState: IDropdownState): void; @@ -1061,7 +1041,6 @@ export const ExpandingCard: React_2.StatelessComponent; // @public (undocumented) export class ExpandingCardBase extends BaseComponent { - // (undocumented) constructor(props: IExpandingCardProps); // (undocumented) componentDidMount(): void; @@ -1089,7 +1068,6 @@ export class ExtendedPeoplePicker extends BaseExtendedPeoplePicker { // @public (undocumented) export class ExtendedSelectedItem extends BaseComponent { - // (undocumented) constructor(props: ISelectedPeopleItemProps); // (undocumented) protected persona: React.RefObject; @@ -1104,7 +1082,6 @@ export const Fabric: React_2.StatelessComponent; export class FabricBase extends BaseComponent { - // (undocumented) constructor(props: IFabricProps); // (undocumented) componentDidMount(): void; @@ -1165,7 +1142,6 @@ export const Facepile: React_2.StatelessComponent; // @public export class FacepileBase extends BaseComponent { - // (undocumented) constructor(props: IFacepileProps); // (undocumented) static defaultProps: IFacepileProps; @@ -1212,7 +1188,6 @@ export class FocusTrapZone extends BaseComponent implem // @public (undocumented) export class FocusZone extends React.Component implements IFocusZone { - // (undocumented) constructor(props: IFocusZoneProps); // (undocumented) componentDidMount(): void; @@ -1304,7 +1279,6 @@ export const GroupedList: React_2.StatelessComponent; // @public (undocumented) export class GroupedListBase extends BaseComponent implements IGroupedList { - // (undocumented) constructor(props: IGroupedListProps); // (undocumented) componentWillReceiveProps(newProps: IGroupedListProps): void; @@ -1354,7 +1328,6 @@ export const HoverCard: React_2.StatelessComponent; // @public (undocumented) export class HoverCardBase extends BaseComponent { - // (undocumented) constructor(props: IHoverCardProps); // (undocumented) componentDidMount(): void; @@ -2765,7 +2738,6 @@ export const Icon: React_2.StatelessComponent; // @public (undocumented) export class IconBase extends React.PureComponent { - // (undocumented) constructor(props: IIconProps); // (undocumented) render(): JSX.Element; @@ -4995,7 +4967,6 @@ export const Image: React_2.StatelessComponent; // @public (undocumented) export class ImageBase extends React.Component { - // (undocumented) constructor(props: IImageProps); // (undocumented) componentDidUpdate(prevProps: IImageProps, prevState: IImageState): void; @@ -7497,7 +7468,6 @@ export const KeytipLayer: React_2.StatelessComponent; // @public export class KeytipLayerBase extends BaseComponent { - // (undocumented) constructor(props: IKeytipLayerProps, context: any); // (undocumented) componentDidMount(): void; @@ -7532,7 +7502,6 @@ export const Layer: React_2.StatelessComponent; // @public (undocumented) export class LayerBase extends BaseComponent { - // (undocumented) constructor(props: ILayerProps); // (undocumented) componentDidMount(): void; @@ -7577,7 +7546,6 @@ export class LinkBase extends BaseComponent implements ILink { // @public export class List extends BaseComponent implements IList { - // (undocumented) constructor(props: IListProps); // (undocumented) componentDidMount(): void; @@ -7622,7 +7590,6 @@ export const MarqueeSelection: React_2.StatelessComponent implements ITextField { - // (undocumented) constructor(props: ITextFieldProps); // (undocumented) blur(): void; @@ -7682,7 +7649,6 @@ export const MessageBar: React_2.StatelessComponent; // @public (undocumented) export class MessageBarBase extends BaseComponent { - // (undocumented) constructor(props: IMessageBarProps); // (undocumented) static defaultProps: IMessageBarProps; @@ -7713,7 +7679,6 @@ export const Modal: React_2.StatelessComponent; // @public (undocumented) export class ModalBase extends BaseComponent implements IModal { - // (undocumented) constructor(props: IModalProps); // (undocumented) componentDidUpdate(prevProps: IModalProps, prevState: IDialogState): void; @@ -7735,7 +7700,6 @@ export const Nav: React_2.StatelessComponent; // @public (undocumented) export class NavBase extends BaseComponent implements INav { - // (undocumented) constructor(props: INavProps); // (undocumented) componentWillReceiveProps(newProps: INavProps): void; @@ -7784,7 +7748,6 @@ export const OverflowSet: React_2.StatelessComponent; // @public (undocumented) export class OverflowSetBase extends BaseComponent implements IOverflowSet { - // (undocumented) constructor(props: IOverflowSetProps); // (undocumented) componentDidMount(): void; @@ -7853,7 +7816,6 @@ export const Persona: React_2.StatelessComponent; // @public export class PersonaBase extends BaseComponent { - // (undocumented) constructor(props: IPersonaProps); // (undocumented) static defaultProps: IPersonaProps; @@ -7866,7 +7828,6 @@ export const PersonaCoin: React_2.StatelessComponent; // @public export class PersonaCoinBase extends BaseComponent { - // (undocumented) constructor(props: IPersonaCoinProps); // (undocumented) componentWillReceiveProps(nextProps: IPersonaCoinProps): void; @@ -8008,7 +7969,6 @@ export const Pivot: React_2.StatelessComponent; // @public export class PivotBase extends BaseComponent { - // (undocumented) constructor(props: IPivotProps); focus(): void; // (undocumented) @@ -8017,7 +7977,6 @@ export class PivotBase extends BaseComponent { // @public (undocumented) export class PivotItem extends BaseComponent { - // (undocumented) constructor(props: IPivotItemProps); // (undocumented) render(): JSX.Element; @@ -8046,7 +8005,6 @@ export class PlainCardBase extends BaseComponent { // @public export class Popup extends BaseComponent { - // (undocumented) constructor(props: IPopupProps); // (undocumented) componentDidMount(): void; @@ -8066,7 +8024,6 @@ export class Popup extends BaseComponent { // @public (undocumented) export class PositioningContainer extends BaseComponent implements PositioningContainer { - // (undocumented) constructor(props: IPositioningContainerProps); // (undocumented) componentDidMount(): void; @@ -8131,7 +8088,6 @@ export const Rating: React_2.StatelessComponent; // @public (undocumented) export class RatingBase extends BaseComponent { - // (undocumented) constructor(props: IRatingProps); // (undocumented) componentWillReceiveProps(nextProps: IRatingProps): void; @@ -8154,7 +8110,6 @@ export const ResizeGroup: typeof ResizeGroupBase; // @public (undocumented) export class ResizeGroupBase extends BaseComponent { - // (undocumented) constructor(props: IResizeGroupProps); // (undocumented) componentDidMount(): void; @@ -8179,7 +8134,6 @@ export const ScrollablePane: React_2.StatelessComponent; // @public (undocumented) export class ScrollablePaneBase extends BaseComponent implements IScrollablePane { - // (undocumented) constructor(props: IScrollablePaneProps); // (undocumented) addSticky: (sticky: Sticky) => void; @@ -8252,7 +8206,6 @@ export const SearchBox: React_2.StatelessComponent; // @public (undocumented) export class SearchBoxBase extends BaseComponent { - // (undocumented) constructor(props: ISearchBoxProps); // (undocumented) componentWillReceiveProps(newProps: ISearchBoxProps): void; @@ -8288,7 +8241,6 @@ export class SelectedPeopleList extends BasePeopleSelectedItemsList { // @public (undocumented) export class Selection implements ISelection { - // (undocumented) constructor(options?: ISelectionOptions); // (undocumented) canSelectItem(item: IObjectWithKey, index?: number): boolean; @@ -8416,7 +8368,6 @@ export const Shimmer: React_2.StatelessComponent; // @public (undocumented) export class ShimmerBase extends BaseComponent { - // (undocumented) constructor(props: IShimmerProps); // (undocumented) componentWillReceiveProps(nextProps: IShimmerProps): void; @@ -8431,7 +8382,6 @@ export const ShimmerCircle: React_2.StatelessComponent; // @public (undocumented) export class ShimmerCircleBase extends BaseComponent { - // (undocumented) constructor(props: IShimmerCircleProps); // (undocumented) render(): JSX.Element; @@ -8444,7 +8394,6 @@ export const ShimmeredDetailsList: React_2.StatelessComponent { - // (undocumented) constructor(props: IShimmeredDetailsListProps); // (undocumented) render(): JSX.Element; @@ -8462,7 +8411,6 @@ export const ShimmerElementsGroup: React_2.StatelessComponent { - // (undocumented) constructor(props: IShimmerElementsGroupProps); // (undocumented) static defaultProps: IShimmerElementsGroupProps; @@ -8482,7 +8430,6 @@ export const ShimmerGap: React_2.StatelessComponent; // @public (undocumented) export class ShimmerGapBase extends BaseComponent { - // (undocumented) constructor(props: IShimmerGapProps); // (undocumented) render(): JSX.Element; @@ -8493,7 +8440,6 @@ export const ShimmerLine: React_2.StatelessComponent; // @public (undocumented) export class ShimmerLineBase extends BaseComponent { - // (undocumented) constructor(props: IShimmerLineProps); // (undocumented) render(): JSX.Element; @@ -8522,7 +8468,6 @@ export const Slider: React_2.StatelessComponent; // @public (undocumented) export class SliderBase extends BaseComponent implements ISlider { - // (undocumented) constructor(props: ISliderProps); componentWillReceiveProps(newProps: ISliderProps): void; // (undocumented) @@ -8537,7 +8482,6 @@ export class SliderBase extends BaseComponent implem // @public (undocumented) export class SpinButton extends BaseComponent implements ISpinButton { - // (undocumented) constructor(props: ISpinButtonProps); componentWillReceiveProps(newProps: ISpinButtonProps): void; // (undocumented) @@ -8589,7 +8533,6 @@ export const StackItem: React.StatelessComponent; // @public (undocumented) export class Sticky extends BaseComponent { - // (undocumented) constructor(props: IStickyProps); // (undocumented) addSticky(stickyContent: HTMLDivElement): void; @@ -8662,7 +8605,6 @@ export enum SuggestionItemType { // @public (undocumented) export class Suggestions extends BaseComponent, ISuggestionsState> { - // (undocumented) constructor(suggestionsProps: ISuggestionsProps); // (undocumented) componentDidMount(): void; @@ -8695,7 +8637,6 @@ export class Suggestions extends BaseComponent, ISuggest // @public export class SuggestionsControl extends BaseComponent, ISuggestionsControlState> { - // (undocumented) constructor(suggestionsProps: ISuggestionsControlProps); // (undocumented) componentDidMount(): void; @@ -8747,7 +8688,6 @@ export class SuggestionsControl extends BaseComponent { - // (undocumented) constructor(); // (undocumented) convertSuggestionsToSuggestionItems(suggestions: Array | T>): ISuggestionModel[]; @@ -8781,7 +8721,6 @@ export class SuggestionsController { // @public export class SuggestionsCore extends BaseComponent, {}> { - // (undocumented) constructor(suggestionsProps: ISuggestionsCoreProps); // (undocumented) componentDidUpdate(): void; @@ -8827,7 +8766,6 @@ export class SuggestionsItem extends BaseComponent, { // @public (undocumented) export class SuggestionsStore { - // (undocumented) constructor(); // (undocumented) convertSuggestionsToSuggestionItems(suggestions: Array | T>): ISuggestionModel[]; @@ -8848,7 +8786,6 @@ export const SwatchColorPicker: React_2.StatelessComponent implements ISwatchColorPicker { - // (undocumented) constructor(props: ISwatchColorPickerProps); // (undocumented) componentWillReceiveProps(newProps: ISwatchColorPickerProps): void; @@ -8889,7 +8826,6 @@ export const TeachingBubble: React_2.StatelessComponent; // @public (undocumented) export class TeachingBubbleBase extends BaseComponent { - // (undocumented) constructor(props: ITeachingBubbleProps); // (undocumented) static defaultProps: { @@ -8914,7 +8850,6 @@ export const TeachingBubbleContent: React_2.StatelessComponent { - // (undocumented) constructor(props: ITeachingBubbleProps); // (undocumented) componentDidMount(): void; @@ -8945,7 +8880,6 @@ export const TextField: React_2.StatelessComponent; // @public (undocumented) export class TextFieldBase extends BaseComponent implements ITextField { - // (undocumented) constructor(props: ITextFieldProps); blur(): void; // (undocumented) @@ -9000,7 +8934,6 @@ export const Toggle: React.StatelessComponent; // @public (undocumented) export class ToggleBase extends BaseComponent implements IToggle { - // (undocumented) constructor(props: IToggleProps); readonly checked: boolean; // (undocumented) @@ -9037,7 +8970,6 @@ export const TooltipHost: React_2.StatelessComponent; // @public (undocumented) export class TooltipHostBase extends BaseComponent implements ITooltipHost { - // (undocumented) constructor(props: ITooltipHostProps); // (undocumented) componentWillUnmount(): void; diff --git a/packages/utilities/etc/utilities.api.md b/packages/utilities/etc/utilities.api.md index 7e6e408850c0a..078442cf9a7ad 100644 --- a/packages/utilities/etc/utilities.api.md +++ b/packages/utilities/etc/utilities.api.md @@ -43,7 +43,6 @@ export function assign(target: any, ...args: any[]): any; // @public export class Async { - // (undocumented) constructor(parent?: object, onError?: (e: any) => void); // (undocumented) cancelAnimationFrame(id: number): void; @@ -78,7 +77,6 @@ export function autobind(target: any, key: string, descripto // @public export class AutoScroll { - // (undocumented) constructor(element: HTMLElement); // (undocumented) dispose(): void; @@ -173,7 +171,6 @@ export const DATA_PORTAL_ATTRIBUTE = "data-portal-element"; // // @public export class DelayedRender extends React_2.Component { - // (undocumented) constructor(props: IDelayedRenderProps); // (undocumented) componentDidMount(): void; @@ -856,7 +853,6 @@ export function raiseClick(target: Element): void; // @public export class Rectangle { - // (undocumented) constructor(left?: number, right?: number, top?: number, bottom?: number); // (undocumented) bottom: number;