stepsnap 0.1.2 → 0.1.3
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.
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { WalkthroughData, UploadFn } from '../types';
|
|
2
|
+
interface Props {
|
|
3
|
+
data: WalkthroughData;
|
|
4
|
+
onChange: (data: WalkthroughData) => void;
|
|
5
|
+
onUpload: UploadFn;
|
|
6
|
+
accentColor?: string;
|
|
7
|
+
}
|
|
8
|
+
export declare function WalkthroughBuilder({ data, onChange, onUpload, accentColor }: Props): import("react/jsx-runtime").JSX.Element;
|
|
9
|
+
export {};
|
package/dist/index.d.ts
CHANGED
package/dist/types.d.ts
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
export type AnnotationType = 'circle' | 'arrow';
|
|
2
|
+
export interface Annotation {
|
|
3
|
+
type: AnnotationType;
|
|
4
|
+
x: number;
|
|
5
|
+
y: number;
|
|
6
|
+
color: string;
|
|
7
|
+
animated: boolean;
|
|
8
|
+
size: number;
|
|
9
|
+
zoom: boolean;
|
|
10
|
+
}
|
|
11
|
+
export interface Step {
|
|
12
|
+
id: string;
|
|
13
|
+
imageUrl: string;
|
|
14
|
+
caption?: string;
|
|
15
|
+
annotation?: Annotation;
|
|
16
|
+
}
|
|
17
|
+
export interface WalkthroughData {
|
|
18
|
+
title: string;
|
|
19
|
+
steps: Step[];
|
|
20
|
+
}
|
|
21
|
+
export interface UploadFn {
|
|
22
|
+
(file: File): Promise<string>;
|
|
23
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "stepsnap",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.3",
|
|
4
4
|
"description": "Annotated screenshot walkthrough builder & viewer — open-source alternative to Scribe",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/stepsnap.umd.cjs",
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
],
|
|
19
19
|
"scripts": {
|
|
20
20
|
"dev": "vite",
|
|
21
|
-
"build": "
|
|
21
|
+
"build": "vite build && tsc -p tsconfig.lib.json",
|
|
22
22
|
"build:embed": "cross-env BUILD_MODE=embed vite build",
|
|
23
23
|
"lint": "eslint .",
|
|
24
24
|
"preview": "vite preview"
|