# user-tutorial

> React package about user dashboard

Latest version **1.0.4** (published 2022-01-01) · ISC license · 0 weekly downloads

## Install

```sh
npm install user-tutorial
pnpm add user-tutorial
yarn add user-tutorial
bun add user-tutorial
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2022-01-01 |
| First published | 2021-09-06 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 135.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | khacywin |
| Maintainers | khacy |
| Keywords | first time, react, user dashboard, tutorial user |

## Links

- npm: https://www.npmjs.com/package/user-tutorial
- Repository: https://github.com/khacywin/w-guide
- Homepage: https://github.com/khacywin/w-guide#readme
- Issues: https://github.com/khacywin/w-guide/issues
- npm.io page: https://npm.io/package/user-tutorial

## Dependencies (1)

- [postcss](https://npm.io/package/postcss.md) ^8.3.6

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.4 (latest) — 2022-01-01
- 1.0.3 — 2022-01-01
- 1.0.2 — 2022-01-01
- 1.0.1 — 2021-11-28
- 1.0.0 — 2021-09-06

## README

# Guide user

Guide for first user

### Install
```
  npm install guide-user
```

### Usage 
```
  import Guide, { GuideProvider } from 'guide-user';

  ....
  <GuideProvider>
    ...
    <Guide
      step={1}
      text="This is text to guide"
    >
    ...
  </GuideProvider>
```

### Section

#### GuideProvider
Have one properties is <b>value</b>
Properties of it 
```
  mode?: "tour" | "action-driven";
  nextStep?: function;
  previousStep?: function;
  run?: boolean;
  setRun?: boolean;
  setStep?: function;
  setTotal?: function;
  step: number;
  total?: number;
```
and default value is 
```
  mode: "action-driven"
```
#### Guide
Have 2 mode is <b>tour</b> or <b>action-driven</b>, so have 2 props for components.
With <b>tour</b>:
```
  children: JSX.Element;
  position?: [("left" | "right" | "top" | "bottom")];
  step: number;
  title?: string;
  message?: string;
```

With <b>action-driven</b>
```
  children: JSX.Element;
  position?: ("left" | "right" | "top" | "bottom")[];
  step: number;
  text?: string;
  type?: "button" | "input";
```

### GuideContext
Use with <b>useConext</b> hook
```
  ...
  const { 
    nextStep,
    previousStep,
    run, 
    setRun,
    setStep, 
    setTotal
    step, 
    total,
  } = useContext(
    GuideContext
  );
  ...
```

---
_Source: https://npm.io/package/user-tutorial · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._