@khanacademy/wonder-blocks-timing 2.0.3 → 2.1.1

package/src/__tests__/generated-snapshot.test.js

@@ -1,156 +0,0 @@
-// This file is auto-generated by gen-snapshot-tests.js
-// Do not edit this file.  To make changes to these snapshot tests:
-//   1. edit the markdown documentation files in the package,
-//        packages/wonder-blocks-timing
-//   2. Run `yarn run gen-snapshot-tests`.
-import React from "react";
-import renderer from "react-test-renderer";
-
-// Mock react-dom as jest doesn't like findDOMNode.
-jest.mock("react-dom");
-import Button from "@khanacademy/wonder-blocks-button";
-import {IDProvider, View} from "@khanacademy/wonder-blocks-core";
-import {withActionScheduler} from "@khanacademy/wonder-blocks-timing";
-
-describe("wonder-blocks-timing", () => {
-    it("example 1", () => {
-        class Unmounter extends React.Component {
-            constructor() {
-                super();
-                this.state = {
-                    mountKids: true,
-                };
-            }
-
-            maybeRenderKids() {
-                if (this.state.mountKids) {
-                    return (
-                        <React.Fragment>
-                            <Button onClick={() => this.onClick()}>
-                                Unmount
-                            </Button>
-                            {this.props.children}
-                        </React.Fragment>
-                    );
-                } else {
-                    return "Children unmounted";
-                }
-            }
-
-            onClick() {
-                this.setState({
-                    mountKids: false,
-                });
-            }
-
-            render() {
-                return <View>{this.maybeRenderKids()}</View>;
-            }
-        }
-
-        class MyNaughtyComponent extends React.Component {
-            componentDidMount() {
-                const {targetId} = this.props;
-                let counter = 0;
-                const domElement = document.getElementById(targetId);
-                setInterval(() => {
-                    domElement.innerText =
-                        "Naughty interval logged: " + counter++;
-                }, 200);
-            }
-
-            render() {
-                return <View>NaughtyComponent here</View>;
-            }
-        }
-
-        const example = (
-            <IDProvider>
-                {(id) => (
-                    <View>
-                        <Unmounter>
-                            <MyNaughtyComponent targetId={id} />
-                        </Unmounter>
-                        <View>
-                            <View id={id}></View>
-                        </View>
-                    </View>
-                )}
-            </IDProvider>
-        );
-        const tree = renderer.create(example).toJSON();
-        expect(tree).toMatchSnapshot();
-    });
-
-    it("example 2", () => {
-        class Unmounter extends React.Component {
-            constructor() {
-                super();
-                this.state = {
-                    mountKids: true,
-                };
-            }
-
-            maybeRenderKids() {
-                if (this.state.mountKids) {
-                    return (
-                        <React.Fragment>
-                            <Button onClick={() => this.onClick()}>
-                                Unmount
-                            </Button>
-                            {this.props.children}
-                        </React.Fragment>
-                    );
-                } else {
-                    return "Children unmounted";
-                }
-            }
-
-            onClick() {
-                this.setState({
-                    mountKids: false,
-                });
-            }
-
-            render() {
-                return <View>{this.maybeRenderKids()}</View>;
-            }
-        }
-
-        class MyGoodComponent extends React.Component {
-            componentDidMount() {
-                const {targetId, schedule} = this.props;
-                let counter = 0;
-                const domElement = document.getElementById(targetId);
-                schedule.interval(() => {
-                    domElement.innerText =
-                        "Naughty interval logged: " + counter++;
-                }, 200);
-            }
-
-            render() {
-                return <View>GoodComponent here</View>;
-            }
-        }
-
-        const MyGoodComponentWithScheduler = withActionScheduler(
-            MyGoodComponent,
-        );
-        const example = (
-            <IDProvider>
-                {(id) => (
-                    <View>
-                        <Unmounter>
-                            <MyGoodComponentWithScheduler targetId={id} />
-                        </Unmounter>
-                        <View>
-                            <View id={id}></View>
-                        </View>
-                    </View>
-                )}
-            </IDProvider>
-        );
-        const tree = renderer.create(example).toJSON();
-        expect(tree).toMatchSnapshot();
-    });
-});

package/src/components/with-action-scheduler.md

@@ -1,18 +0,0 @@
-This is a higher order component (HOC) that attaches the given component to an
-[`IScheduleActions`](#ischeduleactions) instance. Any actions scheduled will automatically be
-cleared on unmount. This allows for "set it and forget it" behavior that won't
-leave timers dangling when the component's lifecycle ends.
-
-For more details on using this component and the [`IScheduleActions`](#ischeduleactions) interface,
-see the [API overview](#timing-api-overview).
-
-### Flow Types
-If you are using Flow typing, you can use the `WithActionSchedulerProps` type
-to build the props for the component that you will pass to the `withActionScheduler`
-function by spreading the type into your component's `Props` type.
-
-The added `schedule` prop is of type [`IScheduleActions`](#ischeduleactions). This is what the
-`withActionScheduler` function injects to your component.
-
-The returned value from `withActionScheduler` is a React component with props of
-type `TProps`.