Deprecate IHotkeyProps, IDocumentationProps, IExampleMap (#6223)

packages/core/src/components/hotkeys/hotkey.tsx

@@ -21,14 +21,17 @@ import { AbstractPureComponent2, Classes, DISPLAYNAME_PREFIX, Props } from "../.
 import { HotkeyConfig } from "../../hooks";
 import { KeyComboTag } from "./keyComboTag";
 
+/** @deprecated */
 export type IHotkeyProps = Props & HotkeyConfig;
+// eslint-disable-next-line deprecation/deprecation
+export type HotkeyProps = IHotkeyProps;
 
 /**
  * Hotkey component.
  *
  * @see https://blueprintjs.com/docs/#core/components/hotkeys
  */
-export class Hotkey extends AbstractPureComponent2<IHotkeyProps> {
+export class Hotkey extends AbstractPureComponent2<HotkeyProps> {
     public static displayName = `${DISPLAYNAME_PREFIX}.Hotkey`;
 
     public static defaultProps = {
@@ -51,7 +54,7 @@ export class Hotkey extends AbstractPureComponent2<IHotkeyProps> {
         );
     }
 
-    protected validateProps(props: IHotkeyProps) {
+    protected validateProps(props: HotkeyProps) {
         if (props.global !== true && props.group == null) {
             console.error("non-global <Hotkey>s must define a group");
         }

packages/core/src/components/hotkeys/hotkeys.tsx

@@ -21,7 +21,7 @@ import { AbstractPureComponent2, Classes, DISPLAYNAME_PREFIX } from "../../commo
 import { HOTKEYS_HOTKEY_CHILDREN } from "../../common/errors";
 import { isElementOfType, isReactChildrenElementOrElements } from "../../common/utils";
 import { H4 } from "../html/html";
-import { Hotkey, IHotkeyProps } from "./hotkey";
+import { Hotkey, HotkeyProps } from "./hotkey";
 import { IHotkeysProps } from "./hotkeysTypes";
 
 /**
@@ -43,7 +43,7 @@ export class Hotkeys extends AbstractPureComponent2<IHotkeysProps> {
 
         const hotkeys = React.Children.map(
             this.props.children,
-            (child: React.ReactElement<IHotkeyProps>) => child.props,
+            (child: React.ReactElement<HotkeyProps>) => child.props,
         );
 
         // sort by group label alphabetically, prioritize globals

packages/core/src/components/hotkeys/hotkeysDialog.tsx

@@ -20,7 +20,7 @@ import * as ReactDOM from "react-dom";
 
 import { Classes } from "../../common";
 import { Dialog, DialogBody, DialogProps } from "../../components";
-import { Hotkey, IHotkeyProps } from "./hotkey";
+import { Hotkey, HotkeyProps } from "./hotkey";
 import { Hotkeys } from "./hotkeys";
 
 export interface IHotkeysDialogProps extends DialogProps {
@@ -44,7 +44,7 @@ class HotkeysDialog {
 
     private container: HTMLElement | null = null;
 
-    private hotkeysQueue = [] as IHotkeyProps[][];
+    private hotkeysQueue = [] as HotkeyProps[][];
 
     private isDialogShowing = false;
 
@@ -75,7 +75,7 @@ class HotkeysDialog {
      * 10msec after the last listener adds their hotkeys, we render the dialog
      * and clear the queue.
      */
-    public enqueueHotkeysForDisplay(hotkeys: IHotkeyProps[]) {
+    public enqueueHotkeysForDisplay(hotkeys: HotkeyProps[]) {
         this.hotkeysQueue.push(hotkeys);
 
         // reset timeout for debounce
@@ -159,7 +159,7 @@ export function setHotkeysDialogProps(props: Partial<IHotkeysDialogProps>) {
     }
 }
 
-export function showHotkeysDialog(hotkeys: IHotkeyProps[]) {
+export function showHotkeysDialog(hotkeys: HotkeyProps[]) {
     HOTKEYS_DIALOG.enqueueHotkeysForDisplay(hotkeys);
 }
 

packages/core/src/components/hotkeys/hotkeysEvents.ts

@@ -17,7 +17,7 @@
 import { Children, ReactNode } from "react";
 
 import { isElementOfType } from "../../common/utils";
-import { Hotkey, IHotkeyProps } from "./hotkey";
+import { Hotkey, HotkeyProps } from "./hotkey";
 import { comboMatches, getKeyCombo, IKeyCombo, parseKeyCombo } from "./hotkeyParser";
 import { hideHotkeysDialogAfterDelay, isHotkeysDialogShowing, showHotkeysDialog } from "./hotkeysDialog";
 import { IHotkeysProps } from "./hotkeysTypes";
@@ -31,7 +31,7 @@ export enum HotkeyScope {
 
 export interface IHotkeyAction {
     combo: IKeyCombo;
-    props: IHotkeyProps;
+    props: HotkeyProps;
 }
 
 export class HotkeysEvents {
@@ -107,7 +107,7 @@ export class HotkeysEvents {
         }
     }
 
-    private isScope(props: IHotkeyProps) {
+    private isScope(props: HotkeyProps) {
         return (props.global ? HotkeyScope.GLOBAL : HotkeyScope.LOCAL) === this.scope;
     }
 

packages/core/src/components/hotkeys/index.ts

@@ -18,7 +18,7 @@
 
 export * from "./hotkeysTypes";
 export * from "./hotkeys";
-export { Hotkey, IHotkeyProps } from "./hotkey";
+export { Hotkey, HotkeyProps, IHotkeyProps } from "./hotkey";
 export { KeyCombo, KeyComboTag, KeyComboTagProps, IKeyComboProps } from "./keyComboTag";
 // eslint-disable-next-line import/no-cycle
 export { HotkeysTarget, IHotkeysTargetComponent } from "./hotkeysTarget";

packages/docs-app/src/components/blueprintDocs.tsx

@@ -20,7 +20,7 @@ import * as React from "react";
 
 import { AnchorButton, Classes, HotkeysProvider, Tag } from "@blueprintjs/core";
 import { IDocsCompleteData } from "@blueprintjs/docs-data";
-import { Banner, Documentation, IDocumentationProps, NavMenuItem, NavMenuItemProps } from "@blueprintjs/docs-theme";
+import { Banner, Documentation, DocumentationProps, NavMenuItem, NavMenuItemProps } from "@blueprintjs/docs-theme";
 
 import { highlightCodeBlocks } from "../styles/syntaxHighlighting";
 import { NavHeader } from "./navHeader";
@@ -57,8 +57,8 @@ export function setTheme(themeName: string) {
 
 export interface IBlueprintDocsProps {
     docs: IDocsCompleteData;
-    defaultPageId: IDocumentationProps["defaultPageId"];
-    tagRenderers: IDocumentationProps["tagRenderers"];
+    defaultPageId: DocumentationProps["defaultPageId"];
+    tagRenderers: DocumentationProps["tagRenderers"];
     /** Whether to use `next` versions for packages (as opposed to `latest`). */
     useNextVersion: boolean;
 }

packages/docs-app/src/examples/core-examples/hotkeysTarget2Example.tsx

@@ -16,7 +16,7 @@
 
 import * as React from "react";
 
-import { HotkeysTarget2, IHotkeyProps } from "@blueprintjs/core";
+import { HotkeyProps, HotkeysTarget2 } from "@blueprintjs/core";
 import { Example, ExampleProps } from "@blueprintjs/docs-theme";
 
 import { PianoKey } from "./audio";
@@ -57,7 +57,7 @@ export class HotkeysTarget2Example extends React.PureComponent<ExampleProps, IHo
         };
     };
 
-    private hotkeys: IHotkeyProps[] = [
+    private hotkeys: HotkeyProps[] = [
         {
             combo: "shift + P",
             global: true,

packages/docs-app/src/tags/reactExamples.ts

@@ -16,7 +16,7 @@
 
 import * as React from "react";
 
-import { ExampleProps, IExampleMap } from "@blueprintjs/docs-theme";
+import { ExampleMap, ExampleProps } from "@blueprintjs/docs-theme";
 
 import { getTheme } from "../components/blueprintDocs";
 import * as CoreExamples from "../examples/core-examples";
@@ -34,7 +34,7 @@ function getPackageExamples(
     packageName: string,
     packageExamples: { [name: string]: React.ComponentClass<ExampleProps<IBlueprintExampleData>> },
 ) {
-    const ret: IExampleMap = {};
+    const ret: ExampleMap = {};
     for (const exampleName of Object.keys(packageExamples)) {
         const example = packageExamples[exampleName];
         const fileName = exampleName.charAt(0).toLowerCase() + exampleName.slice(1) + ".tsx";
@@ -46,7 +46,7 @@ function getPackageExamples(
     return ret;
 }
 
-export const reactExamples: IExampleMap = (() => {
+export const reactExamples: ExampleMap = (() => {
     return {
         ...getPackageExamples("core", CoreExamples as any),
         ...getPackageExamples("datetime", DateExamples as any),

packages/docs-theme/src/components/documentation.tsx

@@ -32,6 +32,7 @@ import { Page } from "./page";
 import { addScrollbarStyle } from "./scrollbar";
 import { ApiLink } from "./typescript/apiLink";
 
+/** @deprecated use DocumentationProps */
 export interface IDocumentationProps extends Props {
     /**
      * An element to place above the documentation, along the top of the viewport.
@@ -108,6 +109,9 @@ export interface IDocumentationProps extends Props {
     tagRenderers: TagRendererMap;
 }
 
+// eslint-disable-next-line deprecation/deprecation
+export type DocumentationProps = IDocumentationProps;
+
 export interface IDocumentationState {
     activeApiMember: string;
     activePageId: string;
@@ -116,7 +120,7 @@ export interface IDocumentationState {
     isNavigatorOpen: boolean;
 }
 
-export class Documentation extends React.PureComponent<IDocumentationProps, IDocumentationState> {
+export class Documentation extends React.PureComponent<DocumentationProps, IDocumentationState> {
     public static childContextTypes = DocumentationContextTypes;
 
     /** Map of section route to containing page reference. */
@@ -131,7 +135,7 @@ export class Documentation extends React.PureComponent<IDocumentationProps, IDoc
         nav: (ref: HTMLElement) => (this.navElement = ref),
     };
 
-    public constructor(props: IDocumentationProps) {
+    public constructor(props: DocumentationProps) {
         super(props);
         this.state = {
             activeApiMember: "",
@@ -271,7 +275,7 @@ export class Documentation extends React.PureComponent<IDocumentationProps, IDoc
         document.removeEventListener("scroll", this.handleScroll);
     }
 
-    public componentDidUpdate(_prevProps: IDocumentationProps, prevState: IDocumentationState) {
+    public componentDidUpdate(_prevProps: DocumentationProps, prevState: IDocumentationState) {
         const { activePageId } = this.state;
 
         // only scroll to heading when switching pages, but always check if nav item needs scrolling.

packages/docs-theme/src/tags/reactExample.tsx

@@ -28,12 +28,15 @@ export interface IExample {
 
 // construct a map of package name to all examples defined in that package.
 // packageName must match directory name as it is used to generate sourceUrl.
+/** @deprecated use ExampleMap */
 export interface IExampleMap {
     [componentName: string]: IExample;
 }
+// eslint-disable-next-line deprecation/deprecation
+export type ExampleMap = IExampleMap;
 
 export class ReactExampleTagRenderer {
-    constructor(private examples: IExampleMap) {}
+    constructor(private examples: ExampleMap) {}
 
     /**
      * Given the name of an example component, like `"AlertExample"`, attempts to resolve