@khanacademy/wonder-blocks-testing-core 3.0.0 → 3.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/dist/fixtures/fixtures.d.ts +3 -0
- package/dist/fixtures/types.d.ts +12 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -9,5 +9,8 @@ import type { FixtureFn } from "./types";
|
|
|
9
9
|
* @param {React.ComponentType<any>} Component The component we want to create
|
|
10
10
|
* stories for.
|
|
11
11
|
* @returns {FixtureFn<TProps>} A function to create a CSF compatible story.
|
|
12
|
+
*
|
|
13
|
+
* @deprecated Use CSFv3 style stories instead. This API was for migration
|
|
14
|
+
* from our old fixtures framework and will be removed in a future release.
|
|
12
15
|
*/
|
|
13
16
|
export declare const fixtures: <TComponent extends React.ComponentType<any>, TProps extends JSX.LibraryManagedAttributes<TComponent, React.ComponentProps<TComponent>>>(Component: TComponent) => FixtureFn<TProps>;
|
package/dist/fixtures/types.d.ts
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import * as React from "react";
|
|
2
2
|
/**
|
|
3
3
|
* Options injected to the function that returns the fixture props.
|
|
4
|
+
* @deprecated Use CSFv3 style stories instead. This API was for migration
|
|
5
|
+
* from our old fixtures framework and will be removed in a future release.
|
|
4
6
|
*/
|
|
5
7
|
export type GetPropsOptions = {
|
|
6
8
|
/**
|
|
@@ -14,9 +16,19 @@ export type GetPropsOptions = {
|
|
|
14
16
|
*/
|
|
15
17
|
logHandler: (name: string) => (...args: Array<any>) => void;
|
|
16
18
|
};
|
|
19
|
+
/**
|
|
20
|
+
* The props for a fixture.
|
|
21
|
+
*
|
|
22
|
+
* This can be either a static object or a function that returns an object.
|
|
23
|
+
*
|
|
24
|
+
* @deprecated Use CSFv3 style stories instead. This API was for migration
|
|
25
|
+
* from our old fixtures framework and will be removed in a future release.
|
|
26
|
+
*/
|
|
17
27
|
export type FixtureProps<TProps extends object> = Readonly<TProps> | ((options: Readonly<GetPropsOptions>) => Readonly<TProps>);
|
|
18
28
|
/**
|
|
19
29
|
* A function for defining a fixture.
|
|
30
|
+
* @deprecated Use CSFv3 style stories instead. This API was for migration
|
|
31
|
+
* from our old fixtures framework and will be removed in a future release.
|
|
20
32
|
*/
|
|
21
33
|
export type FixtureFn<TProps extends object> = (
|
|
22
34
|
/**
|