@viveksinghind/narrative-form-react 1.0.0 → 1.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/README.md +37 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# @viveksinghind/narrative-form-react
|
|
2
|
+
|
|
3
|
+
React components for Narrative Form — a beautiful, typewriter-style signup flow.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @viveksinghind/narrative-form-react @viveksinghind/narrative-form-core
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Features
|
|
12
|
+
|
|
13
|
+
- 💅 Beautiful, animated typewriter UI out of the box
|
|
14
|
+
- ⚡️ Built on top of a robust core state machine
|
|
15
|
+
- 🎨 Fully customizable and themeable
|
|
16
|
+
- 📱 Responsive and accessible
|
|
17
|
+
|
|
18
|
+
## Basic Usage
|
|
19
|
+
|
|
20
|
+
```tsx
|
|
21
|
+
import { NarrativeForm } from '@viveksinghind/narrative-form-react';
|
|
22
|
+
import '@viveksinghind/narrative-form-react/dist/index.css';
|
|
23
|
+
|
|
24
|
+
const formConfig = {
|
|
25
|
+
// your form configuration
|
|
26
|
+
};
|
|
27
|
+
|
|
28
|
+
function App() {
|
|
29
|
+
return (
|
|
30
|
+
<NarrativeForm config={formConfig} onComplete={(data) => console.log(data)} />
|
|
31
|
+
);
|
|
32
|
+
}
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## License
|
|
36
|
+
|
|
37
|
+
MIT
|
package/package.json
CHANGED