@khanacademy/wonder-blocks-link 4.4.0 → 5.0.1

package/dist/components/link.js.flow

@@ -1,376 +0,0 @@
-/**
- * Flowtype definitions for data
- * Generated by Flowgen from a Typescript Definition
- * Flowgen v1.21.0
- * @flow
- */
-import * as $Flowgen$Import$_2e__2e__2f__2e__2e__2f__2e__2e__2f_wonder_2d_blocks_2d_core_2f_src_2f_util_2f_aria_2d_types from "../../../wonder-blocks-core/src/util/aria-types";
-import * as $Flowgen$Import$_40_khanacademy_2f_wonder_2d_blocks_2d_icon from "@khanacademy/wonder-blocks-icon";
-import * as React from "react";
-import { Link as ReactRouterLink } from "react-router-dom";
-import type { AriaProps, StyleType } from "@khanacademy/wonder-blocks-core";
-import Icon from "@khanacademy/wonder-blocks-icon";
-import type { Typography } from "@khanacademy/wonder-blocks-typography";
-export type SharedProps = {|
-  ...AriaProps,
-  ...{|
-    /**
-     * Text to appear on the link. It can be a plain text or a Typography element.
-     */
-    children: string | React.Element<Typography>,
-
-    /**
-     * URL to navigate to.
-     */
-    href: string,
-
-    /**
-     * An optional id attribute.
-     */
-    id?: string,
-
-    /**
-     * Indicates that this link is used within a body of text.
-     * This styles the link with an underline to distinguish it
-     * from surrounding text.
-     */
-    inline?: boolean,
-
-    /**
-     * Kind of Link. Note: Secondary light Links are not supported.
-     */
-    kind?: "primary" | "secondary",
-
-    /**
-     * Whether the button is on a dark/colored background.
-     */
-    light?: boolean,
-
-    /**
-     * Whether the link should change color once it's visited.
-     * secondary or primary (light) links are not allowed to be visitable.
-     */
-    visitable?: boolean,
-
-    /**
-     * Specifies the type of relationship between the current document and the
-     * linked document. Should only be used when `href` is specified. This
-     * defaults to "noopener noreferrer" when `target="_blank"`, but can be
-     * overridden by setting this prop to something else.
-     */
-    rel?: string,
-
-    /**
-     * Set the tabindex attribute on the rendered element.
-     */
-    tabIndex?: number,
-
-    /**
-     * Test ID used for e2e testing.
-     */
-    testId?: string,
-
-    /**
-     * Whether to avoid using client-side navigation.
-     *
-     * If the URL passed to href is local to the client-side, e.g.
-     * /math/algebra/eval-exprs, then it tries to use react-router-dom's Link
-     * component which handles the client-side navigation. You can set
-     * `skipClientNav` to true avoid using client-side nav entirely.
-     *
-     * NOTE: All URLs containing a protocol are considered external, e.g.
-     * https://khanacademy.org/math/algebra/eval-exprs will trigger a full
-     * page reload.
-     */
-    skipClientNav?: boolean,
-
-    /**
-     * Custom styles.
-     */
-    style?: StyleType,
-
-    /**
-     * Adds CSS classes to the Link.
-     */
-    className?: string,
-
-    /**
-     * Function to call when button is clicked.
-     *
-     * This callback should be used for things like marking BigBingo
-     * conversions. It should NOT be used to redirect to a different URL or to
-     * prevent navigation via e.preventDefault(). The event passed to this
-     * handler will have its preventDefault() and stopPropagation() methods
-     * stubbed out.
-     */
-    onClick?: (e: SyntheticEvent<>) => mixed,
-
-    /**
-     * Run async code in the background while client-side navigating. If the
-     * browser does a full page load navigation, the callback promise must be
-     * settled before the navigation will occur. Errors are ignored so that
-     * navigation is guaranteed to succeed.
-     */
-    safeWithNav?: () => Promise<mixed>,
-
-    /**
-     * Respond to raw "keydown" event.
-     */
-    onKeyDown?: (e: SyntheticKeyboardEvent<>) => mixed,
-
-    /**
-     * Respond to raw "keyup" event.
-     */
-    onKeyUp?: (e: SyntheticKeyboardEvent<>) => mixed,
-
-    /**
-     * A target destination window for a link to open in.  We only support
-     * "_blank" which opens the URL in a new tab.
-     *
-     * TODO(WB-1262): only allow this prop when `href` is also set.t
-     */
-    target?: "_blank",
-
-    /**
-     * Run async code before navigating to the URL passed to `href`. If the
-     * promise returned rejects then navigation will not occur.
-     *
-     * If both safeWithNav and beforeNav are provided, beforeNav will be run
-     * first and safeWithNav will only be run if beforeNav does not reject.
-     *
-     * WARNING: Using this with `target="_blank"` will trigger built-in popup
-     * blockers in Firefox and Safari.  This is because we do navigation
-     * programmatically and `beforeNav` causes a delay which means that the
-     * browser can't make a directly link between a user action and the
-     * navigation.
-     */
-    beforeNav?: () => Promise<mixed>,
-
-    /**
-     * An optional title attribute.
-     */
-    title?: string,
-
-    /**
-     * An optional icon displayed before the link label.
-     */
-    startIcon?: React.Element<typeof Icon>,
-
-    /**
-     * An optional icon displayed after the link label.
-     * If `target="_blank"` and `endIcon` is passed in, `endIcon` will override
-     * the default `externalIcon`.
-     */
-    endIcon?: React.Element<typeof Icon>,
-  |},
-|};
-/**
- * Reusable link component.
- *
- * Consisting of a [`ClickableBehavior`](#clickablebehavior) surrounding a
- * `LinkCore`. `ClickableBehavior` handles interactions and state changes.
- * `LinkCore` is a stateless component which displays the different states
- * the `Link` can take.
- *
- * ### Usage
- *
- * ```jsx
- * <Link
- *     href="https://khanacademy.org/"
- * >
- *     Label
- * </Link>
- * ```
- */
-declare var Link: React.ForwardRefExoticComponent<{|
-  ...$ReadOnly<$Flowgen$Import$_2e__2e__2f__2e__2e__2f__2e__2e__2f_wonder_2d_blocks_2d_core_2f_src_2f_util_2f_aria_2d_types.AriaAttributes>,
-  ...$ReadOnly<{|
-    role?: $Flowgen$Import$_2e__2e__2f__2e__2e__2f__2e__2e__2f_wonder_2d_blocks_2d_core_2f_src_2f_util_2f_aria_2d_types.AriaRole | void,
-  |}>,
-  ...{|
-    /**
-     * Text to appear on the link. It can be a plain text or a Typography element.
-     */
-    children: string | React.Element<Typography>,
-
-    /**
-     * URL to navigate to.
-     */
-    href: string,
-
-    /**
-     * An optional id attribute.
-     */
-    id?: string | void,
-
-    /**
-     * Indicates that this link is used within a body of text.
-     * This styles the link with an underline to distinguish it
-     * from surrounding text.
-     */
-    inline?: boolean | void,
-
-    /**
-     * Kind of Link. Note: Secondary light Links are not supported.
-     */
-    kind?: "primary" | "secondary" | void,
-
-    /**
-     * Whether the button is on a dark/colored background.
-     */
-    light?: boolean | void,
-
-    /**
-     * Whether the link should change color once it's visited.
-     * secondary or primary (light) links are not allowed to be visitable.
-     */
-    visitable?: boolean | void,
-
-    /**
-     * Specifies the type of relationship between the current document and the
-     * linked document. Should only be used when `href` is specified. This
-     * defaults to "noopener noreferrer" when `target="_blank"`, but can be
-     * overridden by setting this prop to something else.
-     */
-    rel?: string | void,
-
-    /**
-     * Set the tabindex attribute on the rendered element.
-     */
-    tabIndex?: number | void,
-
-    /**
-     * Test ID used for e2e testing.
-     */
-    testId?: string | void,
-
-    /**
-     * Whether to avoid using client-side navigation.
-     *
-     * If the URL passed to href is local to the client-side, e.g.
-     * /math/algebra/eval-exprs, then it tries to use react-router-dom's Link
-     * component which handles the client-side navigation. You can set
-     * `skipClientNav` to true avoid using client-side nav entirely.
-     *
-     * NOTE: All URLs containing a protocol are considered external, e.g.
-     * https://khanacademy.org/math/algebra/eval-exprs will trigger a full
-     * page reload.
-     */
-    skipClientNav?: boolean | void,
-
-    /**
-     * Custom styles.
-     */
-    style?: StyleType,
-
-    /**
-     * Adds CSS classes to the Link.
-     */
-    className?: string | void,
-
-    /**
-     * Function to call when button is clicked.
-     *
-     * This callback should be used for things like marking BigBingo
-     * conversions. It should NOT be used to redirect to a different URL or to
-     * prevent navigation via e.preventDefault(). The event passed to this
-     * handler will have its preventDefault() and stopPropagation() methods
-     * stubbed out.
-     */
-    onClick?: ((e: SyntheticEvent<>) => mixed) | void,
-
-    /**
-     * Run async code in the background while client-side navigating. If the
-     * browser does a full page load navigation, the callback promise must be
-     * settled before the navigation will occur. Errors are ignored so that
-     * navigation is guaranteed to succeed.
-     */
-    safeWithNav?: (() => Promise<mixed>) | void,
-
-    /**
-     * Respond to raw "keydown" event.
-     */
-    onKeyDown?: ((e: SyntheticKeyboardEvent<>) => mixed) | void,
-
-    /**
-     * Respond to raw "keyup" event.
-     */
-    onKeyUp?: ((e: SyntheticKeyboardEvent<>) => mixed) | void,
-
-    /**
-     * A target destination window for a link to open in.  We only support
-     * "_blank" which opens the URL in a new tab.
-     *
-     * TODO(WB-1262): only allow this prop when `href` is also set.t
-     */
-    target?: "_blank" | void,
-
-    /**
-     * Run async code before navigating to the URL passed to `href`. If the
-     * promise returned rejects then navigation will not occur.
-     *
-     * If both safeWithNav and beforeNav are provided, beforeNav will be run
-     * first and safeWithNav will only be run if beforeNav does not reject.
-     *
-     * WARNING: Using this with `target="_blank"` will trigger built-in popup
-     * blockers in Firefox and Safari.  This is because we do navigation
-     * programmatically and `beforeNav` causes a delay which means that the
-     * browser can't make a directly link between a user action and the
-     * navigation.
-     */
-    beforeNav?: (() => Promise<mixed>) | void,
-
-    /**
-     * An optional title attribute.
-     */
-    title?: string | void,
-
-    /**
-     * An optional icon displayed before the link label.
-     */
-    startIcon?: React.Element<
-      React.ForwardRefExoticComponent<{|
-        ...$ReadOnly<$Flowgen$Import$_2e__2e__2f__2e__2e__2f__2e__2e__2f_wonder_2d_blocks_2d_core_2f_src_2f_util_2f_aria_2d_types.AriaAttributes>,
-        ...$ReadOnly<{|
-          role?: $Flowgen$Import$_2e__2e__2f__2e__2e__2f__2e__2e__2f_wonder_2d_blocks_2d_core_2f_src_2f_util_2f_aria_2d_types.AriaRole | void,
-        |}>,
-        ...{|
-          color?: string | void,
-          icon: $Flowgen$Import$_40_khanacademy_2f_wonder_2d_blocks_2d_icon.IconAsset,
-          size?: $Keys<$Flowgen$Import$_40_khanacademy_2f_wonder_2d_blocks_2d_icon.IconAsset> | void,
-          style?: StyleType,
-          className?: string | void,
-          testId?: string | void,
-        |},
-        ...React.RefAttributes<SVGSVGElement>,
-      |}>,
-      string | React.JSXElementConstructor<any>
-    > | void,
-
-    /**
-     * An optional icon displayed after the link label.
-     * If `target="_blank"` and `endIcon` is passed in, `endIcon` will override
-     * the default `externalIcon`.
-     */
-    endIcon?: React.Element<
-      React.ForwardRefExoticComponent<{|
-        ...$ReadOnly<$Flowgen$Import$_2e__2e__2f__2e__2e__2f__2e__2e__2f_wonder_2d_blocks_2d_core_2f_src_2f_util_2f_aria_2d_types.AriaAttributes>,
-        ...$ReadOnly<{|
-          role?: $Flowgen$Import$_2e__2e__2f__2e__2e__2f__2e__2e__2f_wonder_2d_blocks_2d_core_2f_src_2f_util_2f_aria_2d_types.AriaRole | void,
-        |}>,
-        ...{|
-          color?: string | void,
-          icon: $Flowgen$Import$_40_khanacademy_2f_wonder_2d_blocks_2d_icon.IconAsset,
-          size?: $Keys<$Flowgen$Import$_40_khanacademy_2f_wonder_2d_blocks_2d_icon.IconAsset> | void,
-          style?: StyleType,
-          className?: string | void,
-          testId?: string | void,
-        |},
-        ...React.RefAttributes<SVGSVGElement>,
-      |}>,
-      string | React.JSXElementConstructor<any>
-    > | void,
-  |},
-  ...React.RefAttributes<HTMLAnchorElement | typeof ReactRouterLink>,
-|}>;
-declare export default typeof Link;

package/dist/index.js.flow

@@ -1,8 +0,0 @@
-/**
- * Flowtype definitions for data
- * Generated by Flowgen from a Typescript Definition
- * Flowgen v1.21.0
- * @flow
- */
-import Link from "./components/link";
-declare export { Link as default };