@khanacademy/wonder-blocks-clickable 3.1.2 → 4.0.0

package/dist/components/clickable.js.flow

@@ -1,166 +0,0 @@
-/**
- * Flowtype definitions for data
- * Generated by Flowgen from a Typescript Definition
- * Flowgen v1.21.0
- * @flow
- */
-import * as React from "react";
-import { Link } from "react-router-dom";
-import type { AriaProps, StyleType } from "@khanacademy/wonder-blocks-core";
-import type { ClickableRole, ClickableState } from "./clickable-behavior";
-
-/**
- * A component to turn any custom component into a clickable one.
- *
- * Works by wrapping `ClickableBehavior` around the child element and styling
- * the child appropriately and encapsulates routing logic which can be
- * customized. Expects a function which returns an element as its child.
- *
- * Clickable allows your components to:
- *
- * - Handle mouse / touch / keyboard events
- * - Match the standard behavior of the given role
- * - Apply custom styles based on pressed / focused / hovered state
- * - Perform Client Side Navigation when href is passed and the component is a
- *   descendent of a react-router Router.
- *
- * ### Usage
- *
- * ```jsx
- * <Clickable onClick={() => alert("You clicked me!")}>
- *     {({hovered, focused, pressed}) =>
- *         <div
- *             style={[
- *                 hovered && styles.hovered,
- *                 focused && styles.focused,
- *                 pressed && styles.pressed,
- *             ]}
- *         >
- *             Click Me!
- *         </div>
- *     }
- * </Clickable>
- * ```
- */
-declare var Clickable: React.ForwardRefExoticComponent<{|
-  ...$Rest<$Diff<AriaProps, { "aria-disabled": any }>, {}>,
-  ...{|
-    /**
-     * The child of Clickable must be a function which returns the component
-     * which should be made Clickable.  The function is passed an object with
-     * three boolean properties: hovered, focused, and pressed.
-     */
-    children: (arg1: ClickableState) => React.Node,
-
-    /**
-     * An onClick function which Clickable can execute when clicked
-     */
-    onClick?: ((e: SyntheticEvent<>) => mixed) | void,
-
-    /**
-     * Optional href which Clickable should direct to, uses client-side routing
-     * by default if react-router is present
-     */
-    href?: string | void,
-
-    /**
-     * Styles to apply to the Clickable component
-     */
-    style?: StyleType,
-
-    /**
-     * Adds CSS classes to the Clickable.
-     */
-    className?: string | void,
-
-    /**
-     * Whether the Clickable is on a dark colored background.
-     * Sets the default focus ring color to white, instead of blue.
-     * Defaults to false.
-     */
-    light?: boolean | void,
-
-    /**
-     * Disables or enables the child; defaults to false
-     */
-    disabled?: boolean | void,
-
-    /**
-     * An optional id attribute.
-     */
-    id?: string | 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,
-
-    /**
-     * The role of the component, can be a role of type ClickableRole
-     */
-    role?: ClickableRole | void,
-
-    /**
-     * Avoids client-side routing in the presence of the href prop
-     */
-    skipClientNav?: boolean | void,
-
-    /**
-     * Test ID used for e2e testing.
-     */
-    testId?: string | void,
-
-    /**
-     * Respond to raw "keydown" event.
-     */
-    onKeyDown?: ((e: SyntheticKeyboardEvent<>) => mixed) | void,
-
-    /**
-     * Respond to raw "keyup" event.
-     */
-    onKeyUp?: ((e: SyntheticKeyboardEvent<>) => mixed) | void,
-
-    /**
-     * Don't show the default focus ring.  This should be used when implementing
-     * a custom focus ring within your own component that uses Clickable.
-     */
-    hideDefaultFocusRing?: boolean | void,
-
-    /**
-     * A target destination window for a link to open in.
-     *
-     * TODO(WB-1262): only allow this prop when `href` is also set.t
-     */
-    target?: "_blank" | void,
-
-    /**
-     * Set the tabindex attribute on the rendered element.
-     */
-    tabIndex?: number | void,
-
-    /**
-     * Run async code before navigating. 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: This prop must be used with `href` and should not be used with
-     * `target="blank"`.
-     */
-    beforeNav?: (() => Promise<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,
-  |},
-  ...React.RefAttributes<HTMLAnchorElement | HTMLButtonElement | typeof Link>,
-|}>;
-declare export default typeof Clickable;

package/dist/index.js.flow

@@ -1,17 +0,0 @@
-/**
- * Flowtype definitions for data
- * Generated by Flowgen from a Typescript Definition
- * Flowgen v1.21.0
- * @flow
- */
-import type {
-  ChildrenProps,
-  ClickableState,
-  ClickableRole,
-} from "./components/clickable-behavior";
-import Clickable from "./components/clickable";
-declare export { default as ClickableBehavior } from "./components/clickable-behavior";
-declare export { default as getClickableBehavior } from "./util/get-clickable-behavior";
-declare export { isClientSideUrl } from "./util/is-client-side-url";
-declare export { Clickable as default };
-export type { ChildrenProps, ClickableState, ClickableRole };

package/dist/util/get-clickable-behavior.js.flow

@@ -1,15 +0,0 @@
-/**
- * Flowtype definitions for data
- * Generated by Flowgen from a Typescript Definition
- * Flowgen v1.21.0
- * @flow
- */
-import * as React from "react";
-import ClickableBehavior from "../components/clickable-behavior";
-declare export default function getClickableBehavior(
-  href?: string,
-  skipClientNav?: boolean,
-  router?: any
-): React.ComponentType<
-  React.ElementConfig<typeof ClickableBehavior>
->;

package/dist/util/is-client-side-url.js.flow

@@ -1,13 +0,0 @@
-/**
- * Flowtype definitions for data
- * Generated by Flowgen from a Typescript Definition
- * Flowgen v1.21.0
- * @flow
- */
-/**
- * Returns:
- * - false for hrefs staring with http://, https://, //.
- * - false for '#', 'javascript:...', 'mailto:...', 'tel:...', etc.
- * - true for all other values, e.g. /foo/bar
- */
-declare export var isClientSideUrl: (href: string) => boolean;